@Generated(value="This class is generated and shouldn\'t be modified", comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new") public class PlotOptionsTreemap extends AbstractPlotOptions
heatmap.js
as well, if
functionality such as the colorAxis is to be
used.Constructor and Description |
---|
PlotOptionsTreemap() |
Modifier and Type | Method and Description |
---|---|
void |
addKey(String key)
Adds key to the keys array
|
void |
addLevel(Level level)
Adds level to the levels array
|
void |
addZone(Zones zone)
Adds zone to the zones array
|
Boolean |
getAllowDrillToNode() |
Boolean |
getAllowPointSelect() |
Boolean |
getAlternateStartingDirection() |
Boolean |
getAnimation() |
Number |
getAnimationLimit() |
ChartType |
getChartType() |
String |
getClassName() |
Boolean |
getColorByPoint() |
Number |
getColorIndex() |
Boolean |
getCrisp() |
Number |
getCropThreshold() |
Cursor |
getCursor() |
DataLabels |
getDataLabels() |
String |
getDescription() |
Boolean |
getEnableMouseTracking() |
Boolean |
getExposeElementToA11y() |
Dimension |
getFindNearestPointBy() |
Boolean |
getGetExtremesFromAll() |
Boolean |
getIgnoreHiddenPoint() |
Boolean |
getInteractByLeaf() |
String[] |
getKeys() |
TreeMapLayoutAlgorithm |
getLayoutAlgorithm() |
TreeMapLayoutStartingDirection |
getLayoutStartingDirection() |
Boolean |
getLevelIsConstant() |
Level[] |
getLevels() |
String |
getLinkedTo() |
Number |
getMaxPointWidth() |
Number |
getOpacity() |
String |
getPointDescriptionFormatter() |
Boolean |
getSelected() |
Boolean |
getShadow() |
Boolean |
getShowCheckbox() |
Boolean |
getShowInLegend() |
Boolean |
getSkipKeyboardNavigation() |
Number |
getSortIndex() |
States |
getStates() |
Boolean |
getStickyTracking() |
SeriesTooltip |
getTooltip() |
Number |
getTurboThreshold() |
Boolean |
getVisible() |
ZoneAxis |
getZoneAxis() |
Zones[] |
getZones() |
void |
removeKey(String key)
Removes first occurrence of key in keys array
|
void |
removeLevel(Level level)
Removes first occurrence of level in levels array
|
void |
removeZone(Zones zone)
Removes first occurrence of zone in zones array
|
void |
setAllowDrillToNode(Boolean allowDrillToNode)
When enabled the user can click on a point which is a parent and zoom in
on its children.
|
void |
setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers, bars
or pie slices.
|
void |
setAlternateStartingDirection(Boolean alternateStartingDirection)
Enabling this option will make the treemap alternate the drawing
direction between vertical and horizontal.
|
void |
setAnimation(Boolean animation)
Enable or disable the initial animation when a series is displayed.
|
void |
setAnimationLimit(Number animationLimit)
For some series, there is a limit that shuts down initial animation by
default when the total number of points in the chart is too high.
|
void |
setClassName(String className)
A class name to apply to the series' graphical elements.
|
void |
setColorByPoint(Boolean colorByPoint)
When using automatic point colors pulled from the
options.colors collection, this option determines whether
the chart should receive one color per series or one color per point. |
void |
setColorIndex(Number colorIndex)
Styled mode only.
|
void |
setCrisp(Boolean crisp)
When true, each column edge is rounded to its nearest pixel in order to
render sharp on screen.
|
void |
setCropThreshold(Number cropThreshold)
When the series contains less points than the crop threshold, all points
are drawn, event if the points fall outside the visible plot area at the
current zoom.
|
void |
setCursor(Cursor cursor)
You can set the cursor to "pointer" if you have click events attached to
the series, to signal to the user that the points and lines can be
clicked.
|
void |
setDataLabels(DataLabels dataLabels) |
void |
setDescription(String description)
Requires Accessibility module
|
void |
setEnableMouseTracking(Boolean enableMouseTracking)
Enable or disable the mouse tracking for a specific series.
|
void |
setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions.
|
void |
setFindNearestPointBy(Dimension findNearestPointBy)
Determines whether the series should look for the nearest point in both
dimensions or just the x-dimension when hovering the series.
|
void |
setGetExtremesFromAll(Boolean getExtremesFromAll)
Whether to use the Y extremes of the total chart width or only the zoomed
area when zooming in on parts of the X axis.
|
void |
setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)
Whether to ignore hidden points when the layout algorithm runs.
|
void |
setInteractByLeaf(Boolean interactByLeaf)
This option decides if the user can interact with the parent nodes or
just the leaf nodes.
|
void |
setKeys(String... keys)
An array specifying which option maps to which key in the data point
array.
|
void |
setLayoutAlgorithm(TreeMapLayoutAlgorithm layoutAlgorithm)
This option decides which algorithm is used for setting position and
dimensions of the points.
|
void |
setLayoutStartingDirection(TreeMapLayoutStartingDirection layoutStartingDirection)
Defines which direction the layout algorithm will start drawing.
|
void |
setLevelIsConstant(Boolean levelIsConstant)
Used together with the levels and allowDrillToNode options.
|
void |
setLevels(Level... levels)
Set options on specific levels.
|
void |
setLinkedTo(String linkedTo)
The id of another series to link to.
|
void |
setMaxPointWidth(Number maxPointWidth)
The maximum allowed pixel width for a column, translated to the height of
a bar in a bar chart.
|
void |
setOpacity(Number opacity)
The opacity of a point in treemap.
|
void |
setPointDescriptionFormatter(String _fn_pointDescriptionFormatter) |
void |
setSelected(Boolean selected)
Whether to select the series initially.
|
void |
setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line.
|
void |
setShowCheckbox(Boolean showCheckbox)
If true, a checkbox is displayed next to the legend item to allow
selecting the series.
|
void |
setShowInLegend(Boolean showInLegend)
Whether to display this series type or specific series item in the
legend.
|
void |
setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
If set to
True , the accessibility module will skip past the
points in this series for keyboard navigation. |
void |
setSortIndex(Number sortIndex)
The sort index of the point inside the treemap level.
|
void |
setStates(States states)
A wrapper object for all the series options in specific states.
|
void |
setStickyTracking(Boolean stickyTracking)
Sticky tracking of mouse events.
|
void |
setTooltip(SeriesTooltip tooltip) |
void |
setTurboThreshold(Number turboThreshold)
When a series contains a data array that is longer than this, only one
dimensional arrays of numbers, or two dimensional arrays with x and y
values are allowed.
|
void |
setVisible(Boolean visible)
Set the initial visibility of the series.
|
void |
setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
|
void |
setZones(Zones... zones)
An array defining zones within a series.
|
public ChartType getChartType()
getChartType
in class AbstractPlotOptions
public Boolean getAllowDrillToNode()
setAllowDrillToNode(Boolean)
public void setAllowDrillToNode(Boolean allowDrillToNode)
Defaults to: false
public Boolean getAllowPointSelect()
setAllowPointSelect(Boolean)
public void setAllowPointSelect(Boolean allowPointSelect)
Defaults to: false
public Boolean getAlternateStartingDirection()
setAlternateStartingDirection(Boolean)
public void setAlternateStartingDirection(Boolean alternateStartingDirection)
Defaults to: false
public Boolean getAnimation()
setAnimation(Boolean)
public void setAnimation(Boolean animation)
ChartModel.setAnimation(Boolean)
public Number getAnimationLimit()
setAnimationLimit(Number)
public void setAnimationLimit(Number animationLimit)
animationLimit
to Infinity
.public String getClassName()
setClassName(String)
public void setClassName(String className)
public Boolean getColorByPoint()
setColorByPoint(Boolean)
public void setColorByPoint(Boolean colorByPoint)
options.colors
collection, this option determines whether
the chart should receive one color per series or one color per point.
Defaults to: false
public Number getColorIndex()
setColorIndex(Number)
public void setColorIndex(Number colorIndex)
highcharts-color-{n}
.public Boolean getCrisp()
setCrisp(Boolean)
public void setCrisp(Boolean crisp)
crisp
to
false
may look better, even though each column is rendered
blurry.
Defaults to: true
public Number getCropThreshold()
setCropThreshold(Number)
public void setCropThreshold(Number cropThreshold)
Defaults to: 300
public Cursor getCursor()
setCursor(Cursor)
public void setCursor(Cursor cursor)
public DataLabels getDataLabels()
setDataLabels(DataLabels)
public void setDataLabels(DataLabels dataLabels)
public String getDescription()
setDescription(String)
public void setDescription(String description)
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
public Boolean getEnableMouseTracking()
setEnableMouseTracking(Boolean)
public void setEnableMouseTracking(Boolean enableMouseTracking)
Defaults to: true
public Boolean getExposeElementToA11y()
setExposeElementToA11y(Boolean)
public void setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
public Dimension getFindNearestPointBy()
setFindNearestPointBy(Dimension)
public void setFindNearestPointBy(Dimension findNearestPointBy)
Determines whether the series should look for the nearest point in both
dimensions or just the x-dimension when hovering the series. Defaults to
'xy'
for scatter series and 'x'
for most other
series. If the data has duplicate x-values, it is recommended to set this
to 'xy'
to allow hovering over all points.
Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
public Boolean getGetExtremesFromAll()
setGetExtremesFromAll(Boolean)
public void setGetExtremesFromAll(Boolean getExtremesFromAll)
Defaults to: false
public Boolean getIgnoreHiddenPoint()
setIgnoreHiddenPoint(Boolean)
public void setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)
false
, hidden points will leave open spaces.
Defaults to: true
public Boolean getInteractByLeaf()
setInteractByLeaf(Boolean)
public void setInteractByLeaf(Boolean interactByLeaf)
public String[] getKeys()
setKeys(String...)
public void setKeys(String... keys)
public void addKey(String key)
key
- to addsetKeys(String...)
public void removeKey(String key)
key
- to removesetKeys(String...)
public TreeMapLayoutAlgorithm getLayoutAlgorithm()
public void setLayoutAlgorithm(TreeMapLayoutAlgorithm layoutAlgorithm)
sliceAndDice
,
stripes
, squarified
or strip
.
Defaults to: sliceAndDice
public TreeMapLayoutStartingDirection getLayoutStartingDirection()
public void setLayoutStartingDirection(TreeMapLayoutStartingDirection layoutStartingDirection)
Defaults to: vertical
public Boolean getLevelIsConstant()
setLevelIsConstant(Boolean)
public void setLevelIsConstant(Boolean levelIsConstant)
Defaults to: true
public Level[] getLevels()
setLevels(Level...)
public void setLevels(Level... levels)
public void addLevel(Level level)
level
- to addsetLevels(Level...)
public void removeLevel(Level level)
level
- to removesetLevels(Level...)
public String getLinkedTo()
setLinkedTo(String)
public void setLinkedTo(String linkedTo)
public Number getMaxPointWidth()
setMaxPointWidth(Number)
public void setMaxPointWidth(Number maxPointWidth)
Defaults to: null
public Number getOpacity()
setOpacity(Number)
public void setOpacity(Number opacity)
Defaults to: 0.15
public String getPointDescriptionFormatter()
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
public Boolean getSelected()
setSelected(Boolean)
public void setSelected(Boolean selected)
showCheckbox
is
true, the checkbox next to the series name will be checked for a selected
series.
Defaults to: false
public Boolean getShadow()
setShadow(Boolean)
public void setShadow(Boolean shadow)
color
,
offsetX
, offsetY
, opacity
and
width
.
Defaults to: false
public Boolean getShowCheckbox()
setShowCheckbox(Boolean)
public void setShowCheckbox(Boolean showCheckbox)
selected
option.
Defaults to: false
public Boolean getShowInLegend()
setShowInLegend(Boolean)
public void setShowInLegend(Boolean showInLegend)
Defaults to: false
public Boolean getSkipKeyboardNavigation()
setSkipKeyboardNavigation(Boolean)
public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
True
, the accessibility module will skip past the
points in this series for keyboard navigation.public Number getSortIndex()
setSortIndex(Number)
public void setSortIndex(Number sortIndex)
public States getStates()
setStates(States)
public void setStates(States states)
public Boolean getStickyTracking()
setStickyTracking(Boolean)
public void setStickyTracking(Boolean stickyTracking)
mouseOut
event on a series isn't triggered until the mouse moves over another
series, or out of the plot area. When false, the mouseOut
event on a series is triggered when the mouse leaves the area around the
series' graph or markers. This also implies the tooltip. When
stickyTracking
is false and tooltip.shared
is
false, the tooltip will be hidden when moving the mouse between series.
Defaults to true for line and area type series, but to false for columns,
pies etc.
Defaults to: true
public SeriesTooltip getTooltip()
setTooltip(SeriesTooltip)
public void setTooltip(SeriesTooltip tooltip)
public Number getTurboThreshold()
setTurboThreshold(Number)
public void setTurboThreshold(Number turboThreshold)
0
disable.
Defaults to: 1000
public Boolean getVisible()
setVisible(Boolean)
public void setVisible(Boolean visible)
Defaults to: true
public ZoneAxis getZoneAxis()
setZoneAxis(ZoneAxis)
public void setZoneAxis(ZoneAxis zoneAxis)
Defaults to: y
public Zones[] getZones()
setZones(Zones...)
public void setZones(Zones... zones)
An array defining zones within a series. Zones can be applied to the X
axis, Y axis or Z axis for bubbles, according to the
zoneAxis
option.
In styled mode, the color zones are styled with the
.highcharts-zone-{n}
class, or custom classed from the
className
option (view live demo).
public void addZone(Zones zone)
zone
- to addsetZones(Zones...)
public void removeZone(Zones zone)
zone
- to removesetZones(Zones...)
Copyright © 2019. All rights reserved.