org.fujion.highcharts

Class MarkerOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.MarkerOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class MarkerOptions
extends Options

Options for point markers.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	enabled Enable or disable the point marker.
Integer	enabledThreshold The threshold for how dense the point markers should be before they are hidden, given that enabled is not defined.
String	fillColor he fill color of the point marker.
Integer	height Image markers only.
MarkerStateOptions	hover_state Marker states for hover.
String	lineColor The color of the point marker's outline.
Integer	lineWidth The width of the point marker's outline.
Integer	radius The radius of the point marker.
MarkerStateOptions	select_state Marker states for select.
OptionMap	states Hover and select states.
String	symbol A predefined shape or symbol for the marker.
Integer	width Image markers only.

Constructor Summary

Constructors

Constructor and Description
MarkerOptions()

Method Summary

Modifier and Type	Method and Description
OptionMap	toMap()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

enabled

@Option
public Boolean enabled

Enable or disable the point marker. Defaults to true.

enabledThreshold

@Option
public Integer enabledThreshold

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. Defaults to 2.

fillColor

@Option
public String fillColor

he fill color of the point marker. When null, the series' or point's color is used. Defaults to null.

height

@Option
public Integer height

Image markers only. Set the image width explicitly. When using this option, a width must also be set. Defaults to null.

lineColor

@Option
public String lineColor

The color of the point marker's outline. When null, the series' or point's color is used. Defaults to "#FFFFFF".

lineWidth

@Option
public Integer lineWidth

The width of the point marker's outline. Defaults to 0.

radius

@Option
public Integer radius

The radius of the point marker. Defaults to 0.

hover_state

@Option(ignore=true)
public final MarkerStateOptions hover_state

Marker states for hover.

select_state

@Option(ignore=true)
public final MarkerStateOptions select_state

Marker states for select.

states

@Option
public final OptionMap states

Hover and select states.

symbol

@Option
public String symbol

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)". Defaults to null.

width

@Option
public Integer width

Image markers only. Set the image width explicitly. When using this option, a height must also be set. Defaults to null.

Constructor Detail

MarkerOptions

public MarkerOptions()

Method Detail

toMap

public OptionMap toMap()

Specified by:

toMap in interface OptionMap.IOptionMapConverter

Overrides:

toMap in class Options