AgChartTheme
This object is used to define the configuration for a custom chart theme.
- baseTheme
AgChartThemeName - The name of the theme to base your theme on. Your custom theme will inherit all the configuration from the base theme, allowing you to override just the settings you wish to change using the `overrides` config (see below).
- palette
AgChartThemePalette - The palette to use. If specified, this replaces the palette from the base theme.
-
- fills
AgColorType[] - The array of fills to be used. An array of colour strings, or fill objects for gradients, patterns, or images.
- strokes
CssColor[] - The array of strokes to be used.
- up
AgPaletteColors - Colours used for positive or upward values, such as rising prices in Financial Charts.
- down
AgPaletteColors - Colours used for negative or downward values, such as falling prices in Financial Charts.
- neutral
AgPaletteColors - Colours used for neutral values, such as unchanged prices in financial charts.
- fills
- params
AgChartThemeParams - Global parameters to set styles across the whole chart.
-
- axisLineColor
AgCssColorOrRef - Default colour for axis lines and ticks. A colour string, or a theme-colour reference object.
- chartBackgroundColor
AgCssColorOrRef - Background colour of the chart. A colour string, or a theme-colour reference object.
- chartPadding
PixelSize - The outer chart padding.
- chromeBackgroundColor
AgCssColorOrRefdefault: foregroundColor + backgroundColor - Background colour of tooltips, menus, dialogs, toolbars and buttons. A colour string, or a theme-colour reference object.
- chromeFontFamily
FontFamilyFulldefault: fontFamily - Font family used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs. A single family name, or an array of names used as fallbacks.
- chromeFontSize
FontSizedefault: fontSize - Font size used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs.
- chromeFontWeight
FontWeightdefault: fontWeight - Font weight used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs.
- chromeTextColor
AgCssColorOrRefdefault: textColor - Default colour for text in tooltips, menus, dialogs, toolbars, buttons and text inputs. A colour string, or a theme-colour reference object.
- chromeSubtleTextColor
AgCssColorOrRefdefault: subtleTextColor - Colour of text that should stand out less than the default in tooltips, menus, dialogs, toolbars and buttons. A colour string, or a theme-colour reference object.
- crosshairLabelBackgroundColor
AgCssColorOrRefdefault: foregroundColor - Background colour of crosshair labels. A colour string, or a theme-colour reference object.
- crosshairLabelTextColor
AgCssColorOrRefdefault: backgroundColor - Colour for text in crosshair labels. A colour string, or a theme-colour reference object.
- fontWeight
FontWeight - Default font weight used for all text.
- gridLineColor
AgCssColorOrRef - Default colour for grid lines. A colour string, or a theme-colour reference object.
- groupedCategoryLineColor
AgCssColorOrRef - Default colour for grouped-category separation lines. A colour string, or a theme-colour reference object.
- accentColor
AgCssColorOrRef - The 'brand colour' for the chart, used wherever a non-neutral colour is required. Selections, focus outlines and checkboxes use the accent colour by default. A colour string, or a theme-colour reference object.
- backgroundColor
AgCssColorOrRef - Background colour of the chart. Most text, borders and backgrounds are defined as a blend between the background and foreground colours. A colour string, or a theme-colour reference object.
- borderColor
AgCssColorOrRef - Default colour for borders. A colour string, or a theme-colour reference object.
- borderWidth
PixelSize - Default width for borders.
- borderRadius
PixelSize - Default corner radius for many UI elements such as menus and dialogs.
- buttonBackgroundColor
AgCssColorOrRef - Background colour of standard action buttons. A colour string, or a theme-colour reference object.
- buttonBorder
boolean | AgBorderThemeParam - Border around standard action buttons. `true` for the default border, `false` to disable, or an object to customise it.
- buttonBorderRadius
PixelSize - Corner radius for buttons.
- buttonFontWeight
FontWeight - Font weight of standard action buttons.
- buttonTextColor
AgCssColorOrRef - Text colour of standard action buttons. A colour string, or a theme-colour reference object.
- focusShadow
CssShadow - Shadow around UI controls that have focus e.g. text inputs and buttons. The value must a valid CSS box-shadow.
- foregroundColor
AgCssColorOrRef - Default colour for neutral UI elements. Most text, borders and backgrounds are defined as a blend between the background and foreground colours. A colour string, or a theme-colour reference object.
- fontFamily
FontFamilyFull - Font family used for all text. A single family name, or an array of names used as fallbacks.
- fontSize
FontSize - Default font size used for all text. Titles and some other text are scaled to this font size.
- inputBackgroundColor
AgCssColorOrRefdefault: backgroundColor - Background colour for text inputs. A colour string, or a theme-colour reference object.
- inputBorder
boolean | AgBorderThemeParam - Border around text inputs. `true` for the default border, `false` to disable, or an object to customise it.
- inputBorderRadius
PixelSize - Corner radius for inputs.
- inputTextColor
AgCssColorOrRefdefault: textColor - Colour of text within text inputs. A colour string, or a theme-colour reference object.
- panelBackgroundColor
AgCssColorOrRef - Background colour for panels and dialogs. A colour string, or a theme-colour reference object.
- panelSubtleTextColor
AgCssColorOrRef - Colour of text that should stand out less in panels and dialogs. A colour string, or a theme-colour reference object.
- popupShadow
CssShadow - Default shadow for elements that float above the chart and are intended to appear separated from it, e.g. dialogs and menus.
- subtleTextColor
AgCssColorOrRefdefault: foregroundColor + backgroundColor - Colour of text that should stand out less than the default. A colour string, or a theme-colour reference object.
- textColor
AgCssColorOrRefdefault: foregroundColor - Default colour for all text. A colour string, or a theme-colour reference object.
- tooltipBackgroundColor
AgCssColorOrRef - Background colour for tooltips. A colour string, or a theme-colour reference object.
- tooltipBorder
boolean | AgBorderThemeParam - Border around tooltips. `true` for the default border, `false` to disable, or an object to customise it.
- tooltipBorderRadius
PixelSize - Corner radius for tooltips.
- tooltipTextColor
AgCssColorOrRef - Text colour for tooltips. A colour string, or a theme-colour reference object.
- tooltipSubtleTextColor
AgCssColorOrRef - Colour of text that should stand out less in tooltips. A colour string, or a theme-colour reference object.
- axisLineColor
- overrides
AgThemeOverrides - Configuration from this object is merged over the defaults specified in the base theme.
-
- common
AgCommonThemeableChartOptions - Common theme overrides for series.
- line
AgLineSeriesThemeOverrides - Line series theme overrides.
- scatter
AgScatterSeriesThemeOverrides - Scatter series theme overrides.
- bubble
AgBubbleSeriesThemeOverrides - Bubble series theme overrides.
- area
AgAreaSeriesThemeOverrides - Area series theme overrides.
- bar
AgBarSeriesThemeOverrides - Bar series theme overrides.
- box-plot
AgBoxPlotSeriesThemeOverrides - Box-plot series theme overrides.
- candlestick
AgCandlestickSeriesThemeOverrides - Candlestick series theme overrides.
- cone-funnel
AgConeFunnelSeriesThemeOverrides - Cone Funnel series theme overrides.
- funnel
AgFunnelSeriesThemeOverrides - Funnel series theme overrides.
- ohlc
AgOhlcSeriesThemeOverrides - ohlc series theme overrides.
- histogram
AgHistogramSeriesThemeOverrides - Histogram series theme overrides.
- heatmap
AgHeatmapSeriesThemeOverrides - Heatmap series theme overrides.
- waterfall
AgWaterfallSeriesThemeOverrides - Waterfall series theme overrides.
- range-bar
AgRangeBarSeriesThemeOverrides - Range-bar series theme overrides.
- range-area
AgRangeAreaSeriesThemeOverrides - Range-area series theme overrides.
- donut
AgDonutSeriesThemeOverrides - Donut series theme overrides.
- pie
AgPieSeriesThemeOverrides - Pie series theme overrides.
- radar-line
AgRadarLineSeriesThemeOverrides - Radar-line series theme overrides.
- radar-area
AgRadarAreaSeriesThemeOverrides - Radar-area series theme overrides.
- radial-bar
AgRadialBarSeriesThemeOverrides - Radial-bar series theme overrides.
- radial-column
AgRadialColumnSeriesThemeOverrides - Radial-column series theme overrides.
- nightingale
AgNightingaleSeriesThemeOverrides - Nightingale series theme overrides.
- map-shape
AgMapShapeSeriesThemeOverrides - Map shape series theme overrides.
- map-line
AgMapLineSeriesThemeOverrides - Map line series theme overrides.
- map-marker
AgMapMarkerSeriesThemeOverrides - Map marker series theme overrides.
- map-shape-background
AgMapShapeBackgroundThemeOverrides - Map shape background series theme overrides.
- map-line-background
AgMapLineBackgroundThemeOverrides - Map line background series theme overrides.
- organization
AgOrganizationThemeOverrides - Organization series theme overrides.
- sankey
AgSankeyThemeOverrides - Sankey series theme overrides.
- chord
AgChordThemeOverrides - Chord series theme overrides.
- pyramid
AgPyramidThemeOverrides - Pyramid series theme overrides.
- sunburst
AgSunburstSeriesThemeOverrides - Sunburst series theme overrides.
- treemap
AgTreemapSeriesThemeOverrides - Treemap series theme overrides.
- radial-gauge
AgRadialGaugeThemeOverrides - Radial gauge theme overrides.
- linear-gauge
AgLinearGaugeThemeOverrides - Linear Gauge theme overrides.
- common
AgChartTheme
This object is used to define the configuration for a custom chart theme.
- baseTheme
AgChartThemeName - The name of the theme to base your theme on. Your custom theme will inherit all the configuration from the base theme, allowing you to override just the settings you wish to change using the `overrides` config (see below).
- palette
AgChartThemePalette - The palette to use. If specified, this replaces the palette from the base theme.
-
- fills
AgColorType[] - The array of fills to be used. An array of colour strings, or fill objects for gradients, patterns, or images.
- strokes
CssColor[] - The array of strokes to be used.
- up
AgPaletteColors - Colours used for positive or upward values, such as rising prices in Financial Charts.
- down
AgPaletteColors - Colours used for negative or downward values, such as falling prices in Financial Charts.
- neutral
AgPaletteColors - Colours used for neutral values, such as unchanged prices in financial charts.
- fills
- params
AgChartThemeParams - Global parameters to set styles across the whole chart.
-
- axisLineColor
AgCssColorOrRef - Default colour for axis lines and ticks. A colour string, or a theme-colour reference object.
- chartBackgroundColor
AgCssColorOrRef - Background colour of the chart. A colour string, or a theme-colour reference object.
- chartPadding
PixelSize - The outer chart padding.
- chromeBackgroundColor
AgCssColorOrRefdefault: foregroundColor + backgroundColor - Background colour of tooltips, menus, dialogs, toolbars and buttons. A colour string, or a theme-colour reference object.
- chromeFontFamily
FontFamilyFulldefault: fontFamily - Font family used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs. A single family name, or an array of names used as fallbacks.
- chromeFontSize
FontSizedefault: fontSize - Font size used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs.
- chromeFontWeight
FontWeightdefault: fontWeight - Font weight used for text in tooltips, menus, dialogs, toolbars, buttons and text inputs.
- chromeTextColor
AgCssColorOrRefdefault: textColor - Default colour for text in tooltips, menus, dialogs, toolbars, buttons and text inputs. A colour string, or a theme-colour reference object.
- chromeSubtleTextColor
AgCssColorOrRefdefault: subtleTextColor - Colour of text that should stand out less than the default in tooltips, menus, dialogs, toolbars and buttons. A colour string, or a theme-colour reference object.
- crosshairLabelBackgroundColor
AgCssColorOrRefdefault: foregroundColor - Background colour of crosshair labels. A colour string, or a theme-colour reference object.
- crosshairLabelTextColor
AgCssColorOrRefdefault: backgroundColor - Colour for text in crosshair labels. A colour string, or a theme-colour reference object.
- fontWeight
FontWeight - Default font weight used for all text.
- gridLineColor
AgCssColorOrRef - Default colour for grid lines. A colour string, or a theme-colour reference object.
- groupedCategoryLineColor
AgCssColorOrRef - Default colour for grouped-category separation lines. A colour string, or a theme-colour reference object.
- accentColor
AgCssColorOrRef - The 'brand colour' for the chart, used wherever a non-neutral colour is required. Selections, focus outlines and checkboxes use the accent colour by default. A colour string, or a theme-colour reference object.
- backgroundColor
AgCssColorOrRef - Background colour of the chart. Most text, borders and backgrounds are defined as a blend between the background and foreground colours. A colour string, or a theme-colour reference object.
- borderColor
AgCssColorOrRef - Default colour for borders. A colour string, or a theme-colour reference object.
- borderWidth
PixelSize - Default width for borders.
- borderRadius
PixelSize - Default corner radius for many UI elements such as menus and dialogs.
- buttonBackgroundColor
AgCssColorOrRef - Background colour of standard action buttons. A colour string, or a theme-colour reference object.
- buttonBorder
boolean | AgBorderThemeParam - Border around standard action buttons. `true` for the default border, `false` to disable, or an object to customise it.
- buttonBorderRadius
PixelSize - Corner radius for buttons.
- buttonFontWeight
FontWeight - Font weight of standard action buttons.
- buttonTextColor
AgCssColorOrRef - Text colour of standard action buttons. A colour string, or a theme-colour reference object.
- focusShadow
CssShadow - Shadow around UI controls that have focus e.g. text inputs and buttons. The value must a valid CSS box-shadow.
- foregroundColor
AgCssColorOrRef - Default colour for neutral UI elements. Most text, borders and backgrounds are defined as a blend between the background and foreground colours. A colour string, or a theme-colour reference object.
- fontFamily
FontFamilyFull - Font family used for all text. A single family name, or an array of names used as fallbacks.
- fontSize
FontSize - Default font size used for all text. Titles and some other text are scaled to this font size.
- inputBackgroundColor
AgCssColorOrRefdefault: backgroundColor - Background colour for text inputs. A colour string, or a theme-colour reference object.
- inputBorder
boolean | AgBorderThemeParam - Border around text inputs. `true` for the default border, `false` to disable, or an object to customise it.
- inputBorderRadius
PixelSize - Corner radius for inputs.
- inputTextColor
AgCssColorOrRefdefault: textColor - Colour of text within text inputs. A colour string, or a theme-colour reference object.
- panelBackgroundColor
AgCssColorOrRef - Background colour for panels and dialogs. A colour string, or a theme-colour reference object.
- panelSubtleTextColor
AgCssColorOrRef - Colour of text that should stand out less in panels and dialogs. A colour string, or a theme-colour reference object.
- popupShadow
CssShadow - Default shadow for elements that float above the chart and are intended to appear separated from it, e.g. dialogs and menus.
- subtleTextColor
AgCssColorOrRefdefault: foregroundColor + backgroundColor - Colour of text that should stand out less than the default. A colour string, or a theme-colour reference object.
- textColor
AgCssColorOrRefdefault: foregroundColor - Default colour for all text. A colour string, or a theme-colour reference object.
- tooltipBackgroundColor
AgCssColorOrRef - Background colour for tooltips. A colour string, or a theme-colour reference object.
- tooltipBorder
boolean | AgBorderThemeParam - Border around tooltips. `true` for the default border, `false` to disable, or an object to customise it.
- tooltipBorderRadius
PixelSize - Corner radius for tooltips.
- tooltipTextColor
AgCssColorOrRef - Text colour for tooltips. A colour string, or a theme-colour reference object.
- tooltipSubtleTextColor
AgCssColorOrRef - Colour of text that should stand out less in tooltips. A colour string, or a theme-colour reference object.
- axisLineColor
- overrides
AgThemeOverrides - Configuration from this object is merged over the defaults specified in the base theme.
-
- common
AgCommonThemeableChartOptions - Common theme overrides for series.
- line
AgLineSeriesThemeOverrides - Line series theme overrides.
- scatter
AgScatterSeriesThemeOverrides - Scatter series theme overrides.
- bubble
AgBubbleSeriesThemeOverrides - Bubble series theme overrides.
- area
AgAreaSeriesThemeOverrides - Area series theme overrides.
- bar
AgBarSeriesThemeOverrides - Bar series theme overrides.
- box-plot
AgBoxPlotSeriesThemeOverrides - Box-plot series theme overrides.
- candlestick
AgCandlestickSeriesThemeOverrides - Candlestick series theme overrides.
- cone-funnel
AgConeFunnelSeriesThemeOverrides - Cone Funnel series theme overrides.
- funnel
AgFunnelSeriesThemeOverrides - Funnel series theme overrides.
- ohlc
AgOhlcSeriesThemeOverrides - ohlc series theme overrides.
- histogram
AgHistogramSeriesThemeOverrides - Histogram series theme overrides.
- heatmap
AgHeatmapSeriesThemeOverrides - Heatmap series theme overrides.
- waterfall
AgWaterfallSeriesThemeOverrides - Waterfall series theme overrides.
- range-bar
AgRangeBarSeriesThemeOverrides - Range-bar series theme overrides.
- range-area
AgRangeAreaSeriesThemeOverrides - Range-area series theme overrides.
- donut
AgDonutSeriesThemeOverrides - Donut series theme overrides.
- pie
AgPieSeriesThemeOverrides - Pie series theme overrides.
- radar-line
AgRadarLineSeriesThemeOverrides - Radar-line series theme overrides.
- radar-area
AgRadarAreaSeriesThemeOverrides - Radar-area series theme overrides.
- radial-bar
AgRadialBarSeriesThemeOverrides - Radial-bar series theme overrides.
- radial-column
AgRadialColumnSeriesThemeOverrides - Radial-column series theme overrides.
- nightingale
AgNightingaleSeriesThemeOverrides - Nightingale series theme overrides.
- map-shape
AgMapShapeSeriesThemeOverrides - Map shape series theme overrides.
- map-line
AgMapLineSeriesThemeOverrides - Map line series theme overrides.
- map-marker
AgMapMarkerSeriesThemeOverrides - Map marker series theme overrides.
- map-shape-background
AgMapShapeBackgroundThemeOverrides - Map shape background series theme overrides.
- map-line-background
AgMapLineBackgroundThemeOverrides - Map line background series theme overrides.
- organization
AgOrganizationThemeOverrides - Organization series theme overrides.
- sankey
AgSankeyThemeOverrides - Sankey series theme overrides.
- chord
AgChordThemeOverrides - Chord series theme overrides.
- pyramid
AgPyramidThemeOverrides - Pyramid series theme overrides.
- sunburst
AgSunburstSeriesThemeOverrides - Sunburst series theme overrides.
- treemap
AgTreemapSeriesThemeOverrides - Treemap series theme overrides.
- radial-gauge
AgRadialGaugeThemeOverrides - Radial gauge theme overrides.
- linear-gauge
AgLinearGaugeThemeOverrides - Linear Gauge theme overrides.
- common