IAxisLabel

Type interface

Inheritance

IAxisLabel extends Label.

IAxisLabel is not extended by any other symbol.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity

children
#

Type Children

Default new Children(this)

Inherited from Container

The container's child elements.

className
#

Static

Type string

Default "Label"

Inherited from Label

classNames
#

Static

Type Array

Default "IAxisLabel", "Label", "Container", "Sprite", "Entity"

Inherited from Label

dataItem
#

Type DataItem | undefined

Inherited from Sprite

The element's DataItem, or, if it has none, its nearest parent's.

NOTE: data items are assigned automatically in most cases where it matters. Set one only if you know what you are doing.

enableDispose
#

Type boolean

Default true

Inherited from Settings

Set to false to make dispose() do nothing.

events
#

Type SpriteEventDispatcher

Inherited from Sprite

inside
#

Type boolean | undefined

Shows the label inside the plot area. If not set, the renderer's inside applies.

location
#

Type undefined | number

Where the label sits within its cell, from 0 (start) to 1 (end). A cell is a category, a date period, or the span of an axis range.

Click here for more info

maxPosition
#

Type undefined | number

Default 1

Hides the label when it is closer to the end of the visible part of the axis than this, from 0 to 1: 0.9 hides labels in the last 10%.

minPosition
#

Type undefined | number

Default 0

Hides the label when it is closer to the start of the visible part of the axis than this, from 0 to 1: 0.1 hides labels in the first 10%.

multiLocation
#

Type undefined | number

Used instead of location when a grid step spans several units, such as 5 days, or when only every few categories get a label.

Click here for more info

parent
#

Type Container | undefined

Inherited from Sprite

Parent Container of this element.

root
#

Type Root

Inherited from Entity

The Root the object belongs to.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity

template
#

Type Template | undefined

Inherited from Entity

A Template applied to the object. Its settings apply where the object has none set of its own.

uid
#

Type number

Default ++counter

Inherited from Settings

A unique number, given to each object as it is created.

virtualParent
#

Type Container | undefined

Inherited from Sprite

There are 13 inherited items currently hidden from this list.