ChartScatterSeriesBuilder

Properties

Series - IChartScatterSeries

Methods

ErrorBars(System.Action)

Configures the scatter series error bars.

Parameters

configurator - System.Action<ScatterErrorBarsBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Scatter(s => s.x, s => s.y)
                           .ErrorBars(e => e.XValue(1))
                        )
            )

Labels(System.Action)

Configures the scatter chart labels.

Parameters

configurator - System.Action<ChartPointLabelsBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Scatter(s => s.x, s => s.y)
                           .Labels(labels => labels
                               .Position(ChartBarLabelsPosition.Above)
                               .Visible(true)
                           )
                        )
            )

Labels(System.Boolean)

Sets the visibility of scatter chart labels.

Parameters

visible - System.Boolean

The visibility. The default value is false.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Scatter(s => s.x, s => s.y)
                           .Labels(true)
                        )
            )

Markers(System.Action)

Configures the scatter chart markers.

Parameters

configurator - System.Action<ChartMarkersBuilder>

The configuration action.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Scatter(s => s.x, s => s.y)
                           .Markers(markers => markers
                               .Type(ChartMarkerShape.Triangle)
                           )
                        )
            )

Markers(System.Boolean)

Sets the visibility of scatter chart markers.

Parameters

visible - System.Boolean

The visibility. The default value is true.

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series
                           .Scatter(s => s.x, s => s.y)
                           .Markers(true)
                        )
            )

XAxis(System.String)

Sets the axis name to use for this series.

Parameters

axis - System.String

The axis name for this series.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Scatter(s => s.X, s => s.Y).Name("Scatter").XAxis("secondary"))
                       .XAxis(axis => axis.Numeric())
                       .XAxis(axis => axis.Numeric("secondary"))
            )

YAxis(System.String)

Sets the axis name to use for this series.

Parameters

axis - System.String

The axis name for this series.

Example

            @(Html.Kendo().Chart(Model)
                       .Name("Chart")
                       .Series(series => series.Scatter(s => s.Sales).Name("Sales").YAxis("secondary"))
                       .YAxis(axis => axis.Numeric())
                       .YAxis(axis => axis.Numeric("secondary"))
            )

Axis(System.String)

Not applicable to scatter series

Parameters

axis - System.String

CategoryAxis(System.String)

Not applicable to scatter series

Parameters

categoryAxis - System.String

XField(System.String)

Sets the X field for the series

Parameters

xField - System.String

The value X field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Scatter(Model.Records).XField("X").YField("Y"))
            )

YField(System.String)

Sets the Y field for the series

Parameters

yField - System.String

The value Y field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Scatter(Model.Records).XField("X").YField("Y"))
            )

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.Bar(Model.Records).Field("Value").NoteTextField("NoteText"))
            )

Fields(System.String,System.String)

Sets the X and Y fields for the series

Parameters

xField - System.String

The X field for the series

yField - System.String

The Y field for the series

Example

            @(Html.Kendo().Chart()
                       .Name("Chart")
                       .Series(series => series.Scatter(Model.Records).Fields("X", "Y"))
            )

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))
            )

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.