ChartConfig
interface ChartConfig<P extends RenderParams>
This describes the parameters for configuring and initializing a Chart.
Type parameters
P: RenderParams
Properties
axis
axis: undefined | boolean
This controls whether or not the Chart will render a horizontal axis.
height
height: undefined | number
The height in pixels of the Chart’s viewport.
id
id: undefined | string
A unique identifier for the Chart. This will be generated automatically if one isn’t provided.
inRender
inRender: undefined | (params: P): void
The second rendering callback function.
padSize
padSize: undefined | number
The number of pixels of padding around each edge of the Chart.
postRender
postRender: undefined | (params: P): void
The final rendering callback function.
preRender
preRender: undefined | (params: P): void
The first rendering callback function.
resizable
resizable: undefined | boolean
This controls whether or not the Chart will automatically resize itself as it’s container changes size. This will cause the Chart to ignore explicit height/width arguments in the config.
rowCount
rowCount: undefined | number
The number of rows that will be rendered.
rowHeight
rowHeight: undefined | number
The height in pixels of a horizontal row in the Chart. This defaults to a value of 10.
rowStripes
rowStripes: undefined | boolean
This controls whether or not the rows will be colored in an alternating pattern.
scaleExtent
scaleExtent: undefined | None
A range of floats that constrains the zoom level.
selector
selector: undefined | string
A string that can be used to uniquely select the target DOM container.
translateExtent
translateExtent: undefined | (c: Chart <P>): None
A callback function that provides a set of ranges that constrains the horizontal translation of the Chart.
width
width: undefined | number
The height in pixels of the Chart’s viewport.
zoomable
zoomable: undefined | boolean
This controls whether or not the Chart will be configured to allow zooming and panning.