com.github.fluorumlabs.disconnect.highcharts

Interface SeriesMapOptions

All Superinterfaces:

Any, org.teavm.jso.JSObject, PlotMapOptions, SeriesOptions

public interface SeriesMapOptions
extends PlotMapOptions, SeriesOptions

(Highmaps) A map series. If the type option is not specified, it is inherited from chart.type. Configuration options for the series are given in three levels:

1. Options for all series in a chart are defined in the plotOptions.series object.
2. Options for all map series are defined in plotOptions.map.
3. Options for one single series are given in the series instance array.

(see online documentation for example)

See Also:

https://api.highcharts.com/highmaps/series.map

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SeriesMapOptions.Type

Nested classes/interfaces inherited from interface com.github.fluorumlabs.disconnect.highcharts.PlotMapOptions

PlotMapOptions.CompareBase, PlotMapOptions.DashStyle, PlotMapOptions.FindNearestPointBy, PlotMapOptions.GapUnit, PlotMapOptions.Linecap, PlotMapOptions.PointDescriptionFormatter, PlotMapOptions.PointIntervalUnit, PlotMapOptions.Stacking, PlotMapOptions.Step

Method Summary

Modifier and Type	Method and Description
Array<Unknown>	getData() (Highmaps) An array of data points for the series.
SeriesMapOptions.Type	getType() (Highcharts, Highstock, Highmaps) This property is only in TypeScript non-optional and might be undefined in series objects from unknown sources.
void	setData(Array<Unknown> value) (Highmaps) An array of data points for the series.
void	setType(SeriesMapOptions.Type value) (Highcharts, Highstock, Highmaps) This property is only in TypeScript non-optional and might be undefined in series objects from unknown sources.

Methods inherited from interface com.github.fluorumlabs.disconnect.highcharts.PlotMapOptions

getAllAreas, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostThreshold, getBorderColor, getBorderWidth, getClassName, getClip, getColor, getColorAxis, getColorIndex, getCompare, getCompareBase, getCompareStart, getConnectEnds, getConnectNulls, getConnectors, getCropThreshold, getCursor, getDashStyle, getDataGrouping, getDataLabels, getDescription, getDragDrop, getEnableMouseTracking, getEvents, getExposeElementToA11y, getFindNearestPointBy, getGapSize, getGapUnit, getGetExtremesFromAll, getJoinBy, getKeys, getLabel, getLinecap, getLineWidth, getLinkedTo, getNavigatorOptions, getNegativeColor, getNullColor, getNullInteraction, getPoint, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointRange, getPointStart, getSelected, getShowCheckbox, getShowInLegend, getShowInNavigator, getSkipKeyboardNavigation, getSoftThreshold, getStacking, getStates, getStep, getStickyTracking, getThreshold, getTooltip, getTurboThreshold, getVisible, getZIndex, getZoneAxis, getZones, setAllAreas, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostThreshold, setBorderColor, setBorderWidth, setClassName, setClip, setColor, setColor, setColor, setColorAxis, setColorIndex, setCompare, setCompareBase, setCompareStart, setConnectEnds, setConnectNulls, setConnectors, setCropThreshold, setCursor, setCursor, setDashStyle, setDataGrouping, setDataLabels, setDescription, setDragDrop, setEnableMouseTracking, setEvents, setExposeElementToA11y, setFindNearestPointBy, setGapSize, setGapUnit, setGetExtremesFromAll, setJoinBy, setKeys, setLabel, setLinecap, setLineWidth, setLinkedTo, setNavigatorOptions, setNegativeColor, setNegativeColor, setNegativeColor, setNullColor, setNullInteraction, setPoint, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointRange, setPointStart, setSelected, setShowCheckbox, setShowInLegend, setShowInNavigator, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStates, setStep, setStickyTracking, setThreshold, setTooltip, setTurboThreshold, setVisible, setZIndex, setZoneAxis, setZones

Methods inherited from interface com.github.fluorumlabs.disconnect.highcharts.SeriesOptions

getId, getIndex, getLegendIndex, getMapData, getName, getStack, getXAxis, getYAxis, getZIndex, setId, setIndex, setLegendIndex, setMapData, setMapData, setName, setStack, setStack, setType, setXAxis, setXAxis, setYAxis, setYAxis, setZIndex

Methods inherited from interface js.lang.Any

empty

Methods inherited from interface org.teavm.jso.JSObject

cast

Method Detail

getData

@Nullable
Array<Unknown> getData()

(Highmaps) An array of data points for the series. For the map series type, points can be given in the following ways:

1. An array of numerical values. In this case, the numerical values will be interpreted as value options. Example:(see online documentation for example)
2. An array of arrays with 2 values. In this case, the values correspond to [hc-key, value]. Example:(see online documentation for example)
3. An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.(see online documentation for example)

See Also:

https://api.highcharts.com/highmaps/series.map.data

setData

void setData(Array<Unknown> value)

(Highmaps) An array of data points for the series. For the map series type, points can be given in the following ways:

1. An array of numerical values. In this case, the numerical values will be interpreted as value options. Example:(see online documentation for example)
2. An array of arrays with 2 values. In this case, the values correspond to [hc-key, value]. Example:(see online documentation for example)
3. An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.(see online documentation for example)

See Also:

https://api.highcharts.com/highmaps/series.map.data

getType

SeriesMapOptions.Type getType()

(Highcharts, Highstock, Highmaps) This property is only in TypeScript non-optional and might be undefined in series objects from unknown sources.

Specified by:

getType in interface SeriesOptions

See Also:

https://api.highcharts.com/highcharts/series.type, https://api.highcharts.com/highstock/series.type, https://api.highcharts.com/highmaps/series.type

setType

void setType(SeriesMapOptions.Type value)

(Highcharts, Highstock, Highmaps) This property is only in TypeScript non-optional and might be undefined in series objects from unknown sources.