chartjs-plugin-hierarchical

Appearance

chartjs-plugin-hierarchical / IHierarchicalScaleOptions

Interface: IHierarchicalScaleOptions ​

Defined in: work/chartjs-plugin-hierarchical/chartjs-plugin-hierarchical/src/scale/hierarchical.ts:7

Extends ​

  • CategoryScaleOptions

Properties ​

attributes ​

attributes: object

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

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
{}

hierarchyBoxColor ​

hierarchyBoxColor: string

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

color of the box to toggle collapse/expand

hierarchyBoxLineHeight ​

hierarchyBoxLineHeight: number

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

distance between two hierarchy indicators

hierarchyBoxSize ​

hierarchyBoxSize: number

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

size of the box to draw

hierarchyBoxWidth ​

hierarchyBoxWidth: number

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

stroke width of the toggle box

hierarchyGroupLabelPosition ​

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

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

position of the hierarchy group label relative to the its children

Default ​

ts
between-first-and-second

hierarchyLabelPosition ​

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

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

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

Default ​

ts
'below'

hierarchySpanColor ​

hierarchySpanColor: string

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

color of the line indicator hierarchy children

hierarchySpanWidth ​

hierarchySpanWidth: number

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

stroke width of the line

levelPercentage ​

levelPercentage: number

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

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

offset ​

offset: true

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

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

padding ​

padding: number

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

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

Default ​

ts
25

reverseOrder ​

reverseOrder: boolean

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

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

static ​

static: boolean

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

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

Default ​

ts
false