Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcHighlightingInfo

Contains contextual information about a highlighting.

Constructors

Accessors

Methods

Constructors

constructor

Accessors

context

  • get context(): any

  • The context for the highlight.

    Returns any

  • set context(v): void

  • Parameters

    • v: any

    Returns void

endIndex

  • 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.

    Returns number

  • set endIndex(v): void

  • Parameters

    • v: number

    Returns void

isExclusive

  • get isExclusive(): boolean

  • TODO

    Returns boolean

  • set isExclusive(v): void

  • Parameters

    • v: boolean

    Returns void

isFullRange

  • get isFullRange(): boolean

  • True if this HighlightingInfo represents a full selection of the data.

    Returns boolean

  • set isFullRange(v): void

  • Parameters

    • v: boolean

    Returns void

isMarker

  • 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.

    Returns boolean

  • set isMarker(v): void

  • Parameters

    • v: boolean

    Returns void

progress

  • 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.

    Returns number

  • set progress(v): void

  • Parameters

    • v: number

    Returns void

startIndex

  • 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.

    Returns number

  • set startIndex(v): void

  • Parameters

    • v: number

    Returns void

state

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

  • Parameters

    Returns void

Methods

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any