Ogma.tools.tooltip

Tooltip API: functions to display tooltips when hovering or clicking on nodes and edges.

ogma.tools.tooltip.hide()

Hide the tooltip that is currently being displayed.

ogma.tools.tooltip.isShown()

Indicates if a tooltip is currently displayed.

Returns

• boolean

ogma.tools.tooltip.onBackgroundClick(handler[, options])

Indicates the tooltip to display when the background is left clicked.

Arguments

• handler function (): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onBackgroundDoubleClick(handler[, options])

Indicates the tooltip to display when the background is double clicked.

Arguments

• handler function (): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onBackgroundRightClick(handler[, options])

Indicates the tooltip to display when the background is right clicked.

Arguments

• handler function (): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onEdgeClick(handler[, options])

Indicates the tooltip to display when a edge is left clicked.

Arguments

• handler function (edge: Edge): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onEdgeDoubleClick(handler[, options])

Indicates the tooltip to display when a edge is double clicked.

Arguments

• handler function (edge: Edge): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onEdgeHover(handler[, options])

Indicates the tooltip to display when a edge is hovered.

Arguments

• handler function (edge: Edge): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onEdgeRightClick(handler[, options])

Indicates the tooltip to display when a edge is right clicked.

Arguments

• handler function (edge: Edge): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onNodeClick(handler[, options])

Indicates the tooltip to display when a node is left clicked.

Arguments

• handler function (node: Node): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onNodeDoubleClick(handler[, options])

Indicates the tooltip to display when a node is double clicked.

Arguments

• handler function (node: Node): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onNodeHover(handler[, options])

Indicates the tooltip to display when a node is hovered.

Arguments

• handler function (node: Node): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.onNodeRightClick(handler[, options])

Indicates the tooltip to display when a node is right clicked.

Arguments

• handler function (node: Node): (string|Promise<string>) The function that will be called to generate the tooltip. Must return a HTML string.
• options(optional) TooltipOptions

ogma.tools.tooltip.refresh()

Refresh the current tooltip.