Package net.pricefx.server.dto.calculation

Class ResultHighmap

Object

AbstractPortletDto

ResultHighchart

ResultHighmap

All Implemented Interfaces:

Serializable, Portlet, ComplexCalculationResult

public class ResultHighmap
extends ResultHighchart

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ResultHighchart

ResultHighchart.ContextMenu, ResultHighchart.ContextMenuItem, ResultHighchart.OnPointClick, ResultHighchart.TriggerEvent

Field Summary

Fields inherited from class AbstractPortletDto

dragDropEnabled, layout, messages, resizingEnabled

Fields inherited from interface Portlet

UNIT_GRID, UNIT_PX

Constructor Summary

Constructors

Constructor	Description
ResultHighmap(Map<String,?> definition)	Not intended for public use.

Method Summary

Modifier and Type	Method	Description
ResultHighmap	addMap(String... maps)	The map renderer will try to download the appropriate map by peeking at chart.map value of the provided definition.
List<String>	getMapsList()	Not intended for public use, required for JSON serialization.
String	getResultType()

Methods inherited from class ResultHighchart

addModule, addResultMatrixTab, getChartDefinition, getDataHeaders, getEvents, getModulesList, getResultMatrixList, getShowDataTab, onPointClick, setDataHeaders, setDrilldownResultMatrixTabs, setResultMatrixTabs, setShowDataTab, showDataTab

Methods inherited from class AbstractPortletDto

getLabelOverride, layout, setLabelOverride, setLayout, value, withDragDrop, withError, withHeight, withHeight, withInfo, withLabelOverride, withLayout, withLayout, withLayout, withResizing, withTab, withWarning, withWidth, withWidth

Methods inherited from class Object

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

Constructor Details

ResultHighmap

public ResultHighmap(Map<String,?> definition)

Not intended for public use. Using this constructor will not fully initialize the instance, please prefer api.buildHighmap().

See Also:

• PublicGroovyAPI.buildHighchart(Map)

Method Details

addMap

public ResultHighmap addMap(String... maps)

The map renderer will try to download the appropriate map by peeking at chart.map value of the provided definition. This method allows to downlaod any other JavaScript file available under the mapdata/ directory.

Parameters:

maps - one or more Highmaps compatible JavaScript map names, with the same form as would be used for the chart.map property of the map definition; i.e. including the path from mapdata/ and without the ".js" extension. e.g. "countries/us/us-all", "custom/world-robinson", "custom/europe"

Returns:

the ResultHighmap instance, for convenience

See Also:

• http://code.highcharts.com/mapdata/ to find out which maps are available.

getMapsList

public List<String> getMapsList()

Not intended for public use, required for JSON serialization.

getResultType

public String getResultType()

Specified by:

getResultType in interface ComplexCalculationResult

Overrides:

getResultType in class ResultHighchart