All
  • Public
  • Public/Protected
  • All

Class RVTooltipItem

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

Hierarchy

Index

Constructors

Accessors

Constructors

constructor

  • new RVTooltipItem(group: string, title: string, icon: null | string | RVImage, onClick: function): RVTooltipItem

  • 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: null | string | RVImage

      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: function

      Action to be executed when the menu option is clicked.

    Returns RVTooltipItem

Accessors

appSuppliedItem

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

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

    Returns null | object

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

    Parameters

    • value: null | object

    Returns void

group

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

  • Retrieve the group header that appears above the menu options.

    Returns null | string

  • The group header that appears above the menu options.

    Parameters

    • value: null | string

    Returns void

icon

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

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

    Returns null | object

  • Icon shown to the left of the menu label.

    Parameters

    • value: null | object

    Returns void

isAppSupplied

  • get isAppSupplied(): boolean
  • set isAppSupplied(value: boolean): void

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

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

isHidden

  • get isHidden(): boolean
  • set isHidden(value: boolean): void

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

    Returns boolean

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

    Parameters

    • value: boolean

    Returns void

onClick

  • get onClick(): function
  • set onClick(value: function): void

revealElement

  • get revealElement(): object

  • Retrieve the internal intermediate element used to represent the tooltip item.

    Returns object

title

  • get title(): string
  • set title(value: string): void

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

    Returns string

  • A string used as the label for the menu item.

    Parameters

    • value: string

    Returns void