chartjs-plugin-hierarchical

Appearance

chartjs-plugin-hierarchical v4.4.4 / HierarchicalScaleType

Interface: HierarchicalScaleType ​

Extends ​

Properties ​

attributes? ​

optional attributes: object

object of attributes that should be managed and extracted from the tree data structures such as backgroundColor for coloring individual bars the object contains the key and default value

Index Signature ​

[attribute: string]: any

Default ​

ts
{}

Inherited from ​

Partial.attributes

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:66

hierarchyBoxColor? ​

optional hierarchyBoxColor: string

color of the box to toggle collapse/expand

Inherited from ​

Partial.hierarchyBoxColor

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:54

hierarchyBoxLineHeight? ​

optional hierarchyBoxLineHeight: number

distance between two hierarchy indicators

Inherited from ​

Partial.hierarchyBoxLineHeight

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:42

hierarchyBoxSize? ​

optional hierarchyBoxSize: number

size of the box to draw

Inherited from ​

Partial.hierarchyBoxSize

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:38

hierarchyBoxWidth? ​

optional hierarchyBoxWidth: number

stroke width of the toggle box

Inherited from ​

Partial.hierarchyBoxWidth

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:58

hierarchyGroupLabelPosition? ​

optional hierarchyGroupLabelPosition: "center" | "first" | "last" | "between-first-and-second"

position of the hierarchy group label relative to the its children

Default ​

ts
between-first-and-second

Inherited from ​

Partial.hierarchyGroupLabelPosition

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:28

hierarchyLabelPosition? ​

optional hierarchyLabelPosition: null | "none" | "below" | "above"

position of the hierarchy label in expanded levels, 'none' to disable

Default ​

ts
'below'

Inherited from ​

Partial.hierarchyLabelPosition

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:22

hierarchySpanColor? ​

optional hierarchySpanColor: string

color of the line indicator hierarchy children

Inherited from ​

Partial.hierarchySpanColor

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:46

hierarchySpanWidth? ​

optional hierarchySpanWidth: number

stroke width of the line

Inherited from ​

Partial.hierarchySpanWidth

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:50

levelPercentage? ​

optional levelPercentage: number

ratio by which the distance between two elements shrinks the higher the level of the tree is. i.e. two two level bars have a distance of 1. two nested one just 0.75

Default ​

ts
0.75

Inherited from ​

Partial.levelPercentage

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:12

offset? ​

optional offset: true

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.

Default ​

ts
false

Inherited from ​

Partial.offset

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:68

padding? ​

optional padding: number

padding of the first collapse to the start of the x-axis

Default ​

ts
25

Inherited from ​

Partial.padding

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:17

reverseOrder? ​

optional reverseOrder: boolean

if reverseOrder is true the lowest hierarchy level is on axis level and the highest level is the one furthest from axis

Default ​

ts
false

Inherited from ​

Partial.reverseOrder

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:73

static? ​

optional static: boolean

whether interactive buttons should be shown or whether it should be static

Default ​

ts
false

Inherited from ​

Partial.static

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:34

type ​

type: "hierarchical"

Defined in ​

work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:296