chartjs-plugin-hierarchical

Appearance

chartjs-plugin-hierarchical v4.4.0 / IHierarchicalScaleOptions

Interface: IHierarchicalScaleOptions ​

Extends ​

  • CategoryScaleOptions

Properties ​

attributes ​

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

Default ​

ts
{}

Index signature ​

[attribute: string]: any

Source ​

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

hierarchyBoxColor ​

hierarchyBoxColor: string

color of the box to toggle collapse/expand

Source ​

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

hierarchyBoxLineHeight ​

hierarchyBoxLineHeight: number

distance between two hierarchy indicators

Source ​

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

hierarchyBoxSize ​

hierarchyBoxSize: number

size of the box to draw

Source ​

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

hierarchyBoxWidth ​

hierarchyBoxWidth: number

stroke width of the toggle box

Source ​

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

hierarchyGroupLabelPosition ​

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

Source ​

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

hierarchyLabelPosition ​

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

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

Default ​

ts
'below'

Source ​

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

hierarchySpanColor ​

hierarchySpanColor: string

color of the line indicator hierarchy children

Source ​

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

hierarchySpanWidth ​

hierarchySpanWidth: number

stroke width of the line

Source ​

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

levelPercentage ​

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

Source ​

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

offset ​

offset: true

Overrides ​

CategoryScaleOptions.offset

Source ​

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

padding ​

padding: number

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

Default ​

ts
25

Source ​

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

reverseOrder ​

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

Source ​

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

static ​

static: boolean

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

Default ​

ts
false

Source ​

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