ColumnChartOptions
Options for a column chart.
Extends
Omit<CategoryValueChartOptions,"plots">
Properties
axisLineSize?
optionalaxisLineSize:number
The width to use if showing a line marking value/category axes. By default, axis lines are not painted.
Inherited from
ScatterChartOptions.axisLineSize
categoryAxis?
optionalcategoryAxis:CategoryAxisDefinition|CategoryAxisDefinition[]
Definitions of one or more category axes.
Inherited from
Omit.categoryAxis
colorGenerator?
optionalcolorGenerator:ColorGenerator
Optional function to call in order to establish the color to be used for each series
Inherited from
BaseChartOptions.colorGenerator
cornerRadius?
optionalcornerRadius:number
When rounding bar/column corners, use this radius. Defaults to 5 pixels.
Inherited from
ScatterChartOptions.cornerRadius
data?
optionaldata:ObjectData[]
Optional data to load into the chart.
Inherited from
dataLabels?
optionaldataLabels:DataLabelsOptions
Options for data labels
dataSource?
optionaldataSource:DataSource
Optional data source (of type DataSource, meaning both VisuallyJsModel and Selection are supported) from which to retrieve data to load into the chart.
Inherited from
dataSourceFilter?
optionaldataSourceFilter:ChartModelFilter
When you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.
Inherited from
BaseChartOptions.dataSourceFilter
defaultColor?
optionaldefaultColor:string
Optional color to use for every series. Overrides any colorGenerator.
Inherited from
emptyMessage?
optionalemptyMessage:string
Message to display when the chart has no data. Defaults to "No data".
Inherited from
grouped?
optionalgrouped:boolean
Whether to group multiple stacks side-by-side within a single category.
Overrides
groupField?
optionalgroupField:string
The field in the data objects used to identify the stack/group.
Overrides
ScatterChartOptions.groupField
height?
optionalheight:number
Height for the chart. If omitted, height is computed from the width of the chart's container
Inherited from
inverted?
optionalinverted:boolean
Defaults 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.
Inherited from
Omit.inverted
legend?
optionallegend:boolean|LegendSpec
Either a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.
Inherited from
legendPadding?
optionallegendPadding:number
When the legend is not floating, this number defines how much whitespace to leave around it.
Inherited from
ScatterChartOptions.legendPadding
maxLabelSize?
optionalmaxLabelSize:number
The 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.
Inherited from
ScatterChartOptions.maxLabelSize
pivot?
optionalpivot:boolean
Pivot the data so that the series definitions become the categories, and the series data is derived from the individual data points. Default to false.
Inherited from
Omit.pivot
resizeObserver?
optionalresizeObserver:boolean
Defaults to true, meaning the chart will redraw when its container element resizes.
Inherited from
BaseChartOptions.resizeObserver
roundCorners?
optionalroundCorners:boolean
Whether or not to round the corners of bars/columns. Defaults to true
Inherited from
ScatterChartOptions.roundCorners
series
series: (
RecordBasedSeriesOptions|ArrayBasedSeriesOptions)[]
Definition of the chart series' to display. You can display multiple series on a chart.
Inherited from
Omit.series
stacked?
optionalstacked:boolean|"percent"|"default"
Whether to stack series values next to each other, optionally as a percentage stack (which takes up the available space and shows each component proportionally)
style?
optionalstyle:ChartStyleOptions
Styles for legend and grid.
Inherited from
subtitle?
optionalsubtitle:SubtitleSpec
Subtitle for the chart.
Inherited from
title?
optionaltitle:ChartTitleSpec
Title for the chart.
Inherited from
titlePadding?
optionaltitlePadding:number
Padding to leave underneath the title
Inherited from
tooltip?
optionaltooltip:TooltipOptions
Options for the info tooltip.
Inherited from
url?
optionalurl:string
Optional URL from which to retrieve data to load into the chart
Inherited from
valueAxis?
optionalvalueAxis:ValueAxisDefinition|ValueAxisDefinition[]
Definition of one or more value axes.
Inherited from
Omit.valueAxis
width?
optionalwidth:number
Width for the chart. If omitted, width is computed from the width of the chart's container
Inherited from
yAxisPadding?
optionalyAxisPadding:number
How much padding to leave between the y axes decoration and the chart content area.
Inherited from
ScatterChartOptions.yAxisPadding
zoom?
optionalzoom:object
Optional zoom configuration.
enabled?
optionalenabled:boolean
Whether or not zoom is enabled.
initialValue?
optionalinitialValue:number
Initial zoom value. Defaults to 1.
range?
optionalrange: [number,number]
Zoom range to support. Defaults to [0.05, 3]