ChartSeriesLabelsSettingsBuilder

Methods

Align(Kendo.Mvc.UI.ChartFunnelLabelsAlign)

Specifies the alignment of the labels.

Parameters

value - ChartFunnelLabelsAlign

The value for Align

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                      .Name("Chart")
                      .Series(series => series
                          .Funnel(funnel => funnel.Sales)
                          .Labels(labels => labels.Align(ChartFunnelLabelsAlign.Center))
                      )
                )
             

Align(Kendo.Mvc.UI.ChartPieLabelsAlign)

Specifies the alignment of the labels.

Parameters

value - ChartPieLabelsAlign

The value for Align

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                      .Name("Chart")
                      .Series(series => series
                          .Pie(pie => pie.Sales)
                          .Labels(labels => labels.Align(ChartPieLabelsAlign.Center))
                      )
                )
             

Align(Kendo.Mvc.UI.ChartPyramidLabelsAlign)

Specifies the alignment of the labels.

Parameters

value - ChartPyramidLabelsAlign

The value for Align

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                      .Name("Chart")
                      .Series(series => series
                          .Pyramid(pyramid => pyramid.Sales)
                          .Labels(labels => labels.Align(ChartPieLabelsAlign.Center))
                      )
                )
             

Margin(System.Int32)

The margin of the labels.

Parameters

value - System.Int32

The integer value to apply as labels margin.

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Bar(bar => bar.Sales)
                        .Labels(labels => labels
                               .Margin(margin => margin
                                    .Top(10)
                                    .Right(5)
                                    .Left(5)
                                    .Bottom(10)
                                )
                         )
                    )
                )
             

Padding(System.Int32)

The margin of the labels.

Parameters

value - System.Int32

The integer value to apply as padding to the labels.

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Bar(bar => bar.Sales)
                        .Labels(labels => labels
                               .Padding(padding => padding
                                    .Top(10)
                                    .Right(5)
                                    .Left(5)
                                    .Bottom(10)
                                )
                         )
                    )
                )
             

Position(Kendo.Mvc.UI.ChartBarLabelsPosition)

Specifies the position of the labels.

Parameters

value - ChartBarLabelsPosition

The value for Position

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Bar(bar => bar.Sales)
                        .Labels(labels => labels
                               .Position(ChartBarLabelsPosition.InsideBase)
                        )
                    )
                )
             

Position(Kendo.Mvc.UI.ChartFunnelLabelsPosition)

Specifies the position of the labels.

Parameters

value - ChartFunnelLabelsPosition

The value for Position

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Funnel(funnel => funnel.Sales)
                        .Labels(labels => labels
                               .Position(ChartFunnelLabelsPosition.Center)
                        )
                    )
                )
             

Position(Kendo.Mvc.UI.ChartPyramidLabelsPosition)

Specifies the position of the labels.

Parameters

value - ChartPyramidLabelsPosition

The value for Position

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Pyramid(pyramid => pyramid.Sales)
                        .Labels(labels => labels
                               .Position(ChartPyramidLabelsPosition.Center)
                        )
                    )
                )
             

Position(Kendo.Mvc.UI.ChartPieLabelsPosition)

Specifies the position of the labels.

Parameters

value - ChartPieLabelsPosition

The value for Position

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Pie(pie => pie.Sales)
                        .Labels(labels => labels
                               .Position(ChartPieLabelsPosition.InsideEnd)
                        )
                    )
                )
             

Position(Kendo.Mvc.UI.ChartPointLabelsPosition)

Specifies the position of the labels.

Parameters

value - ChartPointLabelsPosition

The value for Position

Example

Razor

 
                @(Html.Kendo().Chart(Model)
                    .Name("Chart")
                    .Series(series => series
                        .Point(point => point.Sales)
                        .Labels(labels => labels
                               .Position(ChartPointLabelsPosition.InsideEnd)
                        )
                    )
                )
             

AriaTemplate(System.String)

The template which renders the ARIA label for the series labels.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line and pie series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for 100% stacked charts.; series - the data series or value - the point value. Can be a number or object containing each bound field..

Parameters

value - System.String

The value for AriaTemplate

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

AriaTemplateId(System.String)

The template which renders the ARIA label for the series labels.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line and pie series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for 100% stacked charts.; series - the data series or value - the point value. Can be a number or object containing each bound field..

Parameters

templateId - System.String

The ID of the template element for AriaTemplate

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

AriaTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

