The requested page is not available for the requested platform. You are viewing the content for Default platform.

ViewerToolbarItemTooltip Interface

A toolbar item's tooltip.

Declaration

export interface ViewerToolbarItemTooltip

Remarks

The ViewerToolbarItem.tooltip property displays a customized popup hint with additional information about the item being hovered over. You can create a specified ViewerToolbarItemTooltip.template to display a complex tooltip.

The following code snippet shows how to add a tooltip with a specified template and the "custom-tooltip" CSS class:

tooltip: {
    className: "custom-tooltip",
    template: function(contentElement) {
        return $('<div/>').text('Custom Tooltip');
    },
}

Properties

className Property

Specifies a CSS class name used to customize a tooltip.

Declaration

className?: string

Property Value

Type Description
string

A CSS class name used to customize a tooltip.

template Property

Specifies a template used to customize a tooltip.

Declaration

template?: (contentElement: any) => JQuery | string

Property Value

Type Description
(contentElement: any) => JQuery | string

A content element that defines a template.

Remarks

The ViewerToolbarItem.tooltip property displays a customized popup hint with additional information about the item being hovered over. You can create a specified template to display a complex tooltip.