Interface Tooltip

Tooltip component Never instanciate tooltips directly use Viewer#createTooltip instead

interface Tooltip {
    container: HTMLElement;
    parent: Viewer | AbstractComponent;
    viewer: Viewer;
    hide(): void;
    isVisible(): boolean;
    move(config: TooltipPosition): void;
    update(content: string, config?: TooltipPosition): void;
}

Hierarchy (View Summary)

AbstractComponent
- Tooltip

Index

Properties

container parent viewer

Methods

hide isVisible move update

Properties

`Readonly`container

container: HTMLElement

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

isVisible

isVisible(): boolean
Checks if the component is visible

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

move

move(config: TooltipPosition): 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:196

update

update(content: string, config?: TooltipPosition): void
Updates the content of the tooltip, optionally with a new position
Parameters
- content: string
- Optionalconfig: TooltipPosition
Returns void
Throws
PSVError if the configuration is invalid
- Defined in packages/core/src/components/Tooltip.ts:179