OptionsBase
Namespace: Wisej.Web.Ext.ChartJS3
Assembly: Wisej.Web.Ext.ChartJS3 (4.1.0.0)
Base class for all the option classes.
- C#
- VB.NET
public abstract class OptionsBase : ICloneable
Public MustInherit Class OptionsBase
Inherits ICloneable
Every option set belongs either directly to a ChartJS3 control or to a parent option set. Changing a value property of an option set calls Update, which updates the owner ChartJS3 control. An option set instance cannot be assigned to two different owners.
Example:
// all option classes derive from OptionsBase.
OptionsBase title = this.chartJS31.Options.Plugins.Title;
OptionsBase legend = this.chartJS31.Options.Plugins.Legend;
// force a refresh of the chart.
title.Update();
Methods
Update()
Updates the ChartJS3 control using this set of options.
The call is ignored when this option set is not attached to a ChartJS3 control, either directly or through its owner option set. It is called automatically when a value property of the option set changes, but not when a nested option set (for example Plugins or Scales) is replaced.
Example:
var options = this.chartJS31.Options;
options.Plugins.Title = new OptionsTitle { Text = "Monthly Sales" };
// assigning a nested option set doesn't refresh the chart.
options.Update();
Inherited By
| Name | Description |
|---|---|
| Options | Represents the base options for the ChartJS3 widget. Different ChartType values extend this class with type specific options. |
| LineOptions | Options for the Line chart. |
| BarOptions | Options for the Bar chart. |
| PieOptions | Options for the Pie chart. |
| PolarAreaOptions | Options for the PolarArea chart. |
| DoughnutOptions | Options for the Doughnut chart. |
| RadarOptions | Options for the Radar chart. |
| BubbleOptions | Options for the Bubble chart. |
| ScatterOptions | Options for the Scatter chart. |
| OptionsAxisGrid | Specifies the grid line configuration for each axis. |
| OptionsDataLabels | Represents the options for the data labels. |
| OptionsLegend | Represents the options for the chart legend. |
| OptionsLegendLabels | Represents the options for the labels in the chart legend. |
| OptionsPlugins | Represents the options for the plugins. |
| OptionsScales | Represents the options for the axes (scales) of the chart. |
| OptionScalesAxes | Represents the options for the scale axes. |
| OptionScalesAxesX | Represents the options for the scale X axes. |
| OptionScalesAxesY | Represents the options for the scale Y axes. |
| OptionsScalesTicks | Represents the options for the ticks element of the axes. |
| OptionsScaleTitle | Represents the options for the title of an axis. |
| OptionsTitle | Represents the options for the chart title. |
| OptionsTooltips | Represents the options for the chart tooltips. |
| ScaleTime | Options used when the axis is a time scale. |