ChartCategoryAxisLabelsSettingsBuilder
Methods
Margin(System.Int32,System.Int32,System.Int32,System.Int32)
Sets the labels margin.
Parameters
top - System.Int32
The labels top margin.
right - System.Int32
The labels right margin.
bottom - System.Int32
The labels bottom margin.
left - System.Int32
The labels left margin.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.CategoryAxis(categoryAxis => categoryAxis.Labels(labels => labels.Margin(10, 5, 10, 5)))
)
Padding(System.Int32,System.Int32,System.Int32,System.Int32)
Sets the labels padding.
Parameters
top - System.Int32
The labels top padding.
right - System.Int32
The labels right padding.
bottom - System.Int32
The labels bottom padding.
left - System.Int32
The labels left padding.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.CategoryAxis(categoryAxis => categoryAxis.Labels(labels => labels.Padding(10, 5, 10, 5)))
)
Rotation(System.Double)
The rotation angle of the labels. By default the labels are not rotated.
Parameters
value - System.Double
The value for Rotation
Example
@(Html.Kendo().Chart()
.Name("Chart")
.CategoryAxis(categoryAxis => categoryAxis.Labels(labels => labels.Rotation(45)))
)
Rotation(System.String)
The rotation angle of the labels.
Parameters
value - System.String
The value for Rotation
Example
@(Html.Kendo().Chart()
.Name("Chart")
.CategoryAxis(categoryAxis => categoryAxis.Labels(labels => labels.Rotation("45")))
)
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 ChartCategoryAxisLabelsSettingsBuilder instance.
Border(System.Action)
The border of the labels.
Parameters
configurator - System.Action<ChartCategoryAxisLabelsBorderSettingsBuilder>
The configurator for the border setting.
RETURNS
Returns the current instance of ChartCategoryAxisLabelsSettingsBuilder .
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 ChartCategoryAxisLabelsSettingsBuilder instance.
Culture(System.String)
The culture to use when formatting date values. See the globalization overview for more information.
Parameters
value - System.String
The value for Culture
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
DateFormats(System.Action)
The format used to display labels for date category axis. The {0} placeholder represents the category value.The chart will choose the appropriate format for the current categoryAxis.baseUnit. Setting the categoryAxis.labels.format option will override the date formats.See also: kendo.format.
Parameters
configurator - System.Action<ChartCategoryAxisLabelsDateFormatsSettingsBuilder>
The configurator for the dateformats setting.
RETURNS
Returns the current instance of ChartCategoryAxisLabelsSettingsBuilder .
Font(System.String)
The font style of the labels. Accepts a valid CSS color string, for example "20px 'Courier New'".
Parameters
value - System.String
The value for Font
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Format(System.String)
The format used to display the labels. Uses kendo.format. Contains one placeholder ("{0}") which represents the category value.
Parameters
value - System.String
The value for Format
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Margin(System.Action)
The margin of the labels. A numeric value will set all margins.
Parameters
configurator - System.Action<ChartCategoryAxisLabelsMarginSettingsBuilder>
The configurator for the margin setting.
RETURNS
Returns the current instance of ChartCategoryAxisLabelsSettingsBuilder .
Mirror(System.Boolean)
If set to true the chart will mirror the axis labels and ticks. If the labels are normally on the left side of the axis, mirroring the axis will render them to the right.
Parameters
value - System.Boolean
The value for Mirror
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Mirror()
If set to true the chart will mirror the axis labels and ticks. If the labels are normally on the left side of the axis, mirroring the axis will render them to the right.
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Padding(System.Action)
The padding of the labels. A numeric value will set all paddings.
Parameters
configurator - System.Action<ChartCategoryAxisLabelsPaddingSettingsBuilder>
The configurator for the padding setting.
RETURNS
Returns the current instance of ChartCategoryAxisLabelsSettingsBuilder .
Rotation(System.Action)
The rotation angle of the labels. By default the labels are not rotated. Can be set to "auto" if the axis is horizontal in which case the labels will be rotated only if the slot size is not sufficient for the entire labels.
Parameters
configurator - System.Action<ChartCategoryAxisLabelsRotationSettingsBuilder>
The configurator for the rotation setting.
RETURNS
Returns the current instance of ChartCategoryAxisLabelsSettingsBuilder .
Skip(System.Double)
The number of labels to skip. By default no labels are skipped.
Parameters
value - System.Double
The value for Skip
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Step(System.Double)
The label rendering step - render every n-th label. By default every label is rendered.
Parameters
value - System.Double
The value for Step
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Template(System.String)
The template which renders the labels.The fields which can be used in the template are: value - the category value; dataItem - the data item, in case a field has been specified. If the category does not have a corresponding item in the data then an empty object will be passed.; format - the default format of the label; culture - the default culture (if set) on the label; index - the 0-based index of the current label or count - the total number of labels on the axis.
Parameters
value - System.String
The value for Template
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
TemplateId(System.String)
The template which renders the labels.The fields which can be used in the template are: value - the category value; dataItem - the data item, in case a field has been specified. If the category does not have a corresponding item in the data then an empty object will be passed.; format - the default format of the label; culture - the default culture (if set) on the label; index - the 0-based index of the current label or count - the total number of labels on the axis.
Parameters
templateId - System.String
The ID of the template element for Template
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the labels.The fields which can be used in the template are: value - the category value; dataItem - the data item, in case a field has been specified. If the category does not have a corresponding item in the data then an empty object will be passed.; format - the default format of the label; culture - the default culture (if set) on the label; index - the 0-based index of the current label or count - the total number of labels on the axis.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
TemplateHandler(System.String)
The template which renders the labels.The fields which can be used in the template are: value - the category value; dataItem - the data item, in case a field has been specified. If the category does not have a corresponding item in the data then an empty object will be passed.; format - the default format of the label; culture - the default culture (if set) on the label; index - the 0-based index of the current label or count - the total number of labels on the axis.
Parameters
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the labels.The fields which can be used in the template are: value - the category value; dataItem - the data item, in case a field has been specified. If the category does not have a corresponding item in the data then an empty object will be passed.; format - the default format of the label; culture - the default culture (if set) on the label; index - the 0-based index of the current label or count - the total number of labels on the axis.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Visible(System.Boolean)
If set to true the chart will display the category axis labels. By default the category axis labels are visible.
Parameters
value - System.Boolean
The value for Visible
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Visual(System.String)
A function that can be used to create a custom visual for the labels. The available argument fields are: createVisual - a function that can be used to get the default visual.; culture - the default culture (if set) on the label; dataItem - the data item, in case a field has been specified; format - the default format of the label; options - the label options.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; sender - the chart instance (may be undefined).; text - the label text. or value - the category value.
Parameters
handler - System.String
The name of the JavaScript function that will be evaluated.
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Visual(System.Func)
A function that can be used to create a custom visual for the labels. The available argument fields are: createVisual - a function that can be used to get the default visual.; culture - the default culture (if set) on the label; dataItem - the data item, in case a field has been specified; format - the default format of the label; options - the label options.; rect - the kendo.geometry.Rect that defines where the visual should be rendered.; sender - the chart instance (may be undefined).; text - the label text. or value - the category value.
Parameters
handler - System.Func<Object,Object>
The handler code wrapped in a text tag.
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.
Position(Kendo.Mvc.UI.ChartAxisLabelsPosition)
Specifies the position of the labels.
Parameters
value - ChartAxisLabelsPosition
The value for Position
RETURNS
Returns the current ChartCategoryAxisLabelsSettingsBuilder instance.