Class Tooltip

Tooltip component

Description

Never instanciate tooltips directly use Viewer#createTooltip instead

Hierarchy

AbstractComponent
- Tooltip

Index

Properties

container parent viewer

Methods

hide isVisible move update

Properties

`Readonly` container

container: HTMLDivElement = ...

Container element

`Protected` `Readonly` parent

parent: Viewer | AbstractComponent

`Protected` `Readonly` viewer

viewer: Viewer

Reference to main controller

Methods

hide

hide(): void
Hides the tooltip

Returns void
Overrides AbstractComponent.hide
- Defined in packages/core/src/components/Tooltip.ts:262

isVisible

isVisible(): boolean
Checks if the component is visible

Returns boolean
Inherited from AbstractComponent.isVisible
- Defined in packages/core/src/components/AbstractComponent.ts:92

move

move(config): void
Moves the tooltip to a new position
Parameters
- config: TooltipPosition
Returns void

Throws
PSVError if the configuration is invalid
- Defined in packages/core/src/components/Tooltip.ts:194

update

update(content, config?): void
Updates the content of the tooltip, optionally with a new position
Parameters
- content: string
- Optional config: TooltipPosition
  Optional
Returns void

Throws
PSVError if the configuration is invalid
- Defined in packages/core/src/components/Tooltip.ts:177

Generated using TypeDoc