Skip to main content
AreaChartOptions
Options for an area chart
NameTypeDescription
axisLineSize?numberThe width to use if showing a line marking value/category axes. By default, axis lines are not painted.
categoryAxis?CategoryAxisDefinition | Array<CategoryAxisDefinition>Definitions of one or more category axes.
colorGenerator?ColorGeneratorOptional function to call in order to establish the color to be used for each series
cornerRadius?numberWhen rounding bar/column corners, use this radius. Defaults to 5 pixels.
data?Array<ObjectData>Optional data to load into the chart.
dataSource?DataSourceOptional data source (of type DataSource, meaning both VisuallyJsModel and Selection are supported) from which to retrieve data to load into the chart.
dataSourceFilter?ChartModelFilterWhen you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.
defaultColor?stringOptional color to use for every series. Overrides any colorGenerator.
emptyMessage?stringMessage to display when the chart has no data. Defaults to "No data".
grouped?booleanIf true, the data will be grouped, if the chart type supports it (eg Bar/Column).
groupField?stringThe name of the field that identifies which group a data point belongs to. Defaults to group.
height?numberHeight for the chart. If omitted, height is computed from the width of the chart's container
inverted?booleanDefaults to false, meaning the Y axis is the category axis and the X axis is the value axis, such as you'd use for a bar chart. Changing this to true makes the Y axis the value axis and the X axis the category axis, such as you'd use for a column chart. Note, though, that this flag is also honoured by other plot types such as line and area.
legend?boolean | LegendSpecEither a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.
legendPadding?numberWhen the legend is not floating, this number defines how much whitespace to leave around it.
maxLabelSize?numberThe maximum size a category label can be as a ratio of the chart's overall size. Category labels are rotated to 45 degrees automatically when they start to overlap each other, but if the labels are long strings then there is a chance they'll use up too much of the available chart space. This value (whose default is 0.2), specifies a hard limit for label size, to avoid that situation. In a chart whose category axis is the X axis, this is applied relative to the height of the chart, and in a chart whose category axis is the Y axis, it's applied relative to the width.
pivot?booleanPivot the data so that the series definitions become the categories, and the series data is derived from the individual data points. Default to false.
plotOptions?AreaPlotOptionsOptions for the area plot.
resizeObserver?booleanDefaults to true, meaning the chart will redraw when its container element resizes.
roundCorners?booleanWhether or not to round the corners of bars/columns. Defaults to true
seriesArray<RecordBasedSeriesOptions | ArrayBasedSeriesOptions>Definition of the chart series' to display. You can display multiple series on a chart.
spline?booleanIf true, draw the line as a series of bezier splines, which makes for a smooth line. Defaults to false.
style?ChartStyleOptionsStyles for legend and grid.
subtitle?SubtitleSpecSubtitle for the chart.
title?ChartTitleSpecTitle for the chart.
titlePadding?numberPadding to leave underneath the title
tooltip?TooltipOptionsOptions for the info tooltip.
url?stringOptional URL from which to retrieve data to load into the chart
valueAxis?ValueAxisDefinition | Array<ValueAxisDefinition>Definition of one or more value axes.
width?numberWidth for the chart. If omitted, width is computed from the width of the chart's container
yAxisPadding?numberHow much padding to leave between the y axes decoration and the chart content area.
zoom?{
  enabled:boolean,
  initialValue:number,
  range:[number, number]
}
Optional zoom configuration.