ChartCandlestickSeriesBuilder

Properties

Series - IChartCandlestickSeries

Gets the model down color member name.

Series - IChartOHLCSeries

Aggregates function for date series.

Methods

Overlay(Kendo.Mvc.UI.ChartBarSeriesOverlay)

Sets the bar effects overlay

Parameters

overlay - ChartBarSeriesOverlay

The candlestick effects overlay. The default is ChartBarSeriesOverlay.Glass

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Candlestick(s => s.Sales).Overlay(ChartBarSeriesOverlay.None))
            )

Highlight(System.Action)

Configures the series highlight

Parameters

configurator - System.Action<ChartCandlestickSeriesHighlightBuilder>

The configuration action.

Example

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

Aggregate(System.Nullable,System.Nullable,System.Nullable,System.Nullable)

Sets the aggregate function for date series. This function is used when a category (an year, month, etc.) contains two or more points.

Parameters

open - System.Nullable<ChartSeriesAggregate>

Open aggregate name.

high - System.Nullable<ChartSeriesAggregate>

High aggregate name.

low - System.Nullable<ChartSeriesAggregate>

Low aggregate name.

close - System.Nullable<ChartSeriesAggregate>

Close aggregate name.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => series.OHLC(s => s.Sales).Aggregate(ChartSeriesAggregate.Avg))
            )

Gap(System.Double)

Set distance between category clusters. A value of 1 means that there is a total of 1 point width between categories. The distance is distributed evenly on each side. The default value is 1

Parameters

gap - System.Double

Example

            @(Html.Kendo().Chart(Model)
                .Name("Chart")
                .Series(series => series.OHLC(s => s.Sales).Gap(1.5))
            )

Spacing(System.Double)

Sets a value indicating the distance between points in the same category.

Parameters

spacing - System.Double

Value of 1 means that the distance between points in the same category. The default value is 0.3

Example

            @(Html.Kendo().Chart(Model)
                .Name("Chart")
                .Series(series => series.Spacing(s => s.Sales).Spacing(1))
            )

Border(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType)

Sets the points border

Parameters

width - System.Int32

The points border width.

color - System.String

The points border color (CSS syntax).

dashType - ChartDashType

The points border dash type.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(s => s.Sales).Border("1", "#000", ChartDashType.Dot))
            )

Line(System.Int32,System.String,Kendo.Mvc.UI.ChartDashType)

Configures the ohlc chart lines.

Parameters

width - System.Int32

The lines width.

color - System.String

The lines color.

dashType - ChartDashType

The lines dashType.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series
                          .OHLC(s => s.Sales)        
                          .Line(2, "red", ChartDashType.Dot)
                      )
            )

Line(System.Int32)

Configures the ohlc line width.

Parameters

width - System.Int32

The lines width.

Example

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

Line(System.Int32,System.String)

Configures the ohlc lines.

Parameters

width - System.Int32

The lines width.

color - System.String

The lines color.

Example

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

Line(System.Action)

Configures the ohlc chart lines.

Parameters

configurator - System.Action<ChartLineBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series
                          .Area(s => s.Sales)        
                          .Line(line => line.Opacity(0.2))
                      )
            )

Highlight(System.Action)

Configures the series highlight

Parameters

configurator - System.Action<ChartOHLCSeriesHighlightBuilder>

The configuration action.

Example

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

OpenField(System.String)

Sets the open field for the series

Parameters

openField - System.String

The open field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
            )

CloseField(System.String)

Sets the close field for the series

Parameters

closeField - System.String

The close field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
            )

HighField(System.String)

Sets the high field for the series

Parameters

highField - System.String

The high field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
            )

LowField(System.String)

Sets the low field for the series

Parameters

lowField - System.String

The low field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close"))
            )

Fields(System.String,System.String,System.String,System.String)

Sets the value fields for the series

Parameters

openField - System.String

The open field for the series

highField - System.String

The value fields for the series

lowField - System.String

The low field for the series

closeField - System.String

The close field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).Fields("Open", "High", "Low", "Close"))
            )

ColorField(System.String)

Sets the color field for the series

Parameters

colorField - System.String

The color field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close").ColorField("Color"))
            )

NoteTextField(System.String)

Sets the note text field for the series

Parameters

noteTextField - System.String

The note text field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.OHLC(Model.Records).OpenField("Open").HighField("High").LowField("Low").CloseField("Close").NoteTextField("NoteText"))
            )

Name(System.String)

Sets the series title displayed in the legend.

Parameters

text - System.String

The value that sets the title.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Name("Sales"))
            )

Opacity(System.Double)

Sets the series opacity.

Parameters

opacity - System.Double

The value that sets the series opacity in the range from 0 (transparent) to 1 (opaque). The default value is 1.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Opacity(0.5))
            )

Color(System.String)

Sets the bar fill color

Parameters

color - System.String

The value that configures the bar fill color (CSS syntax).

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Color("#aa00bb"))
            )

Color(System.Func)

Sets the function used to retrieve point color.

Parameters

colorFunction - System.Func<Object,Object>

The JavaScript function that will be executed to retrieve the color of each point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .Color(
                               @<text>
                               function(point) {
                                   return point.value > 5 ? "red" : "green";
                               }
                               </text>
                           )
                        )
            )

ColorHandler(System.Func)

Sets the function used to retrieve point color.

Parameters

colorFunction - System.Func<Object,Object>

The JavaScript function that will be executed to retrieve the color of each point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .ColorHandler(
                               @<text>
                               function(point) {
                                   return point.value > 5 ? "red" : "green";
                               }
                               </text>
                           )
                        )
            )

ColorHandler(System.String)

Sets the function used to retrieve point color.

Parameters

colorFunction - System.String

The JavaScript function that will be executed to retrieve the color of each point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .ColorHandler("pointColor")
                        )
            )

