Interface IOptions

The referent anchor rectangle to which the hover box is bound.

Notes

In an editor context, this value will typically be the cursor's coordinate position, which can be retrieved via calling the getCoordinateForPosition method.

The node that hosts the anchor.

Notes

The visibility of the elements under hover box edges within this host node is the heuristic that determines whether the hover box ought to be visible.

The maximum height of a hover box.

Notes

This value is only used if a CSS max-height attribute is not set for the hover box. It is a fallback value.

The minimum height of a hover box.

The hover box node.

Optional pixel offset values added to where the hover box should render.

Notes

This option is useful for passing in values that may pertain to CSS borders or padding in cases where the text inside the hover box may need to align with the text of the referent editor.

Because the hover box calculation may render a box either above or below the cursor, the vertical offset accepts above and below values for the different render modes.

How to position the hover box if its edges extend beyond the view of the host element. Value 'sticky' positions the box at the (inner or outer) edge of the host element.

Notes

The default value for each edge is 'hidden-inside' for left and top, and hidden-outside for right and bottom edges.

If space is available both above and below the anchor, denote which location is privileged. Use forceBelow and forceAbove to mandate where hover box should render relative to anchor.

Notes

The default value is 'below'.

Exact size of the hover box. Pass it for faster rendering (allowing the positioning algorithm to to place it immediately at requested position).

If the style of the node has already been computed, it can be passed into the hover box for geometry calculation.