ChartCandlestickSeriesHighlightBuilder

Defines the fluent interface for configuring candlestick series highlight.

Methods

Border(System.Int32)

Sets the bubble highlight border width. The color is computed automatically from the base point color.

Parameters

width - System.Int32

The bubble highlight border width.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Border(2))
                      )
            )

Border(System.Int32,System.String)

Sets the bubble highlight border width.

Parameters

width - System.Int32

The border width.

color - System.String

The border color

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Border(2, 'red'))
                      )
            )

Border(System.Action)

Configures the highlight border

Parameters

configurator - System.Action<ChartBorderBuilder>

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Border(border => border.Width(2).Color("red")))
                      )
            )

Opacity(System.Double)

Sets the bubble highlight opacity.

Parameters

opacity - System.Double

The bubble highlight opacity.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Opacity(0.8))
                      )
            )

Line(System.Int32)

Configures the candlestick highlight line width.

Parameters

width - System.Int32

The lines width.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Line(2))
                      )
            )

Line(System.Int32,System.String)

Configures the candlestick highlight lines.

Parameters

width - System.Int32

The lines width.

color - System.String

The lines color.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Line(2, "orange"))
                      )
            )

Line(System.Action)

Configures the candlestick highlight chart lines.

Parameters

configurator - System.Action<ChartAreaLineBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales)
                        .Highlight(highlight => highlight.Line(line => line.Width(2).Color("red")))
                      )
            )

Visible(System.Boolean)

Sets the highlight visibility

Parameters

visible - System.Boolean

The highlight visibility.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(highlight => highlight.Visible(false))
                      )
            )

Toggle(System.String)

Sets the highlight toggle handler

Parameters

handler - System.String

The JavaScript toggle handler name.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(highlight => highlight.Toggle("toggleHighlight"))
                      )
            )
            <script>
                    function toggleHandler(e) {
                        e.preventDefault();

                        var opacity = e.show ? 0.5 : 1;
                        e.visual.opacity(opacity);
                    }
            </script>

Toggle(System.Func)

Sets the highlight toggle handler

Parameters

handler - System.Func<Object,Object>

The toggle handler

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(highlight => highlight.Toggle(
                                @<text>
                                    function(e) {
                                        e.preventDefault();

                                        var opacity = e.show ? 0.5 : 1;
                                        e.visual.opacity(opacity);
                                    }
                                </text>)
                            )
                      )
            )

Visual(System.String)

Sets the highlight visual handler

Parameters

handler - System.String

The visual handler name.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(highlight => highlight.Toggle("highlightVisual"))
                      )
            )

Visual(System.Func)

Sets the highlight visual handler

Parameters

handler - System.Func<Object,Object>

The visual handler

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Pie(s => s.Sales, s => s.DateString)
                            .Highlight(highlight => highlight.Visual(
                                @<text>
                                    function(e) {
                                        return e.createVisual(); // returns the default visual
                                    }   
                                </text>)
                            )
                      )
            )

InactiveOpacity(System.Double)

The opacity of the series when another series is highlighted.

Parameters

value - System.Double

The value for InactiveOpacity