Documentation

ITooltipProperties

Type interface

Defines properties for Tooltip.

Inheritance

ITooltipProperties extends IContainerProperties.

ITooltipProperties is extended by ITooltipAdapters.

Properties

align
#

Type Align

Inherited from ISpriteProperties
alwaysShowTooltip
#

Type boolean

Inherited from ISpriteProperties
animationDuration
#

Type number

Duration (ms) that takes for a Tooltip to move from one place to another.

If set to a zero value, the Tooltop will jump to a new location instantenously.

If set to a non-zero value, the Tooltip will "glide" to a new location at a speed determined by this setting.

Click here for more info about animations

animationEasing
#

Type ( value: number) => number

An easing function to use when animating Tooltip position.

Click here for more info about animations

autoTextColor
#

Type boolean

Specifies if text color should be chosen automatically for a better readability.
clickable
#

Type boolean

Inherited from ISpriteProperties
contentAlign
#

Type Align

Inherited from IContainerProperties

Horizontal alignment of Container's items.
contextMenuDisabled
#

Type boolean

Inherited from ISpriteProperties
disabled
#

Type boolean

Inherited from ISpriteProperties
draggable
#

Type boolean

Inherited from ISpriteProperties
dx
#

Type number

Inherited from ISpriteProperties
dy
#

Type number

Inherited from ISpriteProperties
fill
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
fillModifier
#

Type ColorModifier

Inherited from ISpriteProperties
fillOpacity
#

Type number

Inherited from ISpriteProperties
fixedWidthGrid
#

Type boolean

Default false

Inherited from IContainerProperties

If set to true, all columns of the container with layout type "grid" will be equally sized.
focusable
#

Type boolean

Inherited from ISpriteProperties
fontFamily
#

Type string

Inherited from IContainerProperties

Font family for the text.
fontSize
#

Type number

Inherited from IContainerProperties

Font size for the text.
fontWeight
#

Type FontWeight

Default "normal"

Inherited from IContainerProperties

Default font weight.
getFillFromObject
#

Type boolean

Specifies if tooltip background should get fill color from the sprite it is pointing to.
getStrokeFromObject
#

Type boolean

Specifies if tooltip background should get stroke color from the sprite it is pointing to.
height
#

Type number | Percent

Inherited from ISpriteProperties
hidden
#

Type boolean

Inherited from ISpriteProperties
horizontalCenter
#

Type HorizontalCenter

Inherited from ISpriteProperties
hoverOnFocus
#

Type boolean

Inherited from ISpriteProperties
hoverable
#

Type boolean

Inherited from ISpriteProperties
id
#

Type string

Inherited from ISpriteProperties
ignoreBounds
#

Type boolean

Default false

Normally, a tooltip's position will be adjusted so it always fits into chart's coundaries.

Setting this to false will disable such checks and will allow tooltip to "bleed over" the edge of the chart.

@since 4.10.8

inert
#

Type boolean

Inherited from ISpriteProperties
interactionsEnabled
#

Type boolean

Inherited from ISpriteProperties
isActive
#

Type boolean

Inherited from ISpriteProperties
isHover
#

Type boolean

Inherited from ISpriteProperties
keepTargetHover
#

Type boolean

If this tooltip is displayed on hover on some other object, keep that element hovered if hovering on the tooltip.

@since 4.1.13

layout
#

Type ContainerLayout

Default "absolute"

Inherited from IContainerProperties

Container layout.

Options: "absolute" (default), "vertical", "horizontal", or "grid".
marginBottom
#

Type number

Inherited from ISpriteProperties
marginLeft
#

Type number

Inherited from ISpriteProperties
marginRight
#

Type number

Inherited from ISpriteProperties
marginTop
#

Type number

Inherited from ISpriteProperties
maxColumns
#

Type number

Inherited from IContainerProperties

Maximum number of columns (when using "grid" layout).
maxHeight
#

Type number

Inherited from ISpriteProperties
maxWidth
#

Type number

Inherited from ISpriteProperties
maxX
#

Type number

Inherited from ISpriteProperties
maxY
#

Type number

Inherited from ISpriteProperties
minHeight
#

Type number

Inherited from ISpriteProperties
minWidth
#

Type number

Inherited from ISpriteProperties
minX
#

Type number

Inherited from ISpriteProperties
minY
#

Type number

Inherited from ISpriteProperties
nonScaling
#

Type boolean

Inherited from ISpriteProperties
nonScalingStroke
#

Type boolean

