IChartConfig

IChartConfig.anomaliespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the anomalies.

anomalies?: IAnomalies;

IChartConfig.cellImageSizingpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the image sizing in the chart.

cellImageSizing?: ChartCellImageSizing;

IChartConfig.cellTextWrappingpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the text wrapping in the chart.

cellTextWrapping?: ChartCellTextWrapping;

IChartConfig.cellVerticalAlignpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the vertical chart alignment.

cellVerticalAlign?: ChartCellVerticalAlign;

IChartConfig.chartFillproperty

Configuration of the chart fill.

chartFill?: IChartFillConfig;

IChartConfig.clusteringpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the clustering.

clustering?: IChartClusteringConfig;

IChartConfig.colorMappingproperty

Specify custom coloring.

colorMapping?: IColorMapping[];

Remarks

This is done using (predicate, color) pairs. The different entities to chart (e.g. data point, or a measure slice for particular attribute value) will be evaluated against the predicates. The color will be associated in first-found approach.

IChartConfig.colorPaletteproperty

Specify color palette to use when coloring the chart.

colorPalette?: IColorPalette;

Remarks

Note: The color palette is the primary way to specify the colors. If you specify both colorPalette and colors, then colorPalette will be used.

IChartConfig.colorsproperty

Specify list of colors (#rrggbb) to use when coloring the chart.

colors?: string[];

IChartConfig.comparisonproperty

This configuration allows users to customize how the comparative measure looks.

comparison?: IComparison;

Remarks

Note: currently, this property only supports headlines.

IChartConfig.continuousLineproperty

Configure chart continuous line.

continuousLine?: IContinuousLineConfig;

IChartConfig.customTooltippropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.

Custom tooltip configuration with Markdown content and metric/attribute references.

customTooltip?: ICustomTooltipConfig;

IChartConfig.dataLabelsproperty

Customize visibility of the data labels.

dataLabels?: IDataLabelsConfig;

Remarks

Data Labels typically appear within chart (e.g. next to a bar, inside a pie slice)

IChartConfig.dataPointsproperty

Customize visibility of the data points.

dataPoints?: IDataPointsConfig;

Remarks

Data points mark non-extrapolated data in “continuous” charts like line chart, area chart and combo chart made up of these two.

IChartConfig.disableDrillUnderlineproperty

Disable underlining of drillable items.

disableDrillUnderline?: boolean;

Remarks

Any label or text that is drillable and can be clicked is by default underlined. Set this option to true to disable underlining.

IChartConfig.distinctPointShapespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configure distinct point shapes for line-based charts.

distinctPointShapes?: IDistinctPointShapes;

IChartConfig.dualAxisproperty

This turns on dual axis support for ComboChart visualization.

dualAxis?: boolean;

Remarks

Applicable for ComboChart only. When combo chart specifies both primary and secondary measures, it is by default treated as dual-axis chart. Both primary and secondary axis will be visible.

To turn the secondary axis off for ComboChart, set dualAxis: false

IChartConfig.enableAccessibleTooltipproperty

Enables accessible tooltip for the chart.

enableAccessibleTooltip?: boolean;

IChartConfig.enableChartSortingproperty

Enables custom sorting of visualizations.

enableChartSorting?: boolean;

Remarks

Note: this property might not be supported in all the visualizations.

IChartConfig.enableCompactSizeproperty

Enables more compact rendering of visualization in small containers.

enableCompactSize?: boolean;

Remarks

Note: this property might not be supported in all the visualizations.

IChartConfig.enableContrastSafeDerivedColorsproperty

Keeps colors derived for comparison (period-over-period) measures at the WCAG 1.4.11 minimum 3:1 contrast ratio against the chart background.

enableContrastSafeDerivedColors?: boolean;

Remarks

When the standard derivation would produce a color too close to the background, the closest compliant blend in the same direction is used instead, and when no such blend exists the search continues in the opposite direction. Candidates keep a minimum distance from the master measure color so the two series stay distinguishable. If no candidate meets the ratio (for example on a mid-gray background), the standard color is kept.

IChartConfig.enableDonutDataLabelsproperty

Enables the new pie/donut data label styles (inside/outside) and adaptive auto mode. When off, only the legacy auto/backplate styles are available.

enableDonutDataLabels?: boolean;

IChartConfig.enableJoinedAttributeAxisNameproperty

Enable attribute axis name for the column, bar and bullet charts when view by many attributes.

enableJoinedAttributeAxisName?: boolean;

IChartConfig.enableReversedStackingproperty

Enables change order of stacked items in bar chart.

enableReversedStacking?: boolean;

IChartConfig.enableSeparateTotalLabelsproperty

enableSeparateTotalLabels?: boolean;

IChartConfig.enableSingleBubbleSeriespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Enables single series mode for bubble charts.

enableSingleBubbleSeries?: boolean;

Remarks

When enabled, all data points will be rendered as a single series instead of multiple series. This can be useful for performance optimization with large datasets or when all bubbles should be treated as a unified dataset.

Default: false (multiple series mode)

IChartConfig.forceDisableDrillOnAxesproperty

Disables drilling by clicking on axis labels.

forceDisableDrillOnAxes?: boolean;

Remarks

When drilling is configured for a chart, users can click either the charted entities (data points, bars, columns etc) or labels on the axes. This setting an be used to disable clicks on the drillable labels on axes.

IChartConfig.forecastpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the forecast.

forecast?: IForecast;

IChartConfig.gridproperty

Configure chart grid.

grid?: IGridConfig;

IChartConfig.hyperLinkspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration specific for hyperlinks in the chart.

hyperLinks?: IDisplayFormHyperlinksConfig;

IChartConfig.inlineVisualizationspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of the inline visualizations.

inlineVisualizations?: IInlineVisualizationsConfig;

IChartConfig.legendproperty

Configure how legend appears and behaves.

legend?: ILegendConfig;

IChartConfig.legendLayoutproperty

Configure whether legend items should be laid-out vertically (column legend) or horizontally (line legend).

legendLayout?: "vertical" | "horizontal";

IChartConfig.lineShapepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Controls what shape a line should have with regards to data points (i.e. line interpolation).

lineShape?: LineShape;

Remarks

Only applicable to line, combo and area charts.

IChartConfig.lineStyleMappingpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Per-series line style and weight configuration for line-based charts.

lineStyleMapping?: ILineStyleMappingItem[];

Remarks

Each entry maps a series to a specific line style and/or weight. A series is identified by its measure local identifier or, when the chart is segmented or stacked by an attribute, by the URI of the attribute element. Only applicable to line, area, and combo chart line and area series.

IChartConfig.primaryChartTypeproperty

Sets the chart type for primary measures.

primaryChartType?: "line" | "column" | "area";

Remarks

Applicable for ComboChart only. Specify type of chart to use for primary measures.

IChartConfig.radarGridLineShapepropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Controls the shape of the grid lines on the radial axis of a radar chart.

radarGridLineShape?: "polygon" | "circle";

Remarks

• “polygon”: spider web / angular grid lines (default) - “circle”: concentric circular grid lines

Default: “polygon”

IChartConfig.radarRenderAspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Controls whether the radar chart is rendered as filled polygons (“filled”) or bare polygon outlines (“outline”).

radarRenderAs?: "outline" | "filled";

Remarks

• “filled”: uses Highcharts area type in polar mode with semi-transparent fill (default) - “outline”: uses Highcharts line type in polar mode with no fill

Default: “filled”

IChartConfig.respectLegendPositionproperty

Legend positioning is not respected in some contexts. This flag enforces the specific legend position to be respected in all contexts.

respectLegendPosition?: boolean;

IChartConfig.rowHeightpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Configuration of row height of the chart.

rowHeight?: ChartRowHeight;

IChartConfig.secondary_xaxisproperty

Customize visibility of the secondary X axis, what should be on the secondary X axis and how it should look like.

secondary_xaxis?: IAxisConfig;

IChartConfig.secondary_yaxisproperty

Customize visibility of the secondary Y axis, what should be on the secondary Y axis and how it should look like.

secondary_yaxis?: IAxisConfig;

IChartConfig.secondaryChartTypeproperty

Sets the chart type for secondary measures.

secondaryChartType?: "line" | "column" | "area";

Remarks

Applicable for ComboChart only. Specify type of chart to use for secondary measures.

IChartConfig.separatorsproperty

Customize what separators to use between different segments of formatted numbers (thousands, decimals etc).

separators?: ISeparators;

IChartConfig.sortByproperty

Sort items to apply on the client where the backend cannot.

sortBy?: ISortItem[];

Remarks

Used by the stacked Mekko chart to order its columns by a single measure: such a measure sort is not expressible in the execution (it would target the stack dimension), so it is kept out of the execution and the chart reorders the columns from this config instead. Other chart types ignore this property.

IChartConfig.stackMeasuresproperty

Applicable for Area, Bar, Column and Combo charts which have more than one measure.

stackMeasures?: boolean;

Remarks

For Area chart, this is on by default. If disables, the areas will overall. For Bar and Column charts, this is off by default and each measure has its own bar or column. For Combo, only measures assigned to the left (primary) axis will be stacked.

IChartConfig.stackMeasuresToPercentproperty

This turns on measure stacking and client-side calculation of percentage contribution.

stackMeasuresToPercent?: boolean;

Remarks

Applicable for Area, Bar, Column and Combo charts which have more than one measure.

This option has preference over the stackMeasures option.

IChartConfig.supportsChartFillproperty

Whether the chart supports configurable chart fill.

supportsChartFill?: boolean;

IChartConfig.thresholdExcludedMeasuresproperty

Local identifier of measures that should not be affected by thresholdMeasures config.

thresholdExcludedMeasures?: string[];

IChartConfig.thresholdMeasuresproperty

Local identifier of measures that are used to render thresholds in the line and combo chart. Currently only the one threshold measure is supported.

thresholdMeasures?: string[];

IChartConfig.tooltipproperty

Customize the chart tooltip.

tooltip?: ITooltipConfig;

IChartConfig.totalproperty

Configure for the total column of Waterfall chart.

total?: ITotalConfig;

IChartConfig.xaxisproperty

Customize visibility of the primary X axis, what should be on the primary X axis and how it should look like.

xaxis?: IAxisConfig;

IChartConfig.xFormatproperty

Customize format string to use for numeric tics on the X axis.

xFormat?: string;

IChartConfig.xLabelproperty

Customize name of the x axis

xLabel?: string;

IChartConfig.yaxisproperty

Customize visibility of the primary Y axis, what should be on the primary Y axis and how it should look like.

yaxis?: IAxisConfig;

IChartConfig.yFormatproperty

Customize format string to use for numeric tics on the Y axis.

yFormat?: string;

Remarks

The format string conventions are exact same as when formatting measure values.

IChartConfig.yLabelproperty

Customize name of the y axis

yLabel?: string;

IChartConfig.zoomInsightproperty

Allow zooming and panning in a chart.

zoomInsight?: boolean;

Remarks

When this option is enabled, we will prepare some configs for the ‘chart’ option to allow the chart can be zooming/panning.