API / geotoolkit / controls / tools / ToolTipTool / ToolTipTool
tools.ToolTipTool.ToolTipTool
Type Aliases
Ƭ Callback: (point: Point, eventArgs: EventArgs | null, tool: ToolTipTool) => null | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]
▸ (point, eventArgs, tool): null | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]
Callback to return information about the current position of tooltip.
| Name | Type |
|---|---|
point | Point |
eventArgs | EventArgs | null |
tool | ToolTipTool |
null | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]
Ƭ InitCallback: (tool?: ToolTipTool) => void
▸ (tool?): void
| Name | Type |
|---|---|
Optional tool | ToolTipTool |
void
Ƭ Options: Options & ToolTipOptions & { autoupdate?: boolean ; callback?: Callback ; delay?: number | null ; fadeduration?: number | null ; hidedelay?: number | null ; init?: InitCallback ; mode?: PointerMode | string ; positionhandler?: PositionCallback ; radius?: number ; registry?: ToolTipRegistry ; showdelay?: number | null ; sizehandler?: SizeCallback }
tool options
Ƭ OptionsOut: OptionsOut & OptionsOut & { autoupdate: boolean ; callback: Callback | null ; delay: number | null ; fadeduration: number | null ; hidedelay: number | null ; mode: PointerMode | string ; radius: number ; registry: ToolTipRegistry | null ; showdelay: number | null }
properties object
Ƭ PositionCallback: (modelPoint: Point, devicePoint: Point, eventArgs: EventArgs | null) => Point | Point[]
▸ (modelPoint, devicePoint, eventArgs): Point | Point[]
Callback for setTooltipPositionHandler
Ƭ SizeCallback: (modelPoint: Point, devicePoint: Point, eventArgs: EventArgs | null, info: string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]) => Range | Range[] | null
▸ (modelPoint, devicePoint, eventArgs, info): Range | Range[] | null
Callback for setTooltipSizeHandler
| Name | Type |
|---|---|
modelPoint | Point |
devicePoint | Point |
eventArgs | EventArgs | null |
info | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[] |
Ƭ ToolTipInfo: Object
Defines object containing tooltip info