Skip to main content

Interface: Options<TXAxisOptions, TYAxisOptions>

Type parameters​

NameType
TXAxisOptionsAxisOptions
TYAxisOptionsTXAxisOptions

Hierarchy​

Properties​

width​

• Optional width: string | number

Specify a fixed width for the chart as a string (i.e. '100px' or '50%')

Defined in​

core/types.ts:40


height​

• Optional height: string | number

Specify a fixed height for the chart as a string (i.e. '100px' or '50%')

Defined in​

core/types.ts:44


low​

• Optional low: number

Overriding the natural low of the chart allows you to zoom in or limit the charts lowest displayed value

Defined in​

core/types.ts:48


high​

• Optional high: number

Overriding the natural high of the chart allows you to zoom in or limit the charts highest displayed value

Defined in​

core/types.ts:52


referenceValue​

• Optional referenceValue: number

Unless low/high are explicitly set, bar chart will be centered at zero by default. Set referenceValue to null to auto scale.

Defined in​

core/types.ts:56


chartPadding​

• Optional chartPadding: number | Partial<ChartPadding>

Padding of the chart drawing area to the container element and labels as a number or padding object.

Defined in​

core/types.ts:60


axisX​

• Optional axisX: TXAxisOptions

Options for X-Axis

Defined in​

core/types.ts:64


axisY​

• Optional axisY: TYAxisOptions

Options for Y-Axis

Defined in​

core/types.ts:68


classNames​

• Optional classNames: Record<string, string>

Override the class names that get used to generate the SVG structure of the chart

Defined in​

core/types.ts:72


plugins​

• Optional plugins: (Plugin | [Plugin, any])[]

Defined in​

core/types.ts:74


viewBox​

• Optional viewBox: ViewBox

Define the ViewBox for an SVG, this is optional and only required if you need a scalable chart. This should be used together with responsive options to ensure a proper text size.

Defined in​

core/types.ts:78