Represents a brush scale that uses value-based brush selection.
Constructors
Section titled "Constructors"IgxValueBrushScaleComponent
new IgxValueBrushScaleComponent(): IgxValueBrushScaleComponentReturns IgxValueBrushScaleComponent
Properties
Section titled "Properties"ngAcceptInputType_brushes
Section titled "ngAcceptInputType_brushes"Inherited from: IgxBrushScaleComponent
ngAcceptInputType_brushes: string | string[]ngAcceptInputType_isBrushScale
Section titled "ngAcceptInputType_isBrushScale"Inherited from: IgxBrushScaleComponent
ngAcceptInputType_isBrushScale: string | booleanngAcceptInputType_isLogarithmic
Section titled "ngAcceptInputType_isLogarithmic"ngAcceptInputType_isLogarithmic: string | booleanngAcceptInputType_isReady
Section titled "ngAcceptInputType_isReady"ngAcceptInputType_isReady: string | booleanngAcceptInputType_logarithmBase
Section titled "ngAcceptInputType_logarithmBase"ngAcceptInputType_logarithmBase: string | numberngAcceptInputType_maximumValue
Section titled "ngAcceptInputType_maximumValue"ngAcceptInputType_maximumValue: string | numberngAcceptInputType_minimumValue
Section titled "ngAcceptInputType_minimumValue"ngAcceptInputType_minimumValue: string | numberɵcmp: ɵɵComponentDeclaration<IgxValueBrushScaleComponent, "igx-value-brush-scale", never, object, object, never, never>ɵfac: ɵɵFactoryDeclaration<IgxValueBrushScaleComponent, never>brushes
Section titled "brushes"Inherited from: IgxBrushScaleComponent
brushes: string[]isLogarithmic
Section titled "isLogarithmic"isLogarithmic: booleanlogarithmBase
Section titled "logarithmBase"logarithmBase: numbermaximumValue
Section titled "maximumValue"maximumValue: numberminimumValue
Section titled "minimumValue"minimumValue: numberAccessors
Section titled "Accessors"isBrushScale
Section titled "isBrushScale"Inherited from: IgxBrushScaleComponent
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
propertyUpdated
Section titled "propertyUpdated"Inherited from: IgxBrushScaleComponent
Event raised when a property (including "effective" and non-dependency property) value changes.
get propertyUpdated(): EventEmitter<object>Returns EventEmitter<object>
Methods
Section titled "Methods"findByName
Section titled "findByName"Inherited from: IgxBrushScaleComponent
findByName(name: string): anyParameters
- name:
string
Returns any
getBrush
Section titled "getBrush"Inherited from: IgxBrushScaleComponent
Gets a brush from the brushes collection by index.
getBrush(index: number): stringParameters
- index:
number
Returns string
ngOnInit
Section titled "ngOnInit"Inherited from: IgxBrushScaleComponent
ngOnInit(): voidReturns void
notifySeries
Section titled "notifySeries"Inherited from: IgxBrushScaleComponent
Notify attached series about changes to this scale
notifySeries(): voidReturns void
registerSeries
Section titled "registerSeries"Inherited from: IgxBrushScaleComponent
Registers a series with the scale. Under normal circumstances you should not need to call this manually.
registerSeries(series: IgxSeriesComponent): voidParameters
- series:
IgxSeriesComponent- The series to register with the scale.
Returns void
unregisterSeries
Section titled "unregisterSeries"Inherited from: IgxBrushScaleComponent
Unregisters a series with the scale. Under normal circumstances you should not need to call this manually.
unregisterSeries(series: IgxSeriesComponent): voidParameters
- series:
IgxSeriesComponent- The series to unregister from the scale.
Returns void
_createFromInternal
Section titled "_createFromInternal"Inherited from: IgxBrushScaleComponent
_createFromInternal(internal: any): IgxBrushScaleComponentParameters
- internal:
any