Class CommandBarTooltip

constructor

• new CommandBarTooltip(
      parentNode: HTMLElement,
      options?: Partial<CommandBarOptions>,
  ): CommandBarTooltip

• Parameters

  • parentNode: HTMLElement
  • Optionaloptions: Partial<CommandBarOptions>

  Returns CommandBarTooltip

commands

editor

elements

eventListeners

maxElementsOnTooltip

moreOptions

moreOptionsEl

parentNode

tooltip

tooltipEl

_dispatchEvent

• _dispatchEvent<K extends keyof CommandBarEvents>(
      eventName: K,
      ...args: Parameters<CommandBarEvents[K]>,
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • eventName: K
  • ...args: Parameters<CommandBarEvents[K]>

  Returns void

_emit

• _emit<K extends keyof CommandBarEvents>(
      eventName: K,
      ...args: Parameters<CommandBarEvents[K]>,
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • eventName: K
  • ...args: Parameters<CommandBarEvents[K]>

  Returns void

_signal

• _signal<K extends keyof CommandBarEvents>(
      eventName: K,
      ...args: Parameters<CommandBarEvents[K]>,
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • eventName: K
  • ...args: Parameters<CommandBarEvents[K]>

  Returns void

addEventListener

• addEventListener<K extends keyof CommandBarEvents>(
      name: K,
      callback: CommandBarEvents[K],
      capturing?: boolean,
  ): CommandBarEvents[K]

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • name: K
  • callback: CommandBarEvents[K]
  • Optionalcapturing: boolean

  Returns CommandBarEvents[K]

attach

• attach(editor: Editor): void

• Attaches the clickable command bar tooltip to an editor

  Depending on the alwaysShow parameter it either displays the tooltip immediately, or subscribes to the necessary events to display the tooltip on hover.

  Parameters

  • editor: Editor

  Returns void

destroy

• destroy(): void

• Returns void

detach

• detach(): void

• Detaches the tooltip from the editor.

  Returns void

getAlwaysShow

• getAlwaysShow(): boolean

• Returns boolean

isMoreOptionsShown

• isMoreOptionsShown(): boolean

• Returns boolean

isShown

• isShown(): boolean

• Returns boolean

off

• off<K extends keyof CommandBarEvents>(
      name: K,
      callback: CommandBarEvents[K],
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • name: K
  • callback: CommandBarEvents[K]

  Returns void

on

• on<K extends keyof CommandBarEvents>(
      name: K,
      callback: CommandBarEvents[K],
      capturing?: boolean,
  ): CommandBarEvents[K]

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • name: K
  • callback: CommandBarEvents[K]
  • Optionalcapturing: boolean

  Returns CommandBarEvents[K]

once

• once<K extends keyof CommandBarEvents>(
      name: K,
      callback: CommandBarEvents[K],
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • name: K
  • callback: CommandBarEvents[K]

  Returns void

registerCommand

• registerCommand(id: string, command: TooltipCommand): void

• Registers a command on the command bar tooltip.

  The commands are added in sequential order. If there is not enough space on the main toolbar, the remaining elements are added to the overflow menu.

  Parameters

  • id: string
  • command: TooltipCommand

  Returns void

removeAllListeners

• removeAllListeners(name?: string): void

• Parameters

  • Optionalname: string

  Returns void

removeDefaultHandler

• removeDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

removeEventListener

• removeEventListener<K extends keyof CommandBarEvents>(
      name: K,
      callback: CommandBarEvents[K],
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • name: K
  • callback: CommandBarEvents[K]

  Returns void

removeListener

• removeListener<K extends keyof CommandBarEvents>(
      name: K,
      callback: CommandBarEvents[K],
  ): void

• Type Parameters

  • K extends keyof CommandBarEvents

  Parameters

  • name: K
  • callback: CommandBarEvents[K]

  Returns void

setAlwaysShow

• setAlwaysShow(alwaysShow: boolean): void

• Sets the display mode of the tooltip

  When true, the tooltip is always displayed while it is attached to an editor. When false, the tooltip is displayed only when the mouse hovers over the active editor line.

  Parameters

  • alwaysShow: boolean

  Returns void

setDefaultHandler

• setDefaultHandler(name: string, callback: Function): void

• Parameters

  • name: string
  • callback: Function

  Returns void

update

• update(): void

• Updates each command element in the tooltip.

  This is automatically called on certain events, but can be called manually as well.

  Returns void

updatePosition

• updatePosition(): void

• Updates the position of the command bar tooltip. It aligns itself above the active line in the editor.

  Returns void