Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HighlightManager

Hierarchy

  • HighlightManager

Implements

Index

Methods

Methods

end

  • end(host: any): void
  • Parameters

    • host: any

    Returns void

register

  • Registers this component to the given highlight selector.

    Note: When not providing until events, the remove event will be subscribed to automatically.

    Type parameters

    Parameters

    Returns void

start

  • Begins a highlight.

    Parameters

    • host: any

      Any value, used to index the highlight

    • highlight: IHighlight

      The data describing what to highlight and how.

      Note: The host value is used for if multiple things require the same thing to be highlighted at the same time. For example, consider if one thing wanted to highlight a menu bar button for 10 iterations, and something else wanted to highlight the menu bar button for one. After that latter one finishes, if not for the system indexing by "host", the highlight would end there and then, cancelling the remainder of the other highlight.

    Returns void

Generated using TypeDoc