Contains contextual information about a highlighting.

Hierarchy

Hierarchy

  • IgxHighlightingInfo

Constructors

Properties

ngAcceptInputType_endIndex: string | number
ngAcceptInputType_isExclusive: string | boolean
ngAcceptInputType_isFullRange: string | boolean
ngAcceptInputType_isMarker: string | boolean
ngAcceptInputType_progress: string | number
ngAcceptInputType_startIndex: string | number
ngAcceptInputType_state: string | HighlightingState

Accessors

  • get endIndex(): number
  • The index of the last highlighted item.

    You can use the EndIndex to get or set the last highlighted item for the series.

    <igx-column-series
    #series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    valueMemberPath="value"
    isHighlightingEnabled="true" isCustomCategoryStyleAllowed="true" (assigningCategoryStyle)="assigningSeries($event)" >
    </igx-column-series>

    Returns number

  • set endIndex(v: number): void
  • Parameters

    • v: number

    Returns void

  • get isExclusive(): boolean
  • Returns boolean

  • set isExclusive(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isFullRange(): boolean
  • True if this HighlightingInfo represents a full selection of the data.

    Returns boolean

  • set isFullRange(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get isMarker(): boolean
  • True if this HighlightingInfo represents a marker highlighting.

    You can set the IsMarker to True if the HighlightingInfo represents a marker highlighting. Otherwise set to false.

    <igx-column-series
    #series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    valueMemberPath="value"
    isHighlightingEnabled="true" isCustomCategoryStyleAllowed="true" (assigningCategoryStyle)="assigningSeries($event)" >
    </igx-column-series>

    Returns boolean

  • set isMarker(v: boolean): void
  • Parameters

    • v: boolean

    Returns void

  • get progress(): number
  • A number between 0 and 1 representing the progress of the highlighting.

    You can use the Progress property to set a number between 0 and 1 representing the progress of the highlighting.

    <igx-column-series
    #series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    valueMemberPath="value"
    isHighlightingEnabled="true" isCustomCategoryStyleAllowed="true" (assigningCategoryStyle)="assigningSeries($event)" >
    </igx-column-series>

    Returns number

  • set progress(v: number): void
  • Parameters

    • v: number

    Returns void

  • get series(): IgxSeriesComponent
  • The series in context.

    You can use the Series property to get the series in context.

    <igx-column-series
    #series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    valueMemberPath="value"
    isHighlightingEnabled="true" isCustomCategoryStyleAllowed="true" (assigningCategoryStyle)="assigningSeries($event)" >
    </igx-column-series>

    Returns IgxSeriesComponent

  • set series(v: IgxSeriesComponent): void
  • Parameters

    Returns void

  • get startIndex(): number
  • The index of the first highlighted item.

    You can use StartIndex to get or set the first highlighted item for the series.

    <igx-column-series
    #series
    [xAxis]="xAxis"
    [yAxis]="yAxis"
    valueMemberPath="value"
    isHighlightingEnabled="true" isCustomCategoryStyleAllowed="true" (assigningCategoryStyle)="assigningSeries($event)" >
    </igx-column-series>

    Returns number

  • set startIndex(v: number): void
  • Parameters

    • v: number

    Returns void

  • get state(): HighlightingState
  • The state of the highlighting.

    You can use the State to get or set the transitioning state of the highlighting, between In, Out, or Static.

    Returns HighlightingState

  • set state(v: HighlightingState): void
  • Parameters

    Returns void

Methods

  • Parameters

    • name: string

    Returns any