IRootSettings

Type interface

Inheritance

IRootSettings does not extend any other symbol.

IRootSettings is not extended by any other symbol.

Properties

accessible
#

Type undefined | false | true

Default true

Set to false to disable all accessibility features.

NOTE: once disabled, accessibility cannot be re-enabled on a live Root object.

@since 5.3.0

ariaLabel
#

Type undefined | string

If set to some string, it will be used as inner <div> ARIA-LABEL.

Should be used in conjuction with focusable.

@since 5.3.17
Click here for more info

calculateSize
#

Type undefined | ( dimensions: DOMRect) => ISize

Allows for specifying a custom width / height for the chart.

This function will be called automatically when the chart is resized.

focusPadding
#

Type undefined | number

Default 2

Distance between focused element and its highlight square in pixels.

@since 5.6.0

focusable
#

Type undefined | false | true

Default false

If set to true, the parent inner <div> element will become a focusable element.

@since 5.3.17
Click here for more info

role
#

Type undefined | string

Allows setting a "role" for the inner <div>.

@since 5.3.17
Click here for more info

tooltipContainerBounds
#

Type undefined | { bottom: number,
  left: number,
  right: number,
  top: number }

Allows defining margins around chart area for tooltips to go outside the chart itself.

@since 5.2.24

useSafeResolution
#

Type undefined | false | true

Default true

Indicates whether chart should use "safe" resolution on some memory-limiting platforms such as Safari.