TooltipModel
Interface representing the Tooltip class.
Properties
animation TooltipAnimationModel
Specifies the animation settings for when the tooltip is opening or closing.
Default: { open: { effect: 'FadeIn', duration: 150, delay: 0 }, close: { effect: 'FadeOut', duration: 150, delay: 0 }}
closeDelay Number
Specifies a delay in milliseconds to wait before closing the tooltip.
Default: 0
container String HTMLElement
Specifies the container element in which the tooltip's pop-up will be appended to.
Default: body
content String HTMLElement
Specifies the content that will be displayed in the tooltip.
Default: body
cssClass String
Specifies CSS classes to customize the appearance of the control.
Default: ""
enableHtmlParse Boolean
Specifies whether to enable or disable HTML elements from being displayed in the tooltip. When false, HTML elements will be removed from the content.
Default: true
enableHtmlSanitizer Boolean
Specifies whether to allow the rendering of untrusted HTML and JavaScript values withing the control. When true, any untrusted strings or scripts will be remote before rendering.
Default: true
enableRtl Boolean
Specifies whether to render the control in right to left direction.
Default: false
enableState Boolean
Specifies whether to persist the state of the control between page loads.
Default: false
height String Number
Specifies the height of the tooltip control expressed in percent or pixels.
Default: auto
htmlAttributes {:}
Specifies additional HTML attributes, such as title, styles, class, id, and name, in a key-value pair format that will be appended to the HTML element. If both the property and equivalent HTML attributes are configured, then the control overrides the property value with the HTML attributes.
Default: {}
isSticky Boolean
Specifies whether to display the tooltip opened until it is closed manually.
Default: false
locale String
Specifies the culture and localization value for this control, overriding the globally defined value.
Default: en-US
mouseTrail Boolean
Specifies whether to allow the tooltip to follow the mouse pointer over the target element.
Default: false
offsetX Number
Specifies the space between the target element and the tooltip on the X axis.
Default: 0
offsetY Number
Specifies the space between the target element and the tooltip on the Y axis.
Default: 0
openDelay Number
Specifies a delay in milliseconds to wait before opening the tooltip.
Default: 0
opensOn String
Specifies the mode used to determine when the tooltip should be display. When on a desktop, the tooltip will show when hovering on the target element. When on a touch device, the tooltip will show then tapping and holding on the target element.
Default: Auto
position TooltipPosition
Specifies the position of the tooltip with respect to the target element.
Default: TopCenter
showTipPointer Boolean
Specifies whether to show or hide the tip pointer on the tooltip.
Default: true
target String
Specifies the target selector where the tooltip will be displayed on.
Default: ""
tipPointerPosition TipPointerPosition
Specifies the position of the top pointer on the tooltip.
Default: Auto
width String Number
Specifies the width of the tooltip control expressed in percent or pixels. When set to auto, the width gets adjusted to display its content within the viewable screen.
Default: auto
Events
afterClose EmitType<TooltipEventArgs>
Event callback that is raised after the tooltip is closed.
afterOpen EmitType<TooltipEventArgs>
Event callback that is raised after the tooltip is opened.
beforeClose EmitType<TooltipEventArgs>
Event callback that is raised before the tooltip is closed.
beforeCollision EmitType<TooltipCollisionEventArgs>
Event callback that is raised before every collision fit calculation.
beforeOpen EmitType<TooltipEventArgs>
Event callback that is raised before the tooltip is opened and after rendered.
beforeRender EmitType<TooltipEventArgs>
Event callback that is raised before the tooltip is rendered.
created EmitType<CreatedEventArgs>
Event callback that is raised when the control has been created.
destroyed EmitType<Object>
Event callback that is raised when the control has been destroyed.