Skip to main content

SparklineBuilder Members

A Sparkline control.

Constructors

Name Description
SparklineBuilder(OptionsOwnerContext) For internal use only. Initializes a new SparklineBuilder class instance.

Methods

Name Description
ArgumentField(JS) Specifies the data source field that provides arguments for a sparkline. Mirrors the client-side argumentField option.
ArgumentField(String) Specifies the data source field that provides arguments for a sparkline. Mirrors the client-side argumentField option.
BarNegativeColor(JS) Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. Mirrors the client-side barNegativeColor option.
BarNegativeColor(String) Sets a color for the bars indicating negative values. Available for a sparkline of the bar type only. Mirrors the client-side barNegativeColor option.
BarPositiveColor(JS) Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. Mirrors the client-side barPositiveColor option.
BarPositiveColor(String) Sets a color for the bars indicating positive values. Available for a sparkline of the bar type only. Mirrors the client-side barPositiveColor option.
DataSource(JS) Binds the UI component to data. Mirrors the client-side dataSource option.
DataSource(IEnumerable, String[]) Binds a Sparkline control to a collection: Array, List, or IEnumerable.
DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) Binds a Sparkline 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 Sparkline control to read-only data in JSON format.
DataSourceOptions(Action<DataSourceOptionsBuilder>) Provides access to methods that mirror client-side data source options.
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.
FirstLastColor(JS) Sets a color for the boundary of both the first and last points on a sparkline. Mirrors the client-side firstLastColor option.
FirstLastColor(String) Sets a color for the boundary of both the first and last points on a sparkline. Mirrors the client-side firstLastColor option.
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.
IgnoreEmptyPoints(JS) Specifies whether the sparkline should ignore null data points. Mirrors the client-side ignoreEmptyPoints option.
IgnoreEmptyPoints(Boolean) Specifies whether the sparkline should ignore null data points. Mirrors the client-side ignoreEmptyPoints option.
LineColor(JS) Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side lineColor option.
LineColor(String) Sets a color for a line on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side lineColor option.
LineWidth(JS) Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side lineWidth option.
LineWidth(Double) Specifies a width for a line on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side lineWidth option.
LossColor(JS) Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. Mirrors the client-side lossColor option.
LossColor(String) Sets a color for the bars indicating the values that are less than the winloss threshold. Available for a sparkline of the winloss type only. Mirrors the client-side lossColor option.
Margin(Action<SparklineMarginBuilder>) Generates space around the UI component. Mirrors the client-side margin object.
MaxColor(JS) Sets a color for the boundary of the maximum point on a sparkline. Mirrors the client-side maxColor option.
MaxColor(String) Sets a color for the boundary of the maximum point on a sparkline. Mirrors the client-side maxColor option.
MaxValue(JS) Specifies the maximum value of the sparkline's value axis. Mirrors the client-side maxValue option.
MaxValue(Double) Specifies the maximum value of the sparkline's value axis. Mirrors the client-side maxValue option.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MinColor(JS) Sets a color for the boundary of the minimum point on a sparkline. Mirrors the client-side minColor option.
MinColor(String) Sets a color for the boundary of the minimum point on a sparkline. Mirrors the client-side minColor option.
MinValue(JS) Specifies the minimum value of the sparkline value axis. Mirrors the client-side minValue option.
MinValue(Double) Specifies the minimum value of the sparkline value axis. Mirrors the client-side minValue 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.
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.
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.
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.
Option(String, Object) Specifies an option by its name.
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.
PointColor(JS) Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side pointColor option.
PointColor(String) Sets a color for points on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side pointColor option.
PointSize(JS) Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. Mirrors the client-side pointSize option.
PointSize(Double) Specifies the diameter of sparkline points in pixels. Available for the sparklines of line- and area-like types. Mirrors the client-side pointSize option.
PointSymbol(VizPointSymbol) Specifies a symbol to use as a point marker on a sparkline. Available for the sparklines of the line- and area-like types. Mirrors the client-side pointSymbol option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
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.
ShowFirstLast(JS) Specifies whether or not to indicate both the first and last values on a sparkline. Mirrors the client-side showFirstLast option.
ShowFirstLast(Boolean) Specifies whether or not to indicate both the first and last values on a sparkline. Mirrors the client-side showFirstLast option.
ShowMinMax(JS) Specifies whether or not to indicate both the minimum and maximum values on a sparkline. Mirrors the client-side showMinMax option.
ShowMinMax(Boolean) Specifies whether or not to indicate both the minimum and maximum values on a sparkline. Mirrors the client-side showMinMax option.
Size(Action<SparklineSizeBuilder>) Mirrors the client-side size object.
Theme(VizTheme) Sets the name of the theme the UI component uses. Mirrors the client-side theme option.
Tooltip(Action<SparklineTooltipBuilder>) 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.
Type(SparklineType) Determines the type of a sparkline. Mirrors the client-side type option.
ValueField(JS) Specifies the data source field that provides values for a sparkline. Mirrors the client-side valueField option.
ValueField(String) Specifies the data source field that provides values for a sparkline. Mirrors the client-side valueField option.
WinColor(JS) Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. Mirrors the client-side winColor option.
WinColor(String) Sets a color for the bars indicating the values greater than a winloss threshold. Available for a sparkline of the winloss type only. Mirrors the client-side winColor option.
WinlossThreshold(JS) Specifies a value that serves as a threshold for the sparkline of the winloss type. Mirrors the client-side winlossThreshold option.
WinlossThreshold(Double) Specifies a value that serves as a threshold for the sparkline of the winloss type. Mirrors the client-side winlossThreshold option.
See Also