Represents a brush scale that uses value-based brush selection.
Constructors
Section titled "Constructors"IgcValueBrushScaleComponent
new IgcValueBrushScaleComponent(): IgcValueBrushScaleComponentReturns IgcValueBrushScaleComponent
Properties
Section titled "Properties"htmlTagName
Section titled "htmlTagName"htmlTagName: stringbrushes
Section titled "brushes"Inherited from: IgcBrushScaleComponent
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: IgcBrushScaleComponent
propertyUpdated: objectAccessors
Section titled "Accessors"isBrushScale
Section titled "isBrushScale"Inherited from: IgcBrushScaleComponent
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
observedAttributes
Section titled "observedAttributes"get observedAttributes(): string[]Returns string[]
Methods
Section titled "Methods"attributeChangedCallback
Section titled "attributeChangedCallback"Inherited from: IgcBrushScaleComponent
attributeChangedCallback(name: string, oldValue: string, newValue: string): voidParameters
- name:
string - oldValue:
string - newValue:
string
Returns void
connectedCallback
Section titled "connectedCallback"connectedCallback(): voidReturns void
disconnectedCallback
Section titled "disconnectedCallback"disconnectedCallback(): voidReturns void
findByName
Section titled "findByName"Inherited from: IgcBrushScaleComponent
findByName(name: string): anyParameters
- name:
string
Returns any
getBrush
Section titled "getBrush"Inherited from: IgcBrushScaleComponent
Gets a brush from the brushes collection by index.
getBrush(index: number): stringParameters
- index:
number
Returns string
notifySeries
Section titled "notifySeries"Inherited from: IgcBrushScaleComponent
Notify attached series about changes to this scale
notifySeries(): voidReturns void
registerSeries
Section titled "registerSeries"Inherited from: IgcBrushScaleComponent
Registers a series with the scale. Under normal circumstances you should not need to call this manually.
registerSeries(series: IgcSeriesComponent): voidParameters
- series:
IgcSeriesComponent- The series to register with the scale.
Returns void
unregisterSeries
Section titled "unregisterSeries"Inherited from: IgcBrushScaleComponent
Unregisters a series with the scale. Under normal circumstances you should not need to call this manually.
unregisterSeries(series: IgcSeriesComponent): voidParameters
- series:
IgcSeriesComponent- The series to unregister from the scale.
Returns void
_createFromInternal
Section titled "_createFromInternal"Inherited from: IgcBrushScaleComponent
_createFromInternal(internal: any): IgcBrushScaleComponentParameters
- internal:
any
Returns IgcBrushScaleComponent
register
Section titled "register"register(): void