Class RVTooltipItem

This class represents a tooltip item that is shown when the user hovers over a chart.

Hierarchy

Index

Constructors

  • Initializes a new instance of the RVTooltipItem class.

    Parameters

    • group: string

      Group header that appears above the menu options.

    • title: string

      Title of the menu option.

    • icon: string | RVImage | null

      Icon shown to the left of the menu label. The type accepted as the icon object is a string pointing to a URL or an RVImage instance.

    • onClick: (sender: RVTooltipItem, args: TooltipItemClickEventArgs) => void

      Action to be executed when the menu option is clicked.

    Returns RVTooltipItem

Accessors

  • get appSuppliedItem(): object | null

    Retrieve the internal application supplied item used to represent the menu item.

    Returns object | null

  • set appSuppliedItem(value: object | null): void

    Assign the internal application supplied item used to represent the menu item.

    Parameters

    • value: object | null

    Returns void

  • get group(): string | null

    Retrieve the group header that appears above the menu options.

    Returns string | null

  • set group(value: string | null): void

    The group header that appears above the menu options.

    Parameters

    • value: string | null

    Returns void

  • get icon(): object | null

    Retrieve the icon shown to the left of the menu label.

    Returns object | null

  • set icon(value: object | null): void

    Icon shown to the left of the menu label.

    Parameters

    • value: object | null

    Returns void

  • get isAppSupplied(): boolean

    Retrieve the property that determines if a menu item was internally supplied.

    Returns boolean

  • set isAppSupplied(value: boolean): void

    A set-once property to determine if a menu item was internally supplied.

    Parameters

    • value: boolean

    Returns void

  • get isHidden(): boolean

    Retrieve property used to determine if the menu item will be hidden from view.

    Returns boolean

  • set isHidden(value: boolean): void

    Property used to determine if the menu item should be hidden from view.

    Parameters

    • value: boolean

    Returns void

  • get title(): string

    Retrieve the string used as the label for the menu item.

    Returns string

  • set title(value: string): void

    A string used as the label for the menu item.

    Parameters

    • value: string

    Returns void