Represents a brush scale that uses value-based brush selection.

Constructors

Section titled "Constructors"

IgrValueBrushScale 

new IgrValueBrushScale(props: IIgrValueBrushScaleProps): IgrValueBrushScale

Returns IgrValueBrushScale

Accessors

Section titled "Accessors"

brushes

Section titled "brushes"

Inherited from: IgrBrushScale

Gets the brushes collection used by this scale.

 
get brushes(): string[]

Returns string[] 

set brushes(v: string[]): void

Parameters

  • v: string[]

Returns void

isBrushScale

Section titled "isBrushScale"

Inherited from: IgrBrushScale

Checks if this item is a BrushScale

 
get isBrushScale(): boolean

Returns boolean

isLogarithmic

Section titled "isLogarithmic"

Gets or sets whether the scale is logarithmic.

 
get isLogarithmic(): boolean

Returns boolean 

set isLogarithmic(v: boolean): void

Parameters

  • v: boolean

Returns void

isReady

Section titled "isReady"

Checks if the value brush scale is ready for usage in the chart

 
get isReady(): boolean

Returns boolean

logarithmBase

Section titled "logarithmBase"

Gets or sets the logarithm base for this scale.

 
get logarithmBase(): number

Returns number 

set logarithmBase(v: number): void

Parameters

  • v: number

Returns void

maximumValue

Section titled "maximumValue"

Gets or sets the maximum value for this scale.

 
get maximumValue(): number

Returns number 

set maximumValue(v: number): void

Parameters

  • v: number

Returns void

minimumValue

Section titled "minimumValue"

Gets or sets the minimum value for this scale.

 
get minimumValue(): number

Returns number 

set minimumValue(v: number): void

Parameters

  • v: number

Returns void

nativeElement

Section titled "nativeElement"

Inherited from: IgrBrushScale 

get nativeElement(): HTMLElement

Returns HTMLElement

propertyUpdated

Section titled "propertyUpdated"

Inherited from: IgrBrushScale

Event raised when a property (including "effective" and non-dependency property) value changes.

 
get propertyUpdated(): object

Returns object 

set propertyUpdated(ev: object): void

Parameters

  • ev: object

Returns void

Methods

Section titled "Methods"

componentDidMount

Section titled "componentDidMount"

Inherited from: IgrBrushScale 

componentDidMount(): void

Returns void

findByName

Section titled "findByName"

Inherited from: IgrBrushScale 

findByName(name: string): any

Parameters

  • name: string

Returns any

getBrush

Section titled "getBrush"

Inherited from: IgrBrushScale

Gets a brush from the brushes collection by index.

 
getBrush(index: number): string

Parameters

  • index: number

Returns string

notifySeries

Section titled "notifySeries"

Inherited from: IgrBrushScale

Notify attached series about changes to this scale

 
notifySeries(): void

Returns void

registerSeries

Section titled "registerSeries"

Inherited from: IgrBrushScale

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"

Inherited from: IgrBrushScale 

render(): any

Returns any

shouldComponentUpdate

Section titled "shouldComponentUpdate"

Inherited from: IgrBrushScale 

shouldComponentUpdate(nextProps: any, nextState: any): boolean

Parameters

  • nextProps: any
  • nextState: any

Returns boolean

unregisterSeries

Section titled "unregisterSeries"

Inherited from: IgrBrushScale

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"

Inherited from: IgrBrushScale 

_createFromInternal(internal: any): IgrBrushScale

Parameters

  • internal: any

Returns IgrBrushScale