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

Constructors

Section titled "Constructors"

IgxValueBrushScaleComponent 

new IgxValueBrushScaleComponent(): IgxValueBrushScaleComponent

Returns 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 | boolean

ngAcceptInputType_isLogarithmic

Section titled "ngAcceptInputType_isLogarithmic" 
ngAcceptInputType_isLogarithmic: string | boolean

ngAcceptInputType_isReady

Section titled "ngAcceptInputType_isReady" 
ngAcceptInputType_isReady: string | boolean

ngAcceptInputType_logarithmBase

Section titled "ngAcceptInputType_logarithmBase" 
ngAcceptInputType_logarithmBase: string | number

ngAcceptInputType_maximumValue

Section titled "ngAcceptInputType_maximumValue" 
ngAcceptInputType_maximumValue: string | number

ngAcceptInputType_minimumValue

Section titled "ngAcceptInputType_minimumValue" 
ngAcceptInputType_minimumValue: string | number

ɵcmp

Section titled "ɵcmp" 
ɵcmp: ɵɵComponentDeclaration<IgxValueBrushScaleComponent, "igx-value-brush-scale", never, object, object, never, never, true, never>

ɵfac

Section titled "ɵfac" 
ɵfac: ɵɵFactoryDeclaration<IgxValueBrushScaleComponent, never>

Accessors

Section titled "Accessors"

brushes

Section titled "brushes"

Inherited from: IgxBrushScaleComponent

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: IgxBrushScaleComponent

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

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): any

Parameters

  • name: string

Returns any

getBrush

Section titled "getBrush"

Inherited from: IgxBrushScaleComponent

Gets a brush from the brushes collection by index.

 
getBrush(index: number): string

Parameters

  • index: number

Returns string

ngOnInit

Section titled "ngOnInit"

Inherited from: IgxBrushScaleComponent 

ngOnInit(): void

Returns void

notifySeries

Section titled "notifySeries"

Inherited from: IgxBrushScaleComponent

Notify attached series about changes to this scale

 
notifySeries(): void

Returns 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): void

Parameters

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): void

Parameters

Returns void

_createFromInternal

Section titled "_createFromInternal"

Inherited from: IgxBrushScaleComponent 

_createFromInternal(internal: any): IgxBrushScaleComponent

Parameters

  • internal: any

Returns IgxBrushScaleComponent

register

Section titled "register" 
register(): void

Returns void