Class Marker
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.Marker
-
- All Implemented Interfaces:
Serializable
,OptionDataListener
,org.zkoss.json.JSONAware
- Direct Known Subclasses:
LowMarker
public class Marker extends Optionable
The options for the markerAll the options in this class support
DynamicalAttribute
.- Author:
- RaymondChao
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.zkoss.chart.Optionable
NOT_NULL_VALUE, options
-
-
Constructor Summary
Constructors Constructor Description Marker()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Number
getEnabledThreshold()
Returns the threshold for how dense the point markers should be before they are hidden, given that enabled is not defined.Color
getFillColor()
Returns the fill color of the point marker.Number
getFillOpacity()
Returns fill opacity for the point marker.Number
getHeight()
Returns the image height explicitly.Color
getLineColor()
Returns the color of the point marker's outline.Number
getLineWidth()
Returns the width of the point marker's outline.Number
getRadius()
Returns the radius of the point marker.States
getStates()
Returns a wrapper object for all the series options in specific states.String
getSymbol()
Returns a predefined shape or symbol for the marker.Number
getWidth()
Returns the image width explicitly.boolean
isEnabled()
Returns enable or disable the point marker.void
setEnabled(boolean enabled)
Sets enable or disable the point marker.void
setEnabledThreshold(Number enabledThreshold)
Sets the threshold for how dense the point markers should be before they are hidden, given that enabled is not defined.void
setFillColor(String color)
Sets the fill color of the point marker.void
setFillColor(Color color)
Sets the fill color of the point marker.void
setFillColor(LinearGradient color)
Sets the fill color of the point marker.void
setFillColor(RadialGradient color)
Sets the fill color of the point marker.void
setFillOpacity(Number fillOpacity)
Sets fill opacity for the point marker.void
setHeight(Number height)
Sets the image height explicitly.void
setHeight(String height)
Sets the image height explicitly.void
setLineColor(String color)
Sets the color of the point marker's outline.void
setLineColor(Color color)
Sets the color of the point marker's outline.void
setLineColor(LinearGradient color)
Sets the color of the point marker's outline.void
setLineColor(RadialGradient color)
Sets the color of the point marker's outline.void
setLineWidth(Number lineWidth)
Sets the width of the point marker's outline.void
setRadius(Number radius)
Sets the radius of the point marker.void
setRadius(String radius)
Sets the radius of the point marker.void
setStates(States states)
Sets a wrapper object for all the series options in specific states.void
setSymbol(String symbol)
Sets a predefined shape or symbol for the marker.void
setWidth(Number width)
Sets the image width explicitly.void
setWidth(String width)
Sets the image width explicitly.-
Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString
-
-
-
-
Method Detail
-
isEnabled
public boolean isEnabled()
Returns enable or disable the point marker.Default: true
-
setEnabled
public void setEnabled(boolean enabled)
Sets enable or disable the point marker.
-
getEnabledThreshold
public Number getEnabledThreshold()
Returns the threshold for how dense the point markers should be before they are hidden, given that enabled is not defined. The number indicates the horizontal distance between the two closest points in the series, as multiples of the marker.radius. In other words, the default value of 2 means points are hidden if overlapping horizontally.Default: 2
- Since:
- 7.2.1.0
-
setEnabledThreshold
public void setEnabledThreshold(Number enabledThreshold)
Sets the threshold for how dense the point markers should be before they are hidden, given that enabled is not defined. The number indicates the horizontal distance between the two closest points in the series, as multiples of the marker.radius. In other words, the default value of 2 means points are hidden if overlapping horizontally.- Since:
- 7.2.1.0
-
getFillColor
public Color getFillColor()
Returns the fill color of the point marker. Whennull
, the series' or point's color is used.Default: null
-
setFillColor
public void setFillColor(Color color)
Sets the fill color of the point marker. Whennull
, the series' or point's color is used.
-
setFillColor
public void setFillColor(String color)
Sets the fill color of the point marker. Whennull
, the series' or point's color is used.
-
setFillColor
public void setFillColor(LinearGradient color)
Sets the fill color of the point marker. Whennull
, the series' or point's color is used.
-
setFillColor
public void setFillColor(RadialGradient color)
Sets the fill color of the point marker. Whennull
, the series' or point's color is used.
-
getFillOpacity
public Number getFillOpacity()
Returns fill opacity for the point marker.Default: null
- Since:
- 7.2.1.0
-
setFillOpacity
public void setFillOpacity(Number fillOpacity)
Sets fill opacity for the point marker.- Since:
- 7.2.1.0
-
getHeight
public Number getHeight()
Returns the image height explicitly. It is used in image markers only. When using this option, a width must also be set. Defaults to nullDefault: null
-
setHeight
public void setHeight(Number height)
Sets the image height explicitly. It is used in image markers only. When using this option, a width must also be set. Defaults to null
-
setHeight
public void setHeight(String height)
Sets the image height explicitly. It is used in image markers only. When using this option, a width must also be set. Defaults to null- Since:
- 10.3.3.0
-
getLineColor
public Color getLineColor()
Returns the color of the point marker's outline. Whennull
, the series' or point's color is used.Default: "#FFFFFF"
-
setLineColor
public void setLineColor(Color color)
Sets the color of the point marker's outline. Whennull
, the series' or point's color is used. 'lineColor the color of the point marker's outline. Whennull
, the series' or point's color is used.
-
setLineColor
public void setLineColor(String color)
Sets the color of the point marker's outline. Whennull
, the series' or point's color is used. 'lineColor the color of the point marker's outline. Whennull
, the series' or point's color is used.
-
setLineColor
public void setLineColor(LinearGradient color)
Sets the color of the point marker's outline. Whennull
, the series' or point's color is used. 'lineColor the color of the point marker's outline. Whennull
, the series' or point's color is used.
-
setLineColor
public void setLineColor(RadialGradient color)
Sets the color of the point marker's outline. Whennull
, the series' or point's color is used. 'lineColor the color of the point marker's outline. Whennull
, the series' or point's color is used.
-
getLineWidth
public Number getLineWidth()
Returns the width of the point marker's outline.Default: 0
-
setLineWidth
public void setLineWidth(Number lineWidth)
Sets the width of the point marker's outline. 'lineWidth the width of the point marker's outline.
-
getRadius
public Number getRadius()
Returns the radius of the point marker.Default: 4
-
setRadius
public void setRadius(Number radius)
Sets the radius of the point marker. the radius of the point marker.
-
setRadius
public void setRadius(String radius)
Sets the radius of the point marker. the radius of the point marker.- Since:
- 10.3.3.0
-
getStates
public States getStates()
Returns a wrapper object for all the series options in specific states.
-
setStates
public void setStates(States states)
Sets a wrapper object for all the series options in specific states.
-
getSymbol
public String getSymbol()
Returns a predefined shape or symbol for the marker. When null, the symbol is pulled from options.symbols. Other possible values are "circle", "square", "diamond", "triangle" and "triangle-down".Additionally, the URL to a graphic can be given on this form: "url(graphic.png)". Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.
Custom callbacks for symbol path generation can also be added to
Highcharts.SVGRenderer.prototype.symbols
. The callback is then used by its method name, as shown in the demo.
-
setSymbol
public void setSymbol(String symbol)
Sets a predefined shape or symbol for the marker. When null, the symbol is pulled from options.symbols. Other possible values are "circle", "square", "diamond", "triangle" and "triangle-down".Additionally, the URL to a graphic can be given on this form: "url(graphic.png)". Note that for the image to be applied to exported charts, its URL needs to be accessible by the export server.
Custom callbacks for symbol path generation can also be added to
Highcharts.SVGRenderer.prototype.symbols
. The callback is then used by its method name, as shown in the demo.
-
getWidth
public Number getWidth()
Returns the image width explicitly. It is used in image markers only. When using this option, a height must also be set. Defaults to nullDefault: null
-
setWidth
public void setWidth(Number width)
Sets the image width explicitly. It is used in image markers only. When using this option, a height must also be set. Defaults to null
-
setWidth
public void setWidth(String width)
Sets the image width explicitly. It is used in image markers only. When using this option, a height must also be set. Defaults to null- Since:
- 10.3.3.0
-
-