The template which renders the ARIA label for the series labels.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line and pie series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for 100% stacked charts.; series - the data series or value - the point value. Can be a number or object containing each bound field..

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for AriaTemplate

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

AriaTemplateHandler(System.String)

The template which renders the ARIA label for the series labels.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line and pie series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for 100% stacked charts.; series - the data series or value - the point value. Can be a number or object containing each bound field..

Parameters

templateHandler - System.String

The handler that returs the template for AriaTemplate

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

AriaTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)

The template which renders the ARIA label for the series labels.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line and pie series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for 100% stacked charts.; series - the data series or value - the point value. Can be a number or object containing each bound field..

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the ariatemplate.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Background(System.String)

The background color of the labels. Accepts a valid CSS color string, including hex and rgb.

Parameters

value - System.String

The value for Background

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

BackgroundHandler(System.String)

The background color of the labels. Accepts a valid CSS color string, including hex and rgb.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

BackgroundHandler(System.Func)

The background color of the labels. Accepts a valid CSS color string, including hex and rgb.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Border(System.Action)

The border of the labels.

Parameters

configurator - System.Action<ChartSeriesLabelsBorderSettingsBuilder>

The configurator for the border setting.

RETURNS

Returns the current instance of ChartSeriesLabelsSettingsBuilder .

Color(System.String)

The text color of the labels. Accepts a valid CSS color string, including hex and rgb.

Parameters

value - System.String

The value for Color

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

ColorHandler(System.String)

The text color of the labels. Accepts a valid CSS color string, including hex and rgb.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

ColorHandler(System.Func)

The text color of the labels. Accepts a valid CSS color string, including hex and rgb.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Distance(System.Double)

The distance of the labels when series.type is set to "donut" or "pie".

Parameters

value - System.Double

The value for Distance

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Font(System.String)

The font style of the labels. Accepts a valid CSS font string, for example "20px Courier New'".

Parameters

value - System.String

The value for Font

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

FontHandler(System.String)

The font style of the labels. Accepts a valid CSS font string, for example "20px Courier New'".

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

FontHandler(System.Func)

The font style of the labels. Accepts a valid CSS font string, for example "20px Courier New'".

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Format(System.String)

