Skip to main content

ScatterChartOptions

Options for a Scatter chart

Extends

Properties

axisFont?

optional axisFont: FontSpec

Spec for the font to use for all text on the axes.

Inherited from

DualValueChartOptions.axisFont


axisLineSize?

optional axisLineSize: number

The width to use if showing a line marking value/category axes. By default, axis lines are not painted.

Inherited from

DualValueChartOptions.axisLineSize


colorGenerator?

optional colorGenerator: ColorGenerator

Optional function to call in order to establish the color to be used for each series

Inherited from

DualValueChartOptions.colorGenerator


cornerRadius?

optional cornerRadius: number

When rounding bar/column corners, use this radius. Defaults to 5 pixels.

Inherited from

DualValueChartOptions.cornerRadius


data?

optional data: ObjectData[]

Optional data to load into the chart.

Inherited from

DualValueChartOptions.data


dataSource?

optional dataSource: 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

DualValueChartOptions.dataSource


dataSourceFilter?

optional dataSourceFilter: ChartModelFilter

When you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.

Inherited from

DualValueChartOptions.dataSourceFilter


defaultColor?

optional defaultColor: string

Optional color to use for every series. Overrides any colorGenerator.

Inherited from

DualValueChartOptions.defaultColor


emptyMessage?

optional emptyMessage: string

Message to display when the chart has no data. Defaults to "No data".

Inherited from

DualValueChartOptions.emptyMessage


grouped?

optional grouped: boolean

If true, the data will be grouped, if the chart type supports it (eg Bar/Column).

Inherited from

DualValueChartOptions.grouped


groupField?

optional groupField: string

The name of the field that identifies which group a data point belongs to. Defaults to group.

Inherited from

DualValueChartOptions.groupField


height?

optional height: number

Height for the chart. If omitted, height is computed from the width of the chart's container

Inherited from

DualValueChartOptions.height


legend?

optional legend: boolean | LegendSpec

Either a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.

Inherited from

DualValueChartOptions.legend


legendPadding?

optional legendPadding: number

When the legend is not floating, this number defines how much whitespace to leave around it.

Inherited from

DualValueChartOptions.legendPadding


maximumMarkerSize?

optional maximumMarkerSize: number

Maximum allowed size for a marker. Defaults to 50 pixels. Set to Infinity to have no maximum (this can have unpleasant UI side effects with some datasets)

Inherited from

DualValueChartOptions.maximumMarkerSize


maxLabelSize?

optional maxLabelSize: 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

DualValueChartOptions.maxLabelSize


minimumMarkerSize?

optional minimumMarkerSize: number

Minimum allowed size for a marker. Defaults to 8 pixels. Set to -Infinity to have no minimum (this can have unpleasant UI side effects with some datasets)

Inherited from

DualValueChartOptions.minimumMarkerSize


resizeObserver?

optional resizeObserver: boolean

Defaults to true, meaning the chart will redraw when its container element resizes.

Inherited from

DualValueChartOptions.resizeObserver


roundCorners?

optional roundCorners: boolean

Whether or not to round the corners of bars/columns. Defaults to true

Inherited from

DualValueChartOptions.roundCorners


series

series: DualValueSeriesOptions[]

Definition of the chart series' to display. You can plot multiple series on a chart.

Inherited from

DualValueChartOptions.series


style?

optional style: ChartStyleOptions

Styles for legend and grid.

Inherited from

DualValueChartOptions.style


subtitle?

optional subtitle: SubtitleSpec

Subtitle for the chart.

Inherited from

DualValueChartOptions.subtitle


title?

optional title: ChartTitleSpec

Title for the chart.

Inherited from

DualValueChartOptions.title


titlePadding?

optional titlePadding: number

Padding to leave underneath the title

Inherited from

DualValueChartOptions.titlePadding


tooltip?

optional tooltip: TooltipOptions

Options for the info tooltip.

Inherited from

DualValueChartOptions.tooltip


url?

optional url: string

Optional URL from which to retrieve data to load into the chart

Inherited from

DualValueChartOptions.url


width?

optional width: number

Width for the chart. If omitted, width is computed from the width of the chart's container

Inherited from

DualValueChartOptions.width


xAxis?

optional xAxis: ValueAxisDefinition

Configuration for the X axis.

Inherited from

DualValueChartOptions.xAxis


yAxis?

optional yAxis: ValueAxisDefinition

Configuration for the Y axis.

Inherited from

DualValueChartOptions.yAxis


yAxisPadding?

optional yAxisPadding: number

How much padding to leave between the y axes decoration and the chart content area.

Inherited from

DualValueChartOptions.yAxisPadding


zoom?

optional zoom: object

Optional zoom configuration.

enabled?

optional enabled: boolean

Whether or not zoom is enabled.

initialValue?

optional initialValue: number

Initial zoom value. Defaults to 1.

range?

optional range: [number, number]

Zoom range to support. Defaults to [0.05, 3]

Inherited from

DualValueChartOptions.zoom