Last updated

API / geotoolkit / controls / tools / ToolTipTool / ToolTipTool

Namespace: ToolTipTool

tools.ToolTipTool.ToolTipTool

Table of contents

Type Aliases

Contents

Type Aliases

Callback

Ƭ Callback: (point: Point, eventArgs: EventArgs | null, tool: ToolTipTool) => null | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]

Type declaration

▸ (point, eventArgs, tool): null | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]

Callback to return information about the current position of tooltip.

Parameters
Name Type
pointPoint
eventArgsEventArgs | null
toolToolTipTool
Returns

null | string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]


InitCallback

Ƭ InitCallback: (tool?: ToolTipTool) => void

Type declaration

▸ (tool?): void

Parameters
Name Type
Optional toolToolTipTool
Returns

void


Options

Ƭ 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 & 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

Ƭ PositionCallback: (modelPoint: Point, devicePoint: Point, eventArgs: EventArgs | null) => Point | Point[]

Type declaration

▸ (modelPoint, devicePoint, eventArgs): Point | Point[]

Callback for setTooltipPositionHandler

Parameters
Name Type
modelPointPoint
devicePointPoint
eventArgsEventArgs | null
Returns

Point | Point[]


SizeCallback

Ƭ SizeCallback: (modelPoint: Point, devicePoint: Point, eventArgs: EventArgs | null, info: string | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]) => Range | Range[] | null

Type declaration

▸ (modelPoint, devicePoint, eventArgs, info): Range | Range[] | null

Callback for setTooltipSizeHandler

Parameters
Name Type
modelPointPoint
devicePointPoint
eventArgsEventArgs | null
infostring | string[] | ToolTipInfo | ToolTipInfo[] | HTMLElement | HTMLElement[]
Returns

Range | Range[] | null


ToolTipInfo

Ƭ ToolTipInfo: Object

Defines object containing tooltip info

Type declaration

NameTypeDescription
clientpoint?Pointuser defined tooltip position in device coordinate Deprecated since 4.1
content?stringuser defined tooltip content
plotpoint?Pointuser defined tooltip position in plot coordinate
sizerange?Rangeuser defined tooltip min and max size in device coordinate