The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, line, pie, radarArea, radarColumn and radarLine{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Bullet{0} - value{1} - target value; Scatter, scatterLine{0} - x value{1} - y value; PolarArea, polarLine and polarScatter{0} - x value (degrees){1} - y value; Candlestick and OHLC{0} - open value{1} - high value{2} - low value{3} - close value{4} - category name or RangeArea, rangeBar, rangeColumn{0} - from value{1} - to value.

Parameters

value - System.String

The value for Format

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

FormatHandler(System.String)

The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, line, pie, radarArea, radarColumn and radarLine{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Bullet{0} - value{1} - target value; Scatter, scatterLine{0} - x value{1} - y value; PolarArea, polarLine and polarScatter{0} - x value (degrees){1} - y value; Candlestick and OHLC{0} - open value{1} - high value{2} - low value{3} - close value{4} - category name or RangeArea, rangeBar, rangeColumn{0} - from value{1} - to value.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

FormatHandler(System.Func)

The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, line, pie, radarArea, radarColumn and radarLine{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Bullet{0} - value{1} - target value; Scatter, scatterLine{0} - x value{1} - y value; PolarArea, polarLine and polarScatter{0} - x value (degrees){1} - y value; Candlestick and OHLC{0} - open value{1} - high value{2} - low value{3} - close value{4} - category name or RangeArea, rangeBar, rangeColumn{0} - from value{1} - to value.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Margin(System.Action)

The margin of the labels. A numeric value will set all margins.

Parameters

configurator - System.Action<ChartSeriesLabelsMarginSettingsBuilder>

The configurator for the margin setting.

RETURNS

Returns the current instance of ChartSeriesLabelsSettingsBuilder .

Padding(System.Action)

The padding of the labels. A numeric value will set all paddings.

Parameters

configurator - System.Action<ChartSeriesLabelsPaddingSettingsBuilder>

The configurator for the padding setting.

RETURNS

Returns the current instance of ChartSeriesLabelsSettingsBuilder .

Rotation(System.String)

The rotation angle of the labels. By default, the labels are not rotated.

Parameters

value - System.String

The value for Rotation

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Template(System.String)

The template which renders the chart series label.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line, pie and waterfall series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; series - the data series; stackValue - the cumulative point value on the stack. Available only for stackable series.; value - the point value. Can be a number or object containing each bound field.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..

Parameters

value - System.String

The value for Template

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

TemplateId(System.String)

The template which renders the chart series label.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line, pie and waterfall series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; series - the data series; stackValue - the cumulative point value on the stack. Available only for stackable series.; value - the point value. Can be a number or object containing each bound field.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..

Parameters

templateId - System.String

The ID of the template element for Template

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)

The template which renders the chart series label.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line, pie and waterfall series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; series - the data series; stackValue - the cumulative point value on the stack. Available only for stackable series.; value - the point value. Can be a number or object containing each bound field.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..

Parameters

templateView - Microsoft.AspNetCore.Html.IHtmlContent

The view that contains the template for Template

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

TemplateHandler(System.String)

The template which renders the chart series label.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line, pie and waterfall series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; series - the data series; stackValue - the cumulative point value on the stack. Available only for stackable series.; value - the point value. Can be a number or object containing each bound field.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..

Parameters

templateHandler - System.String

The handler that returs the template for Template

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)

The template which renders the chart series label.The fields which can be used in the template are: category - the category name. Available for area, bar, column, bubble, donut, line, pie and waterfall series.; dataItem - the original data item used to construct the point. Will be null if binding to array.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; series - the data series; stackValue - the cumulative point value on the stack. Available only for stackable series.; value - the point value. Can be a number or object containing each bound field.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..

Parameters

template - TemplateBuilder<TModel>

A Template component that configures the template.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Visible(System.Boolean)

If set to true the chart will display the series labels. By default chart series labels are not displayed.

Parameters

value - System.Boolean

The value for Visible

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

VisibleHandler(System.String)

If set to true the chart will display the series labels. By default chart series labels are not displayed.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

VisibleHandler(System.Func)

If set to true the chart will display the series labels. By default chart series labels are not displayed.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Visual(System.String)

A function that can be used to create a custom visual for the labels. The available argument fields are: text - the label text.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; options - the label options.; createVisual - a function that can be used to get the default visual.; sender - the chart instance (may be undefined).; value - The point value.; category - The point category.; stackValue - The cumulative point value on the stack. Available only for the stackable series.; dataItem - The point dataItem.; series - The point series.; percentage - The point value that is represented as a percentage value. Available only for the Donut, Pie, and 100% stacked charts.; runningTotal - The sum of point values from the last runningTotal summary point onwards. Available for the Waterfall series. or total - The sum of all previous series values. Available for the Waterfall series..

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Visual(System.Func)

A function that can be used to create a custom visual for the labels. The available argument fields are: text - the label text.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; options - the label options.; createVisual - a function that can be used to get the default visual.; sender - the chart instance (may be undefined).; value - The point value.; category - The point category.; stackValue - The cumulative point value on the stack. Available only for the stackable series.; dataItem - The point dataItem.; series - The point series.; percentage - The point value that is represented as a percentage value. Available only for the Donut, Pie, and 100% stacked charts.; runningTotal - The sum of point values from the last runningTotal summary point onwards. Available for the Waterfall series. or total - The sum of all previous series values. Available for the Waterfall series..

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

From(System.Action)

The chart series from label configuration.

Parameters

configurator - System.Action<ChartSeriesLabelsFromSettingsBuilder>

The configurator for the from setting.

RETURNS

Returns the current instance of ChartSeriesLabelsSettingsBuilder .

To(System.Action)

The chart series to label configuration.

Parameters

configurator - System.Action<ChartSeriesLabelsToSettingsBuilder>

The configurator for the to setting.

RETURNS

Returns the current instance of ChartSeriesLabelsSettingsBuilder .

Align(Kendo.Mvc.UI.ChartSeriesLabelsAlign)

Specifies the alignment of the labels.

Parameters

value - ChartSeriesLabelsAlign

The value for Align

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

Position(Kendo.Mvc.UI.ChartSeriesLabelsPosition)

Specifies the position of the labels.

Parameters

value - ChartSeriesLabelsPosition

The value for Position

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

PositionHandler(System.String)

Specifies the position of the labels.

Parameters

handler - System.String

The name of the JavaScript function that will be evaluated.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.

PositionHandler(System.Func)

Specifies the position of the labels.

Parameters

handler - System.Func<Object,Object>

The handler code wrapped in a text tag.

RETURNS

Returns the current ChartSeriesLabelsSettingsBuilder instance.