Class ChartLine

The chart line molecule.

Hierarchy

Molecule
- ChartLine

Index

Properties

chartLinesDisplay key lineBackgroundColor lineShadow lineWidth name yLabelsDisplay

Methods

addDependency getDesignSystem getUninitializedRequiredProperties isEnabled isInitialized removeAllListeners removeListener setListener store

Properties

chartLinesDisplay

chartLinesDisplay: PropertyBoolean

The chart lines display property

`Readonly` key

key: string

The unique key for the node. It is unique from all other nodes in the ThemeBuilder

lineBackgroundColor

lineBackgroundColor: PropertyBackgroundColorStyle

The line background color style property

lineShadow

lineShadow: PropertyShadowSelectable

The line shadow property

lineWidth

lineWidth: PropertyPixelSelectable

The line width property

`Readonly` name

name: string

The name of the node, which is unique relative to it's siblings

yLabelsDisplay

yLabelsDisplay: PropertyBoolean

The Y labels display property

Methods

addDependency

addDependency(node: INode): void
Add a dependency to another node in the tree
Parameters
- node: INode
Returns void
Inherited from Molecule.addDependency
- Defined in src/common/node.ts:72

getDesignSystem

getDesignSystem(): IDesignSystem
Get the design system

Returns IDesignSystem
Inherited from Molecule.getDesignSystem
- Defined in src/common/node.ts:63

getUninitializedRequiredProperties

getUninitializedRequiredProperties(): string[]
Return the keys of all properties which are required and not initialized.

Returns
Returns the keys of all properties which are required and not initialized.

Returns string[]
Inherited from Molecule.getUninitializedRequiredProperties
- Defined in src/common/node.ts:112

isEnabled

isEnabled(): boolean
Determine if this node is enabled. A node is enabled if all other nodes on which this node depends have been initialized.

Returns
True if enabled, or false otherwise.

Returns boolean
Inherited from Molecule.isEnabled
- Defined in src/common/node.ts:82

isInitialized

isInitialized(): boolean
Determine if this node is initialized.

If this node is a property, it is initialized if it is not required to have a value, or if it is required and has either a default or non-default value.

Returns
True if initialized, or false otherwise.

Returns boolean
Inherited from Molecule.isInitialized
- Defined in src/common/node.ts:99

removeAllListeners

removeAllListeners(): void
Remove all listeners on this node.

Returns void
Inherited from Molecule.removeAllListeners
- Defined in src/common/node.ts:161

removeListener

removeListener(name: string): void
Remove a listener by name.
Parameters
- name: string
  
  The name of the listener to remove
Returns void
Inherited from Molecule.removeListener
- Defined in src/common/node.ts:153

setListener

setListener(name: string, callback: EventCallback, eventTypes?: EventType[]): ListenerSubscription
Set a listener on this node

Returns
The ListenerSubscription which should be canceled to stop listening.
Parameters
- name: string
  
  The name of the listener.
- callback: EventCallback
  
  The callback to call when an event occurs.
- Optional eventTypes: EventType[]
  
  The types of events to wait for. If none are specified, listen for all events.
Returns ListenerSubscription
Inherited from Molecule.setListener
- Defined in src/common/node.ts:140

store

store(): Promise<void>
Store persistently the state of the design system.

Returns Promise<void>
Inherited from Molecule.store
- Defined in src/common/node.ts:190

Class ChartLine

Hierarchy

Index

Properties

Methods

Properties

chartLinesDisplay

Readonly key

lineBackgroundColor

lineShadow

lineWidth

Readonly name

yLabelsDisplay

Methods

addDependency

Parameters

node: INode

Returns void

getDesignSystem

Returns IDesignSystem

getUninitializedRequiredProperties

Returns

Returns string[]

isEnabled

Returns

Returns boolean

isInitialized

Returns

Returns boolean

removeAllListeners

Returns void

removeListener

Parameters

name: string

Returns void

setListener

Returns

Parameters

name: string

callback: EventCallback

Optional eventTypes: EventType[]

Returns ListenerSubscription

store

Returns Promise<void>

Settings

Member Visibility

Theme

`Readonly` key

`Readonly` name

`Optional` eventTypes: EventType[]