Tooltip(System.Action)

Configure the data point tooltip for the series.

Parameters

configurator - System.Action<ChartTooltipBuilder>

Use the configurator to set tooltip options.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales)
                           .Tooltip(tooltip =>
                           {
                               tooltip.Visible(true).Format("{0:C}");
                           })
                       )
            )

Tooltip(System.Boolean)

Sets the data point tooltip visibility.

Parameters

visible - System.Boolean

A value indicating if the data point tooltip should be displayed. The tooltip is not visible by default.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Tooltip(true))
            )

Axis(System.String)

Sets the axis name to use for this series.

Parameters

axis - System.String

The value that sets the axis name for this series.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Name("Sales").Axis("secondary"))
                       .ValueAxis(axis => axis.Numeric())
                       .ValueAxis(axis => axis.Numeric("secondary"))
                       .CategoryAxis(axis => axis.AxisCrossingValue(0, 10))
            )

CategoryAxis(System.String)

Sets the axis name to use for this series.

Parameters

categoryAxis - System.String

The value that sets the category axis name for this series.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Bar(s => s.Sales).Name("Sales").CategoryAxis("catAxis"))
                       .CategoryAxis(axis => axis.Name("catAxis"))
            )

Highlight(System.Action)

Configures the series highlight

Parameters

configurator - System.Action<ChartSeriesHighlightBuilder>

Use the configurator to set highlight options.

Example

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

Highlight(System.Boolean)

Configures the highlight visibility

Parameters

visible - System.Boolean

The value that sets the highlight visibility.

Example

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

Visible(System.Boolean)

Sets the labels visibility

Parameters

visible - System.Boolean

The value that sets the labels visibility.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Bar(s => s.Sales).Visible(false))
            )

VisibleInLegend(System.Boolean)

Sets the labels visibility in the legend

Parameters

visible - System.Boolean

The value that configures the series visibility in the legend.

Example

            @(Html.Kendo().Chart()
                      .Name("Chart")
                      .Series(series => series.Bar(s => s.Sales).VisibleInLegend(false))
            )

Notes(System.Action)

Configures the series notes

Parameters

configurator - System.Action<ChartNoteBuilder>

Use the configurator to set notes options.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series
                            .Bar(s => s.Sales).Notes(notes => notes.Position(ChartNotePosition.Right))
                       )
            )

Aggregate(System.Func)

Sets the function used to retrieve point color.

Parameters

aggregateFunction - System.Func<Object,Object>

The JavaScript function that will be executed to retrieve the value of each aggregated point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .Aggregate(
                               @<text>
                               function(values) {
                                   return values[0];
                               }
                               </text>
                           )
                        )
            )

Aggregate(System.String)

Sets the function used to retrieve point color.

Parameters

aggregateFunction - System.String

The JavaScript function that will be executed to retrieve the value of each aggregated point.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Bar(s => s.Sales)
                           .Aggregate("myAggregate")
                        )
            )
            <script>
            function myAggregate(values) {
                return values[0];
            }
            </script>

ZIndex(System.Double)

Sets the series stacking order relative to other series.

Parameters

zIndex - System.Double

The stacking order of series, relative to other series. The series with the highest Z-index will be placed on top. Series with no Z-index will use the default stacking order based on series type. For example line series will be on top with bar and area following below.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => {
                            series.Area(s => s.Sales).ZIndex(2);
                            series.Column(s => s.Price).ZIndex(1);
                       })
            )

Median(System.Action)

The configuration of the Box Plot median value indicator (line).

Parameters

configurator - System.Action<ChartSeriesMedianBuilder>

Use the configurator to set median options.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => {
                            series.Area(s => s.Sales).Median(m => {
                                m.Color("red");
                            });
                            series.Column(s => s.Price).Median(m => {
                                m.Color("red");
                            });
                        })
            )

Mean(System.Action)

The configuration of the Box Plot mean value indicator (line).

Parameters

configurator - System.Action<ChartSeriesMeanBuilder>

Use the configurator to set mean options.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => {
                            series.Area(s => s.Sales).Mean(m => {
                                m.Color("red");
                            });
                            series.Column(s => s.Price).Mean(m => {
                                m.Color("red");
                            });
                        })
            )

DrilldownField(System.String)

The data field which contains the value to use to drill down into detailed data for the point.

Parameters

value - System.String

The value that sets the DrilldownField

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => {
                            series.Area(s => s.Sales).DrilldownField("details");
                        })

DrilldownSeriesFactory(System.String)

A function that creates the drilldown series for a given point.The function should accept a single parameter, the point drilldownField value. The function should return a series configuration object or a Promise that resolves to one.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => {
                            series.Area(s => s.Sales).DrilldownSeriesFactory("drilldownByModel");
                        })

DrilldownSeriesFactory(System.Func)

A function that creates the drilldown series for a given point.The function should accept a single parameter, the point drilldownField value. The function should return a series configuration object or a Promise that resolves to one.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => {
                            series
                                .Area(s => s.Sales)
                                .DrilldownSeriesFactory(
                                    @<text>
                                        function (e) {
                                            //event handler code
                                        }
                                    </text>
                                );
                        })

LegendItem(System.Action)

The chart series legend configuration options.

Parameters

configurator - System.Action<ChartSeriesLegendItemSettingsBuilder>

Use the configurator to set series legend options.

Example

            @(Html.Kendo().Chart(Model)
                        .Name("Chart")
                        .Series(series => {
                            series
                                .Area(s => s.Sales)
                                .LegendItem(l => l.Type("area"))
                        })

Pattern(System.Action)

The chart series pattern configuration options.

Parameters

configurator - System.Action<ChartSeriesPatternSettingsBuilder>

The configurator for the Pattern setting.