Skip to main content
ID

ChartBuilder Methods

A Chart control.
Name Description
AdaptiveLayout(Action<ChartAdaptiveLayoutBuilder>) Specifies adaptive layout properties. Mirrors the client-side adaptiveLayout object.
AdjustOnZoom(JS) Specifies whether to adjust the value axis's visualRange when the argument axis is being zoomed or panned. Mirrors the client-side adjustOnZoom option.
AdjustOnZoom(Boolean) Specifies whether to adjust the value axis's visualRange when the argument axis is being zoomed or panned. Mirrors the client-side adjustOnZoom option.
Animation(JS) Specifies animation properties. Mirrors the client-side animation option.
Animation(Action<ChartAnimationBuilder>) Specifies animation properties. Mirrors the client-side animation object.
Animation(Boolean) Specifies animation properties. Mirrors the client-side animation option.
Annotations(Action<CollectionFactory<ChartAnnotationConfigBuilder>>) Provides access to the client-side annotations option that represents an annotation config collection.
ArgumentAxis(Action<ChartArgumentAxisBuilder>) Configures the argument axis. Mirrors the client-side argumentAxis object.
AutoHidePointMarkers(JS) Specifies whether to hide series point markers automatically to reduce visual clutter. Mirrors the client-side autoHidePointMarkers option.
AutoHidePointMarkers(Boolean) Specifies whether to hide series point markers automatically to reduce visual clutter. Mirrors the client-side autoHidePointMarkers option.
BarGroupPadding(JS) Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set. Mirrors the client-side barGroupPadding option.
BarGroupPadding(Double) Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set. Mirrors the client-side barGroupPadding option.
BarGroupWidth(JS) Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding property. Mirrors the client-side barGroupWidth option.
BarGroupWidth(Double) Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding property. Mirrors the client-side barGroupWidth option.
CommonAnnotationSettings(Action<ChartCommonAnnotationConfigBuilder>) Specifies settings common for all annotations in the chart. Mirrors the client-side commonAnnotationSettings object.
CommonAxisSettings(Action<ChartCommonAxisSettingsBuilder>) Defines common settings for both the argument and value axis in a chart. Mirrors the client-side commonAxisSettings object.
CommonPaneSettings(Action<ChartCommonPaneSettingsBuilder>) Defines common settings for all panes in a chart. Mirrors the client-side commonPaneSettings object.
CommonSeriesSettings(Action<ChartCommonSeriesSettingsBuilder>) Specifies settings common for all series in the chart. Mirrors the client-side commonSeriesSettings object.
ContainerBackgroundColor(JS) Specifies background color of the chart container. Mirrors the client-side containerBackgroundColor option.
ContainerBackgroundColor(String) Specifies background color of the chart container. Mirrors the client-side containerBackgroundColor option.
Crosshair(Action<ChartCrosshairBuilder>) Configures the crosshair feature. Mirrors the client-side crosshair object.
CustomizeAnnotation(RazorBlock) Customizes an individual annotation. Mirrors the client-side customizeAnnotation option.
CustomizeAnnotation(String) Customizes an individual annotation. Mirrors the client-side customizeAnnotation option.
CustomizeLabel(RazorBlock) Mirrors the client-side customizeLabel option.
CustomizeLabel(String) Mirrors the client-side customizeLabel option.
CustomizePoint(RazorBlock) Customizes the appearance of an individual series point. Mirrors the client-side customizePoint option.
CustomizePoint(String) Customizes the appearance of an individual series point. Mirrors the client-side customizePoint option.
DataPrepareSettings(Action<ChartDataPrepareSettingsBuilder>) Processes data before visualizing it. Mirrors the client-side dataPrepareSettings object.
DataSource(JS) Binds the UI component to data. Mirrors the client-side dataSource option.
DataSource(IEnumerable, String[]) Binds a Chart control to a collection: Array, List, or IEnumerable.
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) Binds a Chart control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more.
DataSource(String, String[]) Binds a Chart control to read-only data in JSON format.
DataSourceOptions(Action<DataSourceOptionsBuilder>) Provides access to methods that mirror client-side data source options.
DefaultPane(JS) Specifies which pane should be used by default. Mirrors the client-side defaultPane option.
DefaultPane(String) Specifies which pane should be used by default. Mirrors the client-side defaultPane option.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Export(Action<ChartExportBuilder>) Configures the exporting and printing features. Mirrors the client-side export object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
Legend(Action<ChartLegendBuilder>) Specifies the properties of a chart's legend. Mirrors the client-side legend object.
LoadingIndicator(Action<ChartLoadingIndicatorBuilder>) Configures the loading indicator. Mirrors the client-side loadingIndicator object.
Margin(Action<ChartMarginBuilder>) Generates space around the UI component. Mirrors the client-side margin object.
MaxBubbleSize(JS) Specifies a coefficient determining the diameter of the largest bubble. Mirrors the client-side maxBubbleSize option.
MaxBubbleSize(Double) Specifies a coefficient determining the diameter of the largest bubble. Mirrors the client-side maxBubbleSize option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MinBubbleSize(JS) Specifies the diameter of the smallest bubble measured in pixels. Mirrors the client-side minBubbleSize option.
MinBubbleSize(Double) Specifies the diameter of the smallest bubble measured in pixels. Mirrors the client-side minBubbleSize option.
NegativesAsZeroes(JS) Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only. Mirrors the client-side negativesAsZeroes option.
NegativesAsZeroes(Boolean) Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only. Mirrors the client-side negativesAsZeroes option.
OnArgumentAxisClick(RazorBlock) A function that is executed when a label on the argument axis is clicked or tapped. Mirrors the client-side onArgumentAxisClick option.
OnArgumentAxisClick(String) A function that is executed when a label on the argument axis is clicked or tapped. Mirrors the client-side onArgumentAxisClick option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDone(RazorBlock) A function that is executed when all series are ready. Mirrors the client-side onDone option.
OnDone(String) A function that is executed when all series are ready. Mirrors the client-side onDone option.
OnDrawn(RazorBlock) A function that is executed when the UI component's rendering has finished. Mirrors the client-side onDrawn option.
OnDrawn(String) A function that is executed when the UI component's rendering has finished. Mirrors the client-side onDrawn option.
OnExported(RazorBlock) A function that is executed after the UI component is exported. Mirrors the client-side onExported option.
OnExported(String) A function that is executed after the UI component is exported. Mirrors the client-side onExported option.
OnExporting(RazorBlock) A function that is executed before the UI component is exported. Mirrors the client-side onExporting option.
OnExporting(String) A function that is executed before the UI component is exported. Mirrors the client-side onExporting option.
OnFileSaving(RazorBlock) A function that is executed before a file with exported UI component is saved to the user's local storage. Mirrors the client-side onFileSaving option.
OnFileSaving(String) A function that is executed before a file with exported UI component is saved to the user's local storage. Mirrors the client-side onFileSaving option.
OnIncidentOccurred(RazorBlock) A function that is executed when an error or warning occurs. Mirrors the client-side onIncidentOccurred option.
OnIncidentOccurred(String) A function that is executed when an error or warning occurs. Mirrors the client-side onIncidentOccurred option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnLegendClick(RazorBlock) A function that is executed when a legend item is clicked or tapped. Mirrors the client-side onLegendClick option.
OnLegendClick(String) A function that is executed when a legend item is clicked or tapped. Mirrors the client-side onLegendClick option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnPointClick(RazorBlock) A function that is executed when a series point is clicked or tapped. Mirrors the client-side onPointClick option.
OnPointClick(String) A function that is executed when a series point is clicked or tapped. Mirrors the client-side onPointClick option.
OnPointHoverChanged(RazorBlock) A function that is executed after the pointer enters or leaves a series point. Mirrors the client-side onPointHoverChanged option.
OnPointHoverChanged(String) A function that is executed after the pointer enters or leaves a series point. Mirrors the client-side onPointHoverChanged option.
OnPointSelectionChanged(RazorBlock) A function that is executed when a series point is selected or selection is canceled. Mirrors the client-side onPointSelectionChanged option.
OnPointSelectionChanged(String) A function that is executed when a series point is selected or selection is canceled. Mirrors the client-side onPointSelectionChanged option.
OnSeriesClick(RazorBlock) A function that is executed when a series is clicked or tapped. Mirrors the client-side onSeriesClick option.
OnSeriesClick(String) A function that is executed when a series is clicked or tapped. Mirrors the client-side onSeriesClick option.
OnSeriesHoverChanged(RazorBlock) A function that is executed after the pointer enters or leaves a series. Mirrors the client-side onSeriesHoverChanged option.
OnSeriesHoverChanged(String) A function that is executed after the pointer enters or leaves a series. Mirrors the client-side onSeriesHoverChanged option.
OnSeriesSelectionChanged(RazorBlock) A function that is executed when a series is selected or selection is canceled. Mirrors the client-side onSeriesSelectionChanged option.
OnSeriesSelectionChanged(String) A function that is executed when a series is selected or selection is canceled. Mirrors the client-side onSeriesSelectionChanged option.
OnTooltipHidden(RazorBlock) A function that is executed when a tooltip becomes hidden. Mirrors the client-side onTooltipHidden option.
OnTooltipHidden(String) A function that is executed when a tooltip becomes hidden. Mirrors the client-side onTooltipHidden option.
OnTooltipShown(RazorBlock) A function that is executed when a tooltip appears. Mirrors the client-side onTooltipShown option.
OnTooltipShown(String) A function that is executed when a tooltip appears. Mirrors the client-side onTooltipShown option.
OnZoomEnd(RazorBlock) A function that is executed when zooming or panning ends. Mirrors the client-side onZoomEnd option.
OnZoomEnd(String) A function that is executed when zooming or panning ends. Mirrors the client-side onZoomEnd option.
OnZoomStart(RazorBlock) A function that is executed when zooming or panning begins. Mirrors the client-side onZoomStart option.
OnZoomStart(String) A function that is executed when zooming or panning begins. Mirrors the client-side onZoomStart option.
Option(String, Object) Specifies an option by its name.
Palette(JS) Sets the palette to be used for colorizing series and their elements. Mirrors the client-side palette option.
Palette(VizPalette) Sets the palette to be used for colorizing series and their elements. Mirrors the client-side palette option.
Palette(IEnumerable<String>) Sets the palette to be used for colorizing series and their elements. Mirrors the client-side palette option.
PaletteExtensionMode(VizPaletteExtensionMode) Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart UI component) or points in a series (in the PieChart UI component). Mirrors the client-side paletteExtensionMode option.
Panes(Action<CollectionFactory<ChartPaneBuilder>>) Provides access to the client-side panes option that represents a Chart pane collection.
PathModified(JS) Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. Mirrors the client-side pathModified option.
PathModified(Boolean) Notifies the UI component that it is embedded into an HTML page that uses a tag modifying the path. Mirrors the client-side pathModified option.
PointSelectionMode(ChartElementSelectionMode) Specifies whether a single point or multiple points can be selected in the chart. Mirrors the client-side pointSelectionMode option.
RedrawOnResize(JS) Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. Mirrors the client-side redrawOnResize option.
RedrawOnResize(Boolean) Specifies whether to redraw the UI component when the size of the container changes or a mobile device rotates. Mirrors the client-side redrawOnResize option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
ResizePanesOnZoom(JS) Specifies whether panes can be resized if other chart elements require more space after zooming or panning. Mirrors the client-side resizePanesOnZoom option.
ResizePanesOnZoom(Boolean) Specifies whether panes can be resized if other chart elements require more space after zooming or panning. Mirrors the client-side resizePanesOnZoom option.
ResolveLabelOverlapping(ChartResolveLabelOverlapping) Specifies how the chart must behave when series point labels overlap. Mirrors the client-side resolveLabelOverlapping option.
Rotated(JS) Swaps the axes around making the value axis horizontal and the argument axis vertical. Mirrors the client-side rotated option.
Rotated(Boolean) Swaps the axes around making the value axis horizontal and the argument axis vertical. Mirrors the client-side rotated option.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
ScrollBar(Action<ChartScrollBarBuilder>) Specifies the settings of the scroll bar. Mirrors the client-side scrollBar object.
Series(Action<CollectionFactory<ChartSeriesBuilder>>) Provides access to the client-side series option that represents a Chart series collection.
SeriesSelectionMode(ChartElementSelectionMode) Specifies whether a single series or multiple series can be selected in the chart. Mirrors the client-side seriesSelectionMode option.
SeriesTemplate(Action<ChartSeriesTemplateBuilder>) Defines properties for the series template. Mirrors the client-side seriesTemplate object.
Size(Action<ChartSizeBuilder>) Mirrors the client-side size object.
StickyHovering(JS) Specifies whether a point should remain in the hover state when the mouse pointer moves away. Mirrors the client-side stickyHovering option.
StickyHovering(Boolean) Specifies whether a point should remain in the hover state when the mouse pointer moves away. Mirrors the client-side stickyHovering option.
SynchronizeMultiAxes(JS) Indicates whether or not to synchronize value axes when they are displayed on a single pane. Mirrors the client-side synchronizeMultiAxes option.
SynchronizeMultiAxes(Boolean) Indicates whether or not to synchronize value axes when they are displayed on a single pane. Mirrors the client-side synchronizeMultiAxes option.
Theme(VizTheme) Sets the name of the theme the UI component uses. Mirrors the client-side theme option.
Title(JS) Mirrors the client-side title option.
Title(Action<ChartTitleBuilder>) Mirrors the client-side title object.
Title(String) Mirrors the client-side title option.
Tooltip(Action<ChartTooltipBuilder>) Mirrors the client-side tooltip object.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
ValueAxis(Action<CollectionFactory<ChartValueAxisBuilder>>) Provides access to the client-side valueAxis option that represents a Chart value axis collection.
ZoomAndPan(Action<ChartZoomAndPanBuilder>) Configures zooming and panning. Mirrors the client-side zoomAndPan object.
See Also