Inherited from ISpriteProperties
opacity
#

Type number

Inherited from ISpriteProperties
paddingBottom
#

Type number

Inherited from ISpriteProperties
paddingLeft
#

Type number

Inherited from ISpriteProperties
paddingRight
#

Type number

Inherited from ISpriteProperties
paddingTop
#

Type number

Inherited from ISpriteProperties
path
#

Type string

Inherited from ISpriteProperties
pixelPerfect
#

Type boolean

Inherited from ISpriteProperties
pointerOrientation
#

Type PointerOrientation

Default "vertical"

Pointer orientation: "horizontal", "vertical", "left", "right", "up", "down".
readerChecked
#

Type boolean

Inherited from ISpriteProperties
readerControls
#

Type string

Inherited from ISpriteProperties
readerDescribedBy
#

Type string

Inherited from ISpriteProperties
readerDescription
#

Type string

Inherited from ISpriteProperties
readerHidden
#

Type boolean

Inherited from ISpriteProperties
readerLabelledBy
#

Type string

Inherited from ISpriteProperties
readerLive
#

Type AriaLive

Inherited from ISpriteProperties
readerOrientation
#

Type string

Inherited from ISpriteProperties
readerTitle
#

Type string

Inherited from ISpriteProperties
readerValueNow
#

Type string

Inherited from ISpriteProperties
readerValueText
#

Type string

Inherited from ISpriteProperties
resizable
#

Type boolean

Inherited from ISpriteProperties
reverseOrder
#

Type boolean

Default false

Inherited from IContainerProperties

If set to true, the children of the container will be drawn in reverse order.
role
#

Type Roles

Inherited from ISpriteProperties
rotation
#

Type number

Inherited from ISpriteProperties
scale
#

Type number

Inherited from ISpriteProperties
setStateOnChildren
#

Type boolean

Default false

Inherited from IContainerProperties

Specifies if, when state is applied on this container, the same state should be applied to container's children as well as background.
shapeRendering
#

Type ShapeRendering

Inherited from ISpriteProperties
showInViewport
#

Type boolean

Normally, a tooltip will hide itself if it is pointing to a coordinate that is outside viewport.

Setting this setting to true will override that and make tooltip appear next to the viewport edge closest to the target point.

@since 4.5.7

showOnInit
#

Type boolean

Inherited from ISpriteProperties
showTooltipOn
#

Type "hover" | "hit" | "always"

Inherited from ISpriteProperties
stroke
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
strokeDasharray
#

Type string

Inherited from ISpriteProperties
strokeDashoffset
#

Type number

Inherited from ISpriteProperties
strokeLinecap
#

Type "butt" | "square" | "round"

Inherited from ISpriteProperties
strokeLinejoin
#

Type "miter" | "round" | "bevel"

Inherited from ISpriteProperties
strokeModifier
#

Type ColorModifier

Inherited from ISpriteProperties
strokeOpacity
#

Type number

Inherited from ISpriteProperties
strokeWidth
#

Type number

Inherited from ISpriteProperties
swipeable
#

Type boolean

Inherited from ISpriteProperties
tabindex
#

Type number

Inherited from ISpriteProperties
textDecoration
#

Type TextDecoration

Default "none"

Inherited from IContainerProperties

Default font decoration.
togglable
#

Type boolean

Inherited from ISpriteProperties
tooltipHTML
#

Type string

Inherited from ISpriteProperties
tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteProperties
tooltipText
#

Type string

Inherited from ISpriteProperties
tooltipX
#

Type number | Percent

Inherited from ISpriteProperties
tooltipY
#

Type number | Percent

Inherited from ISpriteProperties
trackable
#

Type boolean

Inherited from ISpriteProperties
url
#

Type string

Inherited from ISpriteProperties
urlTarget
#

Type string

Inherited from ISpriteProperties
userClassName
#

Type string

Inherited from ISpriteProperties
valign
#

Type VerticalAlign

Inherited from ISpriteProperties
verticalCenter
#

Type VerticalCenter

Inherited from ISpriteProperties
visible
#

Type boolean

Inherited from ISpriteProperties
wheelable
#

Type boolean

Inherited from ISpriteProperties
width
#

Type number | Percent

Inherited from ISpriteProperties
x
#

Type number | Percent

Inherited from ISpriteProperties
y
#

Type number | Percent

Inherited from ISpriteProperties
zIndex
#

Type number

Inherited from ISpriteProperties
There are 99 inherited items currently hidden from this list.