ChartBuilder
Defines the fluent API for configuring the Kendo UI Chart
Properties
WriteAction - Func
Methods
Title(System.String)
The chart title.
Parameters
title - System.String
The value of the Chart title
Subtitle(System.String)
The chart subtitle.
Parameters
subtitle - System.String
The value of the Chart subtitle
SeriesDefaults(System.Action)
Configures the common series settings
Parameters
configurator - System.Action<ChartSeriesDefaultsSettingsBuilder>
The configurator
Example
@(Html.Kendo().Chart()
.Name("chart")
.SeriesDefaults(seriesDefaults =>
seriesDefaults.Area().Line(line => line.Style(ChartSeriesLineStyle.Smooth))
)
.Series(series =>
{
series.Area(new double[] { 3.907, 7.943, 5.848 }).Name("Result 1");
series.Area(new double[] { 4.223, 6.743, 8.922 }).Name("Result 2");
})
.CategoryAxis(axis => axis
.Categories("2002", "2003", "2004")
)
)
CategoryAxis(System.Action)
Configures the category axis
Parameters
configurator - System.Action<ChartCategoryAxisBuilder>
The configurator
Example
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =>
{
series.Area(new double[] { 3.907, 7.943, 5.848 }).Name("Result");
})
.CategoryAxis(axis => axis
.Categories("2002", "2003", "2004")
)
)
DataSource(System.Action)
DataSource configuration
Parameters
configurator - System.Action<ReadOnlyAjaxDataSourceBuilder>
Use the configurator to set different data binding options.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.DataSource(ds =>
{
ds.Ajax().Read(r => r.Action("SalesData", "Chart"));
})
)
DataSource(System.String)
Assigns an external DataSource to the Chart
Parameters
dataSourceId - System.String
The name of the external DataSource
Example
@(Html.Kendo().DataSource<ProductViewModel>()
.Name("dataSource1")
.Ajax(dataSource => dataSource
.Read(read => read.Action("Products_Read", "DataSource"))
)
)
@(Html.Kendo().Chart<ProductViewModel>()
.Name("chart")
.DataSource("dataSource1")
.Series(series =>
{
series.Column(model => model.UnitPrice).Name("Price").CategoryField("ProductName");
})
)
Legend(System.Boolean)
Sets the legend visibility.
Parameters
visible - System.Boolean
A value indicating whether to show the legend.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Legend(false)
);
ValueAxis(System.Action)
Configures the default value axis or adds a new one
Parameters
configurator - System.Action<ChartValueAxisBuilder>
The configurator for the axis
Example
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =>
{
series.Area(new double[] { 3.907, 7.943, 5.848 }).Name("Result 1");
})
.CategoryAxis(axis => axis
.Categories("2002", "2003", "2004")
)
.ValueAxis(axi s=> axis
.MajorUnit(1)
)
)
XAxis(System.Action)
Configures the default X axis or adds a new one
Parameters
configurator - System.Action<ChartXAxisBuilder>
The configurator for the axis
Example
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =>
{
series.Scatter(new double[][] {
new[] { 6.4, 5.4 },
new[] { 11.7, 2 },
new[] { 25.4, 3 },
new[] { 19.0, 2.0 }
});
})
.XAxis(x => x
.Numeric()
.Max(30)
)
)
YAxis(System.Action)
Configures the default Y axis or adds a new one
Parameters
configurator - System.Action<ChartYAxisBuilder>
The configurator for the axis
Example
@(Html.Kendo().Chart()
.Name("chart")
.Series(series =>
{
series.Scatter(new double[][] {
new[] { 6.4, 5.4 },
new[] { 11.7, 2 },
new[] { 25.4, 3 },
new[] { 19.0, 2.0 }
});
})
.YAxis(x => x
.Numeric()
.Max(15)
)
)
AutoBind(System.Boolean)
If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.
Parameters
value - System.Boolean
The value for AutoBind
AxisDefaults(System.Action)
The default options for all chart axes. Accepts the options supported by categoryAxis, valueAxis, xAxis and yAxis.
Parameters
configurator - System.Action<ChartAxisDefaultsSettingsBuilder>
The configurator for the axisdefaults setting.
ChartArea(System.Action)
The chart area configuration options. Represents the entire visible area of the chart.
Parameters
configurator - System.Action<ChartChartAreaSettingsBuilder>
The configurator for the chartarea setting.
Legend(System.Action)
The chart legend configuration options.
Parameters
configurator - System.Action<ChartLegendSettingsBuilder>
The configurator for the legend setting.
PaneDefaults(System.Action)
The default options for all panes.
Parameters
configurator - System.Action<ChartPaneDefaultsSettingsBuilder>
The configurator for the panedefaults setting.
Panes(System.Action)
The chart panes configuration.Panes are used to split the chart in two or more parts. The panes are ordered from top to bottom.Each axis can be associated with a pane by setting its pane option to the name of the desired pane. Axis that don't have specified pane are placed in the top (default) pane.Series are moved to the desired pane by associating them with an axis.
Parameters
configurator - System.Action<ChartPaneFactory>
The configurator for the panes setting.
Pannable(System.Action)
Specifies if the chart can be panned.
Parameters
configurator - System.Action<ChartPannableSettingsBuilder>
The configurator for the pannable setting.
Pannable()
Specifies if the chart can be panned.
Pannable(System.Boolean)
Specifies if the chart can be panned.
Parameters
enabled - System.Boolean
Enables or disables the pannable option.
Pdf(System.Action)
Configures the export settings for the saveAsPDF method.
Parameters
configurator - System.Action<ChartPdfSettingsBuilder>
The configurator for the pdf setting.
PersistSeriesVisibility(System.Boolean)
Specifies if the series visible option should be persisted when changing the dataSource data.
Parameters
value - System.Boolean
The value for PersistSeriesVisibility
PersistSeriesVisibility()
Specifies if the series visible option should be persisted when changing the dataSource data.
PlotArea(System.Action)
The plot area configuration options. The plot area is the area which displays the series.
Parameters
configurator - System.Action<ChartPlotAreaSettingsBuilder>
The configurator for the plotarea setting.
Series(System.Action)
The configuration of the chart series.The series type is determined by the value of the type field. If a type value is missing, the type is assumed to be the one specified in seriesDefaults.
Parameters
configurator - System.Action<ChartSeriesFactory>
The configurator for the series setting.
SeriesColors(System.String[])
The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
Parameters
value - System.String[]
The value for SeriesColors
Subtitle(System.Action)
The chart subtitle configuration options or text.
Parameters
configurator - System.Action<ChartSubtitleSettingsBuilder>
The configurator for the subtitle setting.
Theme(System.String)
The chart theme. This can be either a built-in theme or "sass". When set to "sass" the chart will read the variables from the Sass-based themes. More information on the built-in themes could be found in the Less-based themes article.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "fiori"; "flat"; "highcontrast"; "material"; "materialblack"; "metro"; "metroblack"; "moonlight"; "nova"; "office365"; "silver" or "uniform".
Parameters
value - System.String
The value for Theme
Title(System.Action)
The chart title configuration options or text.
Parameters
configurator - System.Action<ChartTitleSettingsBuilder>
The configurator for the title setting.
Tooltip(System.Action)
The chart series tooltip configuration options.
Parameters
configurator - System.Action<ChartTooltipSettingsBuilder>
The configurator for the tooltip setting.
Transitions(System.Boolean)
If set to true the chart will play animations when displaying the series. By default animations are enabled.
Parameters
value - System.Boolean
The value for Transitions
Zoomable(System.Action)
Specifies if the chart can be zoomed.
Parameters
configurator - System.Action<ChartZoomableSettingsBuilder>
The configurator for the zoomable setting.
Zoomable()
Specifies if the chart can be zoomed.
Zoomable(System.Boolean)
Specifies if the chart can be zoomed.
Parameters
enabled - System.Boolean
Enables or disables the zoomable option.
RenderAs(Kendo.Mvc.UI.RenderingMode)
Specifies the preferred widget rendering mode.
Parameters
value - RenderingMode
The value for RenderAs
Events(System.Action)
Configures the client-side events.
Parameters
configurator - System.Action<ChartEventBuilder>
The client events action.
Example
@(Html.Kendo().Chart()
.Name("Chart")
.Events(events => events
.AxisLabelClick("onAxisLabelClick")
)
)
ToComponent()
Returns the internal view component.
Expression(System.String)
Sets the name of the component.
Parameters
modelExpression - System.String
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)
Sets the name of the component.
Parameters
modelExplorer - Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
Name(System.String)
Sets the name of the component.
Parameters
componentName - System.String
The name.
Deferred(System.Boolean)
Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters
deferred - System.Boolean
HtmlAttributes(System.Object)
Sets the HTML attributes.
Parameters
attributes - System.Object
The HTML attributes.
HtmlAttributes(System.Collections.Generic.IDictionary)
Sets the HTML attributes.
Parameters
attributes - System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
Render()
Renders the component in place.