public class SeriesPlotOptions extends Optionable implements OptionDataListener
Series
.
All the options in this class support DynamicalAttribute
.
NOT_NULL_VALUE, options
Constructor and Description |
---|
SeriesPlotOptions() |
Modifier and Type | Method and Description |
---|---|
Animation |
getAnimation()
Returns whether to enable or disable the initial animation when a series
is displayed.
|
Number |
getBorderWidth()
Returns the border width of the series.
|
Color |
getColor()
Returns the main color of the series.
|
Object |
getColorAxis()
When using dual or multiple color axes, this defines which colorAxis
the particular series is connected to.
|
String |
getColorKey()
Returns what data value should be used to calculate point color if colorAxis is used.
|
Number |
getCropThreshold()
Returns when the series contains less points than the crop threshold, all
points are drawn, even if the points fall outside the visible plot area
at the current zoom.
|
String |
getCursor()
Returns 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.
|
String |
getDashStyle()
Returns a name for the dash style to use for the graph.
|
DataLabels |
getDataLabels()
Returns the option of data labels.
|
Number |
getDepth()
Returns the depth of the series in a 3D chart.
|
String |
getDescription()
Returns a description of the series to add to the screen reader information about the series.
|
DragDrop |
getDragDrop()
Returns the options of the draggable-points module allows points
to be moved around or modified in the chart, if any.
|
String |
getFindNearestPointBy()
Returns whether the series should look for the nearest point in both
dimensions or just the x-dimension when hovering the series.
|
Number |
getGroupPadding()
Returns padding between each value groups, in x axis units.
|
String |
getId()
Returns an id for the series.
|
SeriesLabel |
getLabel()
Returns series label options, if any.
|
String |
getLinecap()
Returns the line cap used for line ends and line joins on the graph.
|
Number |
getLineWidth()
Returns pixel with of the graph line.
|
String |
getLinkedTo()
Returns the
setId(String) of another series to link to. |
Marker |
getMarker()
Returns the series marker
|
String |
getNeckHeight()
Returns the neck height for funnel chart only.
|
String |
getNeckWidth()
Returns the neck width for funnel chart only.
|
Color |
getNegativeColor()
Returns the color for the parts of the graph or points that are
below the
setThreshold(Number) . |
Number |
getOpacity()
Returns opacity of a series parts: line, fill (e.g.
|
Number |
getPointInterval()
Returns if no x values are given for the points in a series,
pointInterval defines the interval of the x values.
|
String |
getPointIntervalUnit()
On datetime series, this allows for setting the pointInterval to the two
irregular time units, month and year.
|
Object |
getPointPlacement()
Returns the point placement.
|
Number |
getPointStart()
Returns if no x values are given for the points in a series, pointStart
defines on what value to start.
|
String |
getStacking()
Returns whether to stack the values of each series on top of each other.
|
States |
getStates()
Returns a wrapper object for all the series options in specific states.
|
String |
getStep()
Returns whether to apply steps to the line.
|
Number |
getThreshold()
Returns the threshold, also called zero level or base level.
|
TooltipPlotOptions |
getTooltip()
Returns a configuration object for the tooltip rendering of each single
series.
|
Number |
getTurboThreshold()
Returns 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.
|
String |
getZoneAxis()
Defines the Axis on which the zones are applied.
|
List<Zone> |
getZones()
An list defining zones within a series.
|
boolean |
isAllowPointSelect()
Returns to allow this series' points to be selected by clicking on the
markers, bars or pie slices.
|
boolean |
isAnimation()
Returns whether to enable or disable the initial animation when a series
is displayed.
|
boolean |
isClip()
Disable this option to allow series rendering in the whole plotting area.
|
boolean |
isColorByPoint()
Returns when using automatic point colors pulled from the
Charts.getColors() collection, this option determines whether the
chart should receive one color per series or one color per point. |
boolean |
isConnectEnds()
Returns polar charts only.
|
boolean |
isConnectNulls()
Returns whether to connect a graph line across null points.
|
boolean |
isEnableMouseTracking()
Returns enable or disable the mouse tracking for a specific series.
|
boolean |
isGetExtremesFromAll()
Returns 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.
|
boolean |
isIncludeInDataExport()
When set to false will prevent the series data from being included in any form of data export.
|
boolean |
isSelected()
Returns whether to select the series initially.
|
boolean |
isShadow()
Returns whether to apply a drop shadow to the graph line.
|
boolean |
isShowCheckbox()
Returns if true, a checkbox is displayed next to the legend item to allow
selecting the series.
|
boolean |
isShowInLegend()
Returns whether to display this particular series or series type in the
legend.
|
boolean |
isSkipKeyboardNavigation()
If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
|
boolean |
isSoftThreshold()
When this is true, the series will not cause the Y axis to cross the
zero plane (or threshold option) unless the data actually crosses the plane.
|
boolean |
isStacking()
Returns whether to stack the values of each series on top of each other or not.
|
boolean |
isStickyTracking()
Returns sticky tracking of mouse events.
|
boolean |
isVisible()
Returns set the initial visibility of the series.
|
void |
setAllowPointSelect(boolean allowPointSelect)
Sets to allow this series' points to be selected by clicking on the
markers, bars or pie slices.
|
void |
setAnimation(Animation animation)
Sets whether to enable or disable the initial animation when a series is
displayed.
|
void |
setAnimation(boolean animation)
Sets whether to enable or disable the initial animation when a series is
displayed.
|
void |
setBorderWidth(Number borderWidth)
Sets the border width of the series.
|
void |
setClip(boolean clip)
Disable this option to allow series rendering in the whole plotting area.
|
void |
setColor(Color color)
Sets the main color of the series.
|
void |
setColor(LinearGradient color)
Sets the main color of the series.
|
void |
setColor(RadialGradient color)
Sets the main color of the series.
|
void |
setColor(String color)
Sets the main color of the series.
|
void |
setColorAxis(boolean colorAxis)
When using dual or multiple color axes, this defines which colorAxis
the particular series is connected to.
|
void |
setColorAxis(Number colorAxis)
When using dual or multiple color axes, this defines which colorAxis
the particular series is connected to.
|
void |
setColorAxis(String colorAxis)
When using dual or multiple color axes, this defines which colorAxis
the particular series is connected to.
|
void |
setColorByPoint(boolean colorByPoint)
Sets when using automatic point colors pulled from the
Charts.getColors() collection, this option determines whether the
chart should receive one color per series or one color per point. |
void |
setColorKey(String colorKey)
Sets what data value should be used to calculate point color if colorAxis is used.
|
void |
setConnectEnds(boolean connectEnds)
Sets polar charts only.
|
void |
setConnectNulls(boolean connectNulls)
Sets whether to connect a graph line across null points.
|
void |
setCropThreshold(Number cropThreshold)
Sets when the series contains less points than the crop threshold, all
points are drawn, even if the points fall outside the visible plot area
at the current zoom.
|
void |
setCursor(String cursor)
Sets 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 |
setDashStyle(String dashStyle)
Sets a name for the dash style to use for the graph.
|
void |
setDataLabels(DataLabels dataLabels)
Sets the option of data labels.
|
void |
setDepth(Number depth)
Sets the depth of the series in a 3D chart.
|
void |
setDescription(String description)
Sets a description of the series to add to the screen reader information about the series.
|
void |
setDragDrop(DragDrop dragDrop)
Sets the options of the draggable-points module allows points
to be moved around or modified in the chart.
|
void |
setEnableMouseTracking(boolean enableMouseTracking)
Sets enable or disable the mouse tracking for a specific series.
|
void |
setFindNearestPointBy(String findNearestPointBy)
Sets 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)
Sets 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 |
setGroupPadding(Number groupPadding)
Sets padding between each value groups, in x axis units.
|
void |
setId(String id)
Sets an id for the series.
|
void |
setIncludeInDataExport(boolean includeInDataExport)
When set to false will prevent the series data from being included in any form of data export.
|
void |
setLabel(SeriesLabel label)
Sets series label options.
|
void |
setLinecap(String linecap)
Sets the line cap used for line ends and line joins on the graph.
|
void |
setLineWidth(Number lineWidth)
Sets pixel with of the graph line.
|
void |
setLinkedTo(String linkedTo)
Sets the
setId(String) of another series to link to. |
void |
setMarker(Marker marker)
Sets the series marker
|
void |
setNeckHeight(String neckHeight)
Sets the neck height for funnel chart only.
|
void |
setNeckWidth(String neckWidth)
Sets the neck width for funnel chart only.
|
void |
setNegativeColor(Color color)
Sets the color for the parts of the graph or points that are
below the
setThreshold(Number) . |
void |
setNegativeColor(LinearGradient color)
Sets the color for the parts of the graph or points that are
below the
setThreshold(Number) . |
void |
setNegativeColor(RadialGradient color)
Sets the color for the parts of the graph or points that are
below the
setThreshold(Number) . |
void |
setNegativeColor(String color)
Sets the color for the parts of the graph or points that are
below the
setThreshold(Number) . |
void |
setOpacity(Number opacity)
Sets opacity of a series parts: line, fill (e.g.
|
void |
setPointInterval(Number pointInterval)
Sets if no x values are given for the points in a series, pointInterval
defines the interval of the x values.
|
void |
setPointIntervalUnit(String pointIntervalUnit)
Set the irregular time unit for point interval, only "month" or "year" is allowed.
|
void |
setPointPlacement(Number pointPlacement)
Sets the point placement with a number
|
void |
setPointPlacement(String pointPlacement)
Sets the point placement.
|
void |
setPointStart(Number pointStart)
Sets if no x values are given for the points in a series, pointStart
defines on what value to start.
|
void |
setSelected(boolean selected)
Sets whether to select the series initially.
|
void |
setShadow(boolean shadow)
Sets whether to apply a drop shadow to the graph line.
|
void |
setShowCheckbox(boolean showCheckbox)
Sets if true, a checkbox is displayed next to the legend item to allow
selecting the series.
|
void |
setShowInLegend(boolean showInLegend)
Sets whether to display this particular series or series type 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 |
setSoftThreshold(boolean softThreshold)
When this is true, the series will not cause the Y axis to cross the
zero plane (or threshold option) unless the data actually crosses the plane.
|
void |
setStacking(Boolean stacking) |
void |
setStacking(String stacking)
Sets whether to stack the values of each series on top of each other.
|
void |
setStates(States states)
Sets a wrapper object for all the series options in specific states.
|
void |
setStep(String step)
Sets whether to apply steps to the line.
|
void |
setStickyTracking(boolean stickyTracking)
Sets sticky tracking of mouse events.
|
void |
setThreshold(Number threshold)
Sets the threshold, also called zero level or base level.
|
void |
setTooltip(TooltipPlotOptions tooltip)
Sets a configuration object for the tooltip rendering of each single
series.
|
void |
setTurboThreshold(Number turboThreshold)
Sets 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)
Sets set the initial visibility of the series.
|
void |
setZoneAxis(String zoneAxis)
Set the axis on which the zones are applied.
|
void |
setZones(List<Zone> zones)
Set the zones within a series.
|
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, toJSONString, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
onChange
public boolean isAllowPointSelect()
Default: false
public void setAllowPointSelect(boolean allowPointSelect)
Default: false
public boolean isAnimation()
Animation
object. Please note that this option only applies to the initial
animation of the series itself. For other animations, see
Chart.setAnimation(Animation)
and the animation parameter under
the API methods. The following properties are supported:
linear
or swing
. More easing functions are
available with the use of jQuery plug-ins, most notably the jQuery UI
suite. See the jQuery docs.
When using MooTools as the general framework, use the property name
transition
instead of easing
.due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
public Animation getAnimation()
public void setAnimation(boolean animation)
Animation
object.
Please note that this option only applies to the initial animation of the
series itself. For other animations, see
Chart.setAnimation(Animation)
and the animation parameter under
the API methods. The following properties are supported:
linear
or swing
. More easing functions are
available with the use of jQuery plug-ins, most notably the jQuery UI
suite. See the jQuery docs.
When using MooTools as the general framework, use the property name
transition
instead of easing
.due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
setAnimation(Animation)
,
Animation
public void setAnimation(Animation animation)
Animation
object.
Please note that this option only applies to the initial animation of the
series itself. For other animations, see
Chart.setAnimation(Animation)
and the animation parameter under
the API methods. The following properties are supported:
linear
or swing
. More easing functions are
available with the use of jQuery plug-ins, most notably the jQuery UI
suite. See the jQuery docs.
When using MooTools as the general framework, use the property name
transition
instead of easing
.due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
setAnimation(boolean)
,
Animation
public Number getBorderWidth()
Default: null
public void setBorderWidth(Number borderWidth)
public boolean isClip()
Default: true
public void setClip(boolean clip)
public Color getColor()
Charts.getColors()
array.public void setColor(Color color)
Charts.getColors()
array.public void setColor(String color)
Charts.getColors()
array.public void setColor(LinearGradient color)
Charts.getColors()
array.public void setColor(RadialGradient color)
Charts.getColors()
array.public Object getColorAxis()
Axis.getId()
or the index of the axis in the colorAxis array, with 0 being the first.
Set this option to false to prevent a series from connecting to the default color axis.
Default: 0
public void setColorAxis(Number colorAxis)
public boolean isColorByPoint()
Charts.getColors()
collection, this option determines whether the
chart should receive one color per series or one color per point.
Default: false.
public void setColorByPoint(boolean colorByPoint)
Charts.getColors()
collection, this option determines whether the
chart should receive one color per series or one color per point.public void setColorAxis(String colorAxis)
Axis.getId()
.public void setColorAxis(boolean colorAxis)
public String getColorKey()
Default: "y"
public void setColorKey(String colorKey)
public boolean isConnectEnds()
public void setConnectEnds(boolean connectEnds)
public boolean isConnectNulls()
public void setConnectNulls(boolean connectNulls)
public Number getCropThreshold()
public void setCropThreshold(Number cropThreshold)
public String getCursor()
public void setCursor(String cursor)
public String getDashStyle()
line
, spline
,
area
and scatter
in case it has a
lineWidth
. The value for the dashStyle
include:
public void setDashStyle(String dashStyle)
line
, spline
,
area
and scatter
in case it has a
lineWidth
. The value for the dashStyle
include:
public DataLabels getDataLabels()
public void setDataLabels(DataLabels dataLabels)
DataLabels
public Number getDepth()
Default: 25
public void setDepth(Number depth)
public String getDescription()
Default: null
public void setDescription(String description)
public DragDrop getDragDrop()
public void setDragDrop(DragDrop dragDrop)
public boolean isEnableMouseTracking()
public void setEnableMouseTracking(boolean enableMouseTracking)
public String getFindNearestPointBy()
Default: "x"
public void setFindNearestPointBy(String findNearestPointBy)
public boolean isGetExtremesFromAll()
Default: false
public void setGetExtremesFromAll(boolean getExtremesFromAll)
public Number getGroupPadding()
Default: 0.2
public void setGroupPadding(Number groupPadding)
public String getId()
public void setId(String id)
public boolean isIncludeInDataExport()
Default: true
public void setIncludeInDataExport(boolean includeInDataExport)
public SeriesLabel getLabel()
public void setLabel(SeriesLabel label)
public String getLinecap()
Default: "round"
public void setLinecap(String linecap)
public Number getLineWidth()
public void setLineWidth(Number lineWidth)
public String getLinkedTo()
setId(String)
of another series to link to.
Additionally, the value can be ":previous" to link to the previous
series. When two series are linked, only the first one appears in the
legend. Toggling the visibility of this also toggles the linked series.public void setLinkedTo(String linkedTo)
setId(String)
of another series to link to.
Additionally, the value can be ":previous" to link to the previous
series. When two series are linked, only the first one appears in the
legend. Toggling the visibility of this also toggles the linked series.public Marker getMarker()
public void setMarker(Marker marker)
public String getNeckHeight()
public void setNeckHeight(String neckHeight)
public String getNeckWidth()
public void setNeckWidth(String neckWidth)
public Color getNegativeColor()
setThreshold(Number)
.
Defaults to null.
public void setNegativeColor(Color color)
setThreshold(Number)
.
Defaults to null.
public void setNegativeColor(String color)
setThreshold(Number)
.
Defaults to null.
public void setNegativeColor(LinearGradient color)
setThreshold(Number)
.
Defaults to null.
public void setNegativeColor(RadialGradient color)
setThreshold(Number)
.
Defaults to null.
public Number getOpacity()
Default: 1
public void setOpacity(Number opacity)
public Number getPointInterval()
Default: 1
public void setPointInterval(Number pointInterval)
Default: 1
public String getPointIntervalUnit()
Default: null
public void setPointIntervalUnit(String pointIntervalUnit)
pointIntervalUnit
- either "month" or "year"public Object getPointPlacement()
Possible values: null, "on", "between" or numeric.
In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
The point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Defaults to null
in cartesian charts, "between"
in polar charts.
public void setPointPlacement(String pointPlacement)
Possible values: null, "on", "between".
In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
Defaults to null
in cartesian charts, "between"
in polar charts.
public void setPointPlacement(Number pointPlacement)
The point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
public Number getPointStart()
public void setPointStart(Number pointStart)
public boolean isSelected()
showCheckbox
is true, the checkbox next to the series name
will be checked for a selected series.public void setSelected(boolean selected)
showCheckbox
is true, the checkbox next to the series name will be checked for a
selected series.public boolean isShadow()
color
,
offsetX
, offsetY
, opacity
and
width
.public void setShadow(boolean shadow)
color
,
offsetX
, offsetY
, opacity
and
width
.public boolean isShowCheckbox()
selected
option.public void setShowCheckbox(boolean showCheckbox)
selected
option.public boolean isShowInLegend()
true
for standalone series,
false
for linked series.public void setShowInLegend(boolean showInLegend)
true
for standalone series,
false
for linked series.public boolean isSkipKeyboardNavigation()
Default: false
public void setSkipKeyboardNavigation(boolean skipKeyboardNavigation)
public boolean isSoftThreshold()
Default: true
public void setSoftThreshold(boolean softThreshold)
public String getStacking()
public boolean isStacking()
public void setStacking(String stacking)
public void setStacking(Boolean stacking)
public States getStates()
public void setStates(States states)
public String getStep()
left
, center
and right
.
Default: null
public void setStep(String step)
left
, center
and right
.public boolean isStickyTracking()
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.isShared()
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.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.isShared()
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.public Number getThreshold()
setNegativeColor(String)
public void setThreshold(Number threshold)
setNegativeColor(String)
public TooltipPlotOptions getTooltip()
Tooltip
, but only the
following properties can be defined on a series level.public void setTooltip(TooltipPlotOptions tooltip)
Tooltip
, but only the
following properties can be defined on a series level.public Number getTurboThreshold()
0
disable.public void setTurboThreshold(Number turboThreshold)
0
disable.public boolean isVisible()
public void setVisible(boolean visible)
public String getZoneAxis()
public void setZoneAxis(String zoneAxis)
zoneAxis
- either "x", "y", or "z"public List<Zone> getZones()
Zone
public void setZones(List<Zone> zones)
getZones()
,
Zone
Copyright © 2005-2020 Potix Corporation. All Rights Reserved.