Interface IxTooltipSettings

Tooltip settings that can be passed to the loader to define how the tooltip that is to be opened should look like and behave.

Hierarchy

Properties

alignment? appendTo? autoClose? autoCloseInterval? boundaryElement? className? closeByButton? closeByClick? closeByEsc? containertype? content contentReplace? contentRestore? dragAble? fixed? height? heightUnit? htmlTarget? isNotifier? isPersisting? isTarget? keepVisible? key? maxHeight? maxHeightUnit? maxWidth? maxWidthUnit? modal? noParentRef? offsetX? offsetY? overflowBoundaries? parent? posX? posXUnit? posY? posYUnit? position? scrollable? title? width? widthUnit? windowSettings? zIndex?

Properties

Optional alignment

alignment?: string

Alignment at current position.

Values

"middle_center" | "above_right" | "below_right" | "below_center_left" | ...

Optional appendTo

appendTo?: HTMLElement

Tooltip parent container. Avoid different offsetContainer (position=element)

Optional autoClose

autoClose?: boolean

Should the tooltip close itself in an interval.

Optional autoCloseInterval

autoCloseInterval?: number

Time in milliseconds (ms).

Optional boundaryElement

boundaryElement?: boundaryElement

Optional className

className?: ClassName

Tooltips style class.

Optional closeByButton

closeByButton?: boolean

Show tooltip close button.

Optional closeByClick

closeByClick?: boolean

Close tooltip on click anywhere outside the tooltip.

Optional closeByEsc

closeByEsc?: boolean

Close tooltip via ESC key.

Optional containertype

containertype?: ContainerType

content

content: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]

Tooltip content.

Optional contentReplace

contentReplace?: boolean

Tooltip removes content in target container. Requires tooltip positioning embedded.

Optional contentRestore

contentRestore?: boolean

Tooltip restores content of his target container on close. Requires tooltip positioning embedded.

Optional dragAble

dragAble?: boolean

The tooltip can be moved via drag and drop.

Optional fixed

fixed?: boolean

Tooltip position relative to viewport (positioning must be set to window or modal).

Optional height

height?: string | number

Fix tooltip height.

Optional heightUnit

heightUnit?: HeightUnit

Tooltip height unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional htmlTarget

htmlTarget?: HTMLElement

An element in the Document Object Model (DOM).

Optional isNotifier

isNotifier?: boolean

Optional isPersisting

isPersisting?: boolean

Optional isTarget

isTarget?: boolean

Optional keepVisible

keepVisible?: boolean

Tooltip is kept in the visible region, whenever possible.

Optional key

key?: string

The tooltip identifier.

Optional maxHeight

maxHeight?: string | number

Fix tooltip maximal height.

Optional maxHeightUnit

maxHeightUnit?: string

Tooltip maximal height unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional maxWidth

maxWidth?: string | number

Fix tooltip maximal width.

Optional maxWidthUnit

maxWidthUnit?: string

Tooltip maximal width unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional modal

modal?: boolean

Tooltip is opened modal.

Optional noParentRef

noParentRef?: boolean

Optional offsetX

offsetX?: number

Horizontal tooltip offset in px.

Optional offsetY

offsetY?: number

Vertical tooltip offset in px.

Optional overflowBoundaries

overflowBoundaries?: overflowBoundaries

Keep tooltip in visible range and check specific boundaries. Set true to check boundary.

Defaults

{
    bottom: true,
    left: true,
    right: true,
    top: true
}

Optional parent

parent?: string | HTMLElement | ContainerBase

The parent element.

Optional posX

posX?: number

Horizontal tooltip position (depends on position=absolute).

Optional posXUnit

posXUnit?: PosXYUnits

Horizontal tooltip position unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional posY

posY?: number

Vertical tooltip position (depends on position=absolute).

Optional posYUnit

posYUnit?: PosXYUnits

Vertical tooltip position unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional position

position?: Position

Tooltip positioning.

Values

absolute | element (depends on htmlTarget) | embedded (depends on htmlTarget) | modal | mouse | window | ""

Optional scrollable

scrollable?: boolean

Content is scrollable in TT_Content container.

Optional title

title?: string | boolean

Tooltip title.

Optional width

width?: string | number

Fix tooltip width.

Optional widthUnit

widthUnit?: WidthUnit

Tooltip width unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional windowSettings

windowSettings?: {
    closeByButton?: boolean;
    contentRestore?: boolean;
    key?: string;
}

Type declaration

  • Optional closeByButton?: boolean
  • Optional contentRestore?: boolean
  • Optional key?: string

Optional zIndex

zIndex?: string

Sets the tooltips z-index.

Settings

Member Visibility

Theme

On This Page