Represents a brush scale that uses value-based brush selection.
Constructors
Section titled "Constructors"IgrValueBrushScale
new IgrValueBrushScale(props: IIgrValueBrushScaleProps): IgrValueBrushScaleReturns IgrValueBrushScale
Properties
Section titled "Properties"brushes
Section titled "brushes"Inherited from: IgrBrushScale
brushes: string[]isLogarithmic
Section titled "isLogarithmic"isLogarithmic: booleanlogarithmBase
Section titled "logarithmBase"logarithmBase: numbermaximumValue
Section titled "maximumValue"maximumValue: numberminimumValue
Section titled "minimumValue"minimumValue: numberpropertyUpdated
Section titled "propertyUpdated"Inherited from: IgrBrushScale
propertyUpdated: objectAccessors
Section titled "Accessors"isBrushScale
Section titled "isBrushScale"Inherited from: IgrBrushScale
Checks if this item is a BrushScale
get isBrushScale(): booleanReturns boolean
isReady
Section titled "isReady"Checks if the value brush scale is ready for usage in the chart
get isReady(): booleanReturns boolean
nativeElement
Section titled "nativeElement"Inherited from: IgrBrushScale
get nativeElement(): HTMLElementReturns HTMLElement
Methods
Section titled "Methods"componentDidMount
Section titled "componentDidMount"Inherited from: IgrBrushScale
componentDidMount(): voidReturns void
findByName
Section titled "findByName"Inherited from: IgrBrushScale
findByName(name: string): anyParameters
- name:
string
Returns any
getBrush
Section titled "getBrush"Inherited from: IgrBrushScale
Gets a brush from the brushes collection by index.
getBrush(index: number): stringParameters
- index:
number
Returns string
notifySeries
Section titled "notifySeries"Inherited from: IgrBrushScale
Notify attached series about changes to this scale
notifySeries(): voidReturns 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): voidParameters
- series:
IgrSeries- The series to register with the scale.
Returns void
render
Section titled "render"Inherited from: IgrBrushScale
render(): anyReturns any
shouldComponentUpdate
Section titled "shouldComponentUpdate"Inherited from: IgrBrushScale
shouldComponentUpdate(nextProps: any, nextState: any): booleanParameters
- 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): voidParameters
- series:
IgrSeries- The series to unregister from the scale.
Returns void
_createFromInternal
Section titled "_createFromInternal"Inherited from: IgrBrushScale
_createFromInternal(internal: any): IgrBrushScaleParameters
- internal:
any