IChartConfig
Home > @gooddata/sdk-ui-charts > IChartConfig
IChartConfig interface
Chart config is used to customize visual aspects of the different charts.
Signature:
export interface IChartConfig
Remarks
At the moment, a single structure is used for all the charts - however not all options are applicable to all charts.
As is, using the not-applicable option for a chart will be ignored. Going forward, we will add warnings to notify developers that the option has no effect.
Note: some properties of the chart config leak unnecessary implementation detail and should not be used. These properties are marked as internal.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| cellImageSizing? | ChartCellImageSizing | (BETA) (Optional) Configuration of the image sizing in the chart. | |
| cellTextWrapping? | ChartCellTextWrapping | (BETA) (Optional) Configuration of the text wrapping in the chart. | |
| cellVerticalAlign? | ChartCellVerticalAlign | (BETA) (Optional) Configuration of the vertical chart alignment. | |
| clustering? | IChartClusteringConfig | (BETA) (Optional) Configuration of the clustering. | |
| colorMapping? | IColorMapping[] | (Optional) Specify custom coloring. | |
| colorPalette? | IColorPalette | (Optional) Specify color palette to use when coloring the chart. | |
| colors? | string[] | (Optional) Specify list of colors (#rrggbb) to use when coloring the chart. | |
| comparison? | IComparison | (Optional) This configuration allows users to customize how the comparative measure looks. | |
| continuousLine? | IContinuousLineConfig | (Optional) Configure chart continuous line. | |
| dataLabels? | IDataLabelsConfig | (Optional) Customize visibility of the data labels. | |
| dataPoints? | IDataPointsConfig | (Optional) Customize visibility of the data points. | |
| disableDrillUnderline? | boolean | (Optional) Disable underlining of drillable items. | |
| dualAxis? | boolean | (Optional) This turns on dual axis support for ComboChart visualization. | |
| enableChartSorting? | boolean | (Optional) Enables custom sorting of visualizations. | |
| enableCompactSize? | boolean | (Optional) Enables more compact rendering of visualization in small containers. | |
| enableJoinedAttributeAxisName? | boolean | (Optional) Enable attribute axis name for the column, bar and bullet charts when view by many attributes. | |
| enableReversedStacking? | boolean | (Optional) Enables change order of stacked items in bar chart. | |
| enableSeparateTotalLabels? | boolean | (Optional) | |
| forceDisableDrillOnAxes? | boolean | (Optional) Disables drilling by clicking on axis labels. | |
| forecast? | IForecast | (BETA) (Optional) Configuration of the forecast. | |
| grid? | IGridConfig | (Optional) Configure chart grid. | |
| hyperLinks? | IDisplayFormHyperlinksConfig | (BETA) (Optional) Configuration specific for hyperlinks in the chart. | |
| inlineVisualizations? | IInlineVisualizationsConfig | (BETA) (Optional) Configuration of the inline visualizations. | |
| legend? | ILegendConfig | (Optional) Configure how legend appears and behaves. | |
| legendLayout? | "vertical" | "horizontal" | (Optional) Configure whether legend items should be laid-out vertically (column legend) or horizontally (line legend). | |
| primaryChartType? | "line" | "column" | "area" | (Optional) Sets the chart type for primary measures. | |
| respectLegendPosition? | boolean | (Optional) Legend positioning is not respected in some contexts. This flag enforces the specific legend position to be respected in all contexts. | |
| rowHeight? | ChartRowHeight | (BETA) (Optional) Configuration of row height of the chart. | |
| secondary_xaxis? | IAxisConfig | (Optional) Customize visibility of the secondary X axis, what should be on the secondary X axis and how it should look like. | |
| secondary_yaxis? | IAxisConfig | (Optional) Customize visibility of the secondary Y axis, what should be on the secondary Y axis and how it should look like. | |
| secondaryChartType? | "line" | "column" | "area" | (Optional) Sets the chart type for secondary measures. | |
| separators? | ISeparators | (Optional) Customize what separators to use between different segments of formatted numbers (thousands, decimals etc). | |
| stackMeasures? | boolean | (Optional) Applicable for Area, Bar, Column and Combo charts which have more than one measure. | |
| stackMeasuresToPercent? | boolean | (Optional) This turns on measure stacking and client-side calculation of percentage contribution. | |
| thresholdExcludedMeasures? | string[] | (Optional) Local identifier of measures that should not be affected by thresholdMeasures config. | |
| thresholdMeasures? | string[] | (Optional) Local identifier of measures that are used to render thresholds in the line and combo chart. Currently only the one threshold measure is supported. Requires enableLineChartTrendThreshold to be true to be applied. | |
| total? | ITotalConfig | (Optional) Configure for the total column of Waterfall chart. | |
| xaxis? | IAxisConfig | (Optional) Customize visibility of the primary X axis, what should be on the primary X axis and how it should look like. | |
| xFormat? | string | (Optional) Customize format string to use for numeric tics on the X axis. | |
| xLabel? | string | (Optional) Customize name of the x axis | |
| yaxis? | IAxisConfig | (Optional) Customize visibility of the primary Y axis, what should be on the primary Y axis and how it should look like. | |
| yFormat? | string | (Optional) Customize format string to use for numeric tics on the Y axis. | |
| yLabel? | string | (Optional) Customize name of the y axis | |
| zoomInsight? | boolean | (Optional) Allow zooming and panning in a chart. |