Represents a base class for brush scales.

Constructors

Section titled "Constructors"

IgrBrushScale

new IgrBrushScale(props: P): IgrBrushScale

Returns IgrBrushScale

Properties

Section titled "Properties"

brushes

Section titled "brushes" 
brushes: string[]

propertyUpdated

Section titled "propertyUpdated" 
propertyUpdated: object

Accessors

Section titled "Accessors"

isBrushScale

Section titled "isBrushScale"

Checks if this item is a BrushScale

get isBrushScale(): boolean

Returns boolean

isReady

Section titled "isReady"

Gets the status of the scale

get isReady(): boolean

Returns boolean

nativeElement

Section titled "nativeElement" 
get nativeElement(): HTMLElement

Returns HTMLElement

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount" 
componentDidMount(): void

Returns void

findByName

Section titled "findByName" 
findByName(name: string): any

Parameters

  • name: string

Returns any

getBrush

Section titled "getBrush"

Gets a brush from the brushes collection by index.

getBrush(index: number): string

Parameters

  • index: number

Returns string

notifySeries

Section titled "notifySeries"

Notify attached series about changes to this scale

notifySeries(): void

Returns void

registerSeries

Section titled "registerSeries"

Registers a series with the scale. Under normal circumstances you should not need to call this manually.

registerSeries(series: IgrSeries): void

Parameters

  • series: IgrSeries
    • The series to register with the scale.

Returns void

render

Section titled "render" 
render(): any

Returns any

shouldComponentUpdate

Section titled "shouldComponentUpdate" 
shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

unregisterSeries

Section titled "unregisterSeries"

Unregisters a series with the scale. Under normal circumstances you should not need to call this manually.

unregisterSeries(series: IgrSeries): void

Parameters

  • series: IgrSeries
    • The series to unregister from the scale.

Returns void

_createFromInternal

Section titled "_createFromInternal" 
_createFromInternal(internal: any): IgrBrushScale

Parameters

  • internal: any

Returns IgrBrushScale