Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxValueBrushScaleComponent

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

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_brushes

ngAcceptInputType_brushes: string | string[]

Static ngAcceptInputType_isBrushScale

ngAcceptInputType_isBrushScale: string | boolean

Static ngAcceptInputType_isLogarithmic

ngAcceptInputType_isLogarithmic: string | boolean

Static ngAcceptInputType_isReady

ngAcceptInputType_isReady: string | boolean

Static ngAcceptInputType_logarithmBase

ngAcceptInputType_logarithmBase: string | number

Static ngAcceptInputType_maximumValue

ngAcceptInputType_maximumValue: string | number

Static ngAcceptInputType_minimumValue

ngAcceptInputType_minimumValue: string | number

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

brushes

  • get brushes(): string[]

  • Gets the brushes collection used by this scale.

    Returns string[]

  • set brushes(v: string[]): void

  • Parameters

    • v: string[]

    Returns void

isBrushScale

  • get isBrushScale(): boolean

  • Checks if this item is a BrushScale

    Returns boolean

isLogarithmic

  • get isLogarithmic(): boolean

  • Gets or sets whether the scale is logarithmic.

    Returns boolean

  • set isLogarithmic(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isReady

  • get isReady(): boolean

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

    Returns boolean

logarithmBase

  • get logarithmBase(): number

  • Gets or sets the logarithm base for this scale.

    Returns number

  • set logarithmBase(v: number): void

  • Parameters

    • v: number

    Returns void

maximumValue

  • get maximumValue(): number

  • Gets or sets the maximum value for this scale.

    Returns number

  • set maximumValue(v: number): void

  • Parameters

    • v: number

    Returns void

minimumValue

  • get minimumValue(): number

  • Gets or sets the minimum value for this scale.

    Returns number

  • set minimumValue(v: number): void

  • Parameters

    • v: number

    Returns void

propertyUpdated

  • get propertyUpdated(): EventEmitter<{
        args: IgxPropertyUpdatedEventArgs;
        sender: any;
    }>

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

    Returns EventEmitter<{
        args: IgxPropertyUpdatedEventArgs;
        sender: any;
    }>

Methods

findByName

  • Parameters

    • name: string

    Returns any

getBrush

  • Gets a brush from the brushes collection by index.

    Parameters

    • index: number

    Returns string

ngOnInit

  • Returns void

notifySeries

  • Notify attached series about changes to this scale

    Returns void

registerSeries

  • Registers a series with the scale. Under normal circumstances you should not need to call this manually.

    Parameters

    Returns void

unregisterSeries

  • Unregisters a series with the scale. Under normal circumstances you should not need to call this manually.

    Parameters

    Returns void

Static _createFromInternal