chartjs-plugin-hierarchical

Appearance

chartjs-plugin-hierarchical v4.4.4 / 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

Index Signature ​

[attribute: string]: any

Default ​

ts
{}

Defined in ​

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

hierarchyBoxColor ​

hierarchyBoxColor: string

color of the box to toggle collapse/expand

Defined in ​

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

hierarchyBoxLineHeight ​

hierarchyBoxLineHeight: number

distance between two hierarchy indicators

Defined in ​

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

hierarchyBoxSize ​

hierarchyBoxSize: number

size of the box to draw

Defined in ​

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

hierarchyBoxWidth ​

hierarchyBoxWidth: number

stroke width of the toggle box

Defined in ​

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

Defined in ​

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'

Defined in ​

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

hierarchySpanColor ​

hierarchySpanColor: string

color of the line indicator hierarchy children

Defined in ​

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

hierarchySpanWidth ​

hierarchySpanWidth: number

stroke width of the line

Defined in ​

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

Defined in ​

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

offset ​

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

Overrides ​

CategoryScaleOptions.offset

Defined in ​

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

Defined in ​

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

Defined in ​

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

Defined in ​

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