RadialChartConfig

interface RadialChartConfig<P extends RenderParams>

A simple interface that defines the parameters that initialize a RadialChart

Type parameters

  • P: RenderParams

Properties

axisType

axisType: undefined | Bottom | Top

This controls whether or not the Chart will render a horizontal axis.

debugShading

debugShading: undefined | boolean

If this is set to true, the pad and viewport will be shaded so that they are visible in the browser.

divHeight

divHeight: undefined | string | number

The height in pixels of the Chart’s containing div.

divMargin

divMargin: undefined | number

The CSS margin property for the Chart’s div.

divOutline

divOutline: undefined | string

The CSS outline property for the Chart’s div.

divOverflowX

divOverflowX: undefined | string

The CSS overflow-x setting of the Chart’s containing div.

divOverflowY

divOverflowY: undefined | string

The CSS overflow-y setting of the Chart’s containing div.

divWidth

divWidth: undefined | string | number

The width in pixels of the Chart’s containing div.

domainConstraint

domainConstraint: undefined | (chart: Chart <P>): None

This constrains the Chart’s domain, which in turn constrains both zoom level and panning. The parameter is a callback function that is evaluated after each zoom event to produce an interval that constrains the domain.

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.

leftPadSize

leftPadSize: undefined | number

The number of pixels of padding on the left side of the Chart.

lowerPadSize

lowerPadSize: undefined | number

The number of pixels of padding on the bottom of the Chart.

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.

postResize

postResize: undefined | (): void

The callback function that the Chart executes after resize() is called.

postZoom

postZoom: undefined | (): void

The callback function that the Chart executes after zoom() is called.

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.

rightPadSize

rightPadSize: undefined | number

The number of pixels of padding on the right side of the Chart.

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.

selector

selector: undefined | string

A string that can be used to uniquely select the target DOM container.

trackHeight

trackHeight: undefined | number

The “height” of the radial track on which annotations will be rendered. Conceptually, this is equal to to the difference of the radii of two concentric circles that define an annulus.

upperPadSize

upperPadSize: undefined | number

The number of pixels of padding on the top of the Chart.

zoomConstraint

zoomConstraint: undefined | None

A Chart’s contents are scaled by a scaling factor k. If a zoomConstraint of the form [min_k, max_k] is provided, the scaling factor will be constrained to that interval. This will not constrain panning.

zoomable

zoomable: undefined | boolean

This controls whether or not the Chart will be configured to allow zooming and panning.