Documentation

IXYCursorProperties

Type interface

Defines properties for XYCursor.

Inheritance

IXYCursorProperties extends ICursorProperties.

IXYCursorProperties is extended by IXYCursorAdapters, IRadarCursorProperties, ICurveCursorProperties.

Properties

align
#

Type Align

Inherited from ISpriteProperties
alwaysShowTooltip
#

Type boolean

Inherited from ISpriteProperties
behavior
#

Type "zoomX" | "zoomY" | "zoomXY" | "selectX" | "selectY" | "selectXY" | "panX" | "panY" | "panXY" | "none"

Default "zoomX"

Cursor's behavior when moved with pointer down:

  • "zoomX" - zooms horizontally; (default)
  • "zoomY" - zooms vertically;
  • "zoomXY" - zooms both horizontally and vertically;
  • "selectX" - selects a range horizontally;
  • "selectY" - selects a range vertically;
  • "selectXY" - selects a range both horizontally and vertically;
  • "panX" - moves (pans) current selection horizontally;
  • "panY" - moves (pans) current selection vertically;
  • "panXY" - moves (pans) current selection both horizontally and vertically;
  • "none" - does nothing with pointer down.
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.
fullWidthLineX
#

Type boolean

Cursor's horizontal line is expanded to take full width of the related Axis' cell/category.
fullWidthLineY
#

Type boolean

Cursor's vertical line is expanded to take full width of the related Axis' cell/category.
height
#

Type number | Percent

Inherited from ISpriteProperties
hidden
#

Type boolean

Inherited from ISpriteProperties
hideSeriesTooltipsOnSelection
#

Type boolean

If set to true this will hide series tooltips when selecting with cursor.

@since 4.5.15

horizontalCenter
#

Type HorizontalCenter

Inherited from ISpriteProperties
hoverOnFocus
#

Type boolean

Inherited from ISpriteProperties
hoverable
#

Type boolean

Inherited from ISpriteProperties
id
#

Type string

Inherited from ISpriteProperties
inert
#

Type boolean

Inherited from ISpriteProperties
interactionsEnabled
#

Type boolean

Inherited from ISpriteProperties
isActive
#

Type boolean

Inherited from ISpriteProperties
isHover
#

Type boolean

Inherited from ISpriteProperties
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
maxPanOut
#

Type number

If cursor behavior is panX or panY, we allow to pan plot out of it's max bounds for a better user experience.

This setting specifies relative value by how much we can pan out the plot
maxTooltipDistance
#

Type number

If set to a numeric value, cursor will display closest series' tooltips plus tooltips from series that are closer to than maxTooltipDistance to it.

Set it to -1 to always force one tooltip, even if there are multiple data items in exactly same place.

@since 4.7.18

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
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
showOnInit
#

Type boolean

Inherited from ISpriteProperties
showTooltipOn
#

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

Inherited from ISpriteProperties
snapOnPan
#

Type boolean

Default true

Should zoom selection "snap" into equal categories/intervals after panning the chart? (when behavior == "panX")

@since 4.10.17

snapToSeries
#

Type XYSeries | XYSeries[]

Specifies to which series cursor lines should be snapped.

Can be a single series instance or an array of series.
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.