API / geotoolkit / controls / tooltip / ToolTip / ToolTip
Type Aliases
Ƭ AnchorCssKeys: "none" | "lefttop" | "leftbottom" | "righttop" | "rightbottom" | "center" | "leftcenter" | "bottomcenter" | "rightcenter" | "topcenter"
Ƭ AnchorCssOptions: Partial<Record<AnchorCssKeys, string>>
Ƭ Options: ToolTipOptions & { id?: string ; node?: Node ; plot?: Plot }
Ƭ OptionsOut: Object
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | tooltip alignment according to the point set by offsets |
anchorcssclasses | AnchorCssOptions | CSS class name to be applied for tooltip depends on tooltip anchor |
autoflip | boolean | mouse transparent mode |
cssclasses | string | null | CSS classes |
delay | number | Deprecated since 4.1 use 'showdelay' instead |
hidedelay? | number | auto hide in millisecond, 0 means false and autohide is disabled |
offsetx | number | offset of tooltip from current position by x in pixels |
offsety | number | offset of tooltip from current position by y in pixels |
orientation | Orientation | tooltip orientation |
showdelay? | number | null | delay between displaying tooltip, 0 means false and tooltip shows immediately |
size | Range | client size range |
Ƭ Properties: Object
| Name | Type | Description |
|---|---|---|
alignment? | AnchorType | tooltip alignment according to the point set by offsets |
anchorcssclasses? | AnchorCssOptions | CSS class name to be applied for tooltip depends on tooltip anchor. Default is: 'topcenter': 'cg-tooltip-arrow-top', 'bottomcenter': 'cg-tooltip-arrow-bottom', 'leftcenter': 'cg-tooltip-arrow-left', 'rightcenter': 'cg-tooltip-arrow-right' Set to null to remove default css classes |
autoflip? | boolean | true to automatically flip tooltip alignment if it doesn't fit the window |
cssclasses? | string | CSS classes' names to be applied for tooltip 'cg-tooltip' by default |
delay? | number | Deprecated since 4.1 use 'showdelay' instead |
hidedelay? | number | auto hide in millisecond, 0 means false and autohide is disabled |
offsetx? | number | offset of tooltip from current position by x in pixels |
offsety? | number | offset of tooltip from current position by y in pixels |
orientation? | Orientation | tooltip orientation |
showdelay? | number | null | delay between displaying tooltip, 0 means false and tooltip shows immediately |
size? | Options | Range | client size range |
Ƭ ToolTipOptions: Properties & { divelement?: HTMLElement | CreateHTMLElement ; transparent?: boolean }