ChartDesigner
Provides a settings panel to configure a Chart, with a live preview.
Requires one or more data series to be configured, as well as one or more data objects to provide data for the preview. See Chart for details on chart setup.
The designer is organized into three tabs:
- Layout: Choose the major chart type (line, bar, etc.) and chart components (title, legend).
- Data: Specify which data series will be used in the chart, and how.
- Appearance: Customize the look and feel of various chart components, including colors, fonts, and spacing.
Configs
Configs are options you supply in a configuration object when creating an instance of this class-
Get/set the subtitle.
Has a corresponding runtime chartSubtitle property.
-
Get/set the title.
Has a corresponding runtime chartTitle property.
-
Optional configuration for the NumberField.
Has a corresponding runtime field property.
-
The sample data to use as data in the chart preview.
Has a corresponding runtime data property.
-
The available series (drawn from series) that can be chosen as the labels series.
Has a corresponding runtime labelsSeriesOptions property.
-
The series ID (field name) of the series currently selected for use as the labels series.
Has a corresponding runtime selectedLabelsSeriesId property.
-
The currently selected series IDs (field names) for inclusion in the chart. See series.
Has a corresponding runtime selectedSeriesIds property.
-
Whether to display in minimal mode, where chart preview occupies full area and settings panel is minimized.
Has a corresponding runtime minimal property.
-
Set the font families available for selection.
Has a corresponding runtime fontFamilies property.
Properties
Properties are getters/setters or publicly accessible variables on this class-
Identifies an object as an instance of ChartDesigner class, or subclass thereof.
-
Get/set the subtitle.
Has a corresponding chartSubtitle config.
-
Get/set the title.
Has a corresponding chartTitle config.
-
Optional configuration for the NumberField.
Has a corresponding field config.
-
Identifies an object as an instance of ChartDesigner class, or subclass thereof.
-
The sample data to use as data in the chart preview.
Has a corresponding data config.
-
The available series (drawn from series) that can be chosen as the labels series.
Has a corresponding labelsSeriesOptions config.
-
The series ID (field name) of the series currently selected for use as the labels series.
Has a corresponding selectedLabelsSeriesId config.
-
The currently selected series IDs (field names) for inclusion in the chart. See series.
Has a corresponding selectedSeriesIds config.
-
Whether to display in minimal mode, where chart preview occupies full area and settings panel is minimized.
Has a corresponding minimal config.
-
Set the font families available for selection.
Has a corresponding fontFamilies config.