Documentation

ITreeMapSeriesProperties

Type interface

Defines properties for TreeMapSeries.

Inheritance

ITreeMapSeriesProperties extends IColumnSeriesProperties.

ITreeMapSeriesProperties is extended by ITreeMapSeriesAdapters.

Properties

align
#

Type Align

Inherited from ISpriteProperties
alwaysShowTooltip
#

Type boolean

Inherited from ISpriteProperties
clickable
#

Type boolean

Inherited from ISpriteProperties
clustered
#

Type boolean

Inherited from IColumnSeriesProperties

Cluster this series columns?

Setting to false will make columns overlap with other series.

@default true

contentAlign
#

Type Align

Inherited from IContainerProperties

Horizontal alignment of Container's items.
contextMenuDisabled
#

Type boolean

Inherited from ISpriteProperties
cursorHoverEnabled
#

Type boolean

Inherited from IXYSeriesProperties

Indicates if series should apply hover state on bullets/columns/etc when cursor is over the data item.

@default true

cursorTooltipEnabled
#

Type boolean

Inherited from IXYSeriesProperties

Indicates if series should display a tooltip for chart's cursor.

@default true

disabled
#

Type boolean

Inherited from ISpriteProperties
draggable
#

Type boolean

Inherited from ISpriteProperties
dx
#

Type number

Inherited from ISpriteProperties
dy
#

Type number

Inherited from ISpriteProperties
excludeFromTotal
#

Type boolean

Inherited from IXYSeriesProperties

Indicates if series' values should be excluded when calculating totals.

@default false

fill
#

Type Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties
fillModifier
#

Type ColorModifier

Inherited from ISpriteProperties
fillOpacity
#

Type number

Inherited from ISpriteProperties
fixedWidthGrid
#

Type boolean

Inherited from IContainerProperties

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

@default false

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

Inherited from IContainerProperties

Default font weight.

@default "normal"

height
#

Type number | Percent

Inherited from ISpriteProperties
hidden
#

Type boolean

Inherited from ISpriteProperties
hiddenInLegend
#

Type boolean

Inherited from ISeriesProperties

Should series be hidden in chart's legend?
hideTooltipWhileZooming
#

Type boolean

Inherited from IXYSeriesProperties

Indicates if series' tooltip should be hidden while series axis range is animating (zooming)

@since 4.7.16
@default true

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

Inherited from IContainerProperties

Container layout.

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

@default "absolute"

marginBottom
#

Type number

Inherited from ISpriteProperties
marginLeft
#

Type number

Inherited from ISpriteProperties
marginRight
#

Type number

Inherited from ISpriteProperties
marginTop
#

Type number

Inherited from ISpriteProperties
maskBullets
#

Type boolean

Inherited from IXYSeriesProperties

Should series bullets be masked?

@default true
@since 4.7.17

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

Type number

Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Limits how many categories or base intervals can be shown at the same time.

If there are more items in the chart, the chart will auto-zoom.

@default 0 (no limit)

maxZoomFactor
#

Type number

Inherited from IComponentProperties

Maximum zoom factor of a component.
minBulletDistance
#

Type number

Inherited from ISeriesProperties

Minimal distance between data points in pixels.

If distance gets smaller than this, bullets are turned off to avoid overlapping.

0 (zero) disables this behavior.

@default 0

minHeight
#

Type number

Inherited from ISpriteProperties
minWidth
#

Type number

Inherited from ISpriteProperties
minX
#

Type number

Inherited from ISpriteProperties
minY
#

Type number

Inherited from ISpriteProperties
minZoomCount
#

Type number

Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Allows restricting zoom in beyond certain number of categories or base intervals.

The chart will not zoom in beyond this number of items.

@default 1

name
#

Type string

Inherited from ISeriesProperties

Series' name.
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

Inherited from IContainerProperties

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

@default false

role
#

Type Roles

Inherited from ISpriteProperties
rotation
#

Type number

Inherited from ISpriteProperties
scale
#

Type number

Inherited from ISpriteProperties
setStateOnChildren
#

Type boolean

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.

@default false

shapeRendering
#

Type ShapeRendering

Inherited from ISpriteProperties
showOnInit
#

Type boolean

Inherited from ISpriteProperties
showTooltipOn
#

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

Inherited from ISpriteProperties
snapTooltip
#

Type boolean

Inherited from IXYSeriesProperties

Should the nearest tooltip be shown if no data item is found on the current cursor position

@default false

stacked
#

Type boolean

Inherited from IXYSeriesProperties

Can items from this series be included into stacks?

@default false

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

Inherited from IContainerProperties

Default font decoration.

@default "none"

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 113 inherited items currently hidden from this list.