import {GisplayOptions} from 'gisplay-es6-webpack/src/Gisplay/GisplayOptions.js'

public class | source

GisplayOptions

This class will contain all the options available on the Gisplay API.

See:

Diogo's thesis page 50-52

Test:

Constructor Summary

Public Constructor
public	constructor(userOptions: Object) Creates a new Options object.

Member Summary

Public Members
public	alpha: number Alpha to be used in WebGL.
public	attr: string The attribute to be mapped.
public	classBreaks: number[] Class intervals.
public	classBreaksMethod: string Algorithm to be used by the API to calculate classes intervals.
public	colorScheme: string[] Array of colors to be used by the API.
public	intensity: number this member was deprecated. Not used ATM, should probably be used for Heat Maps. Intensity of a heat map.
public	interactive: boolean When we click on a feature that is on the map, show properties of said Feature or not.
public	isDynamic: boolean If it is dynamic or not.
public	legendNumberFormat: number this member was deprecated. Currently not in use. Maybe implement later. Number of decimal numbers to show on the numerical values of the Legend.
public	legendOnClickFunction: Function Function to be called when the user clicks on a Legend class.
public	legendPosition: string this member was deprecated. Currently not in use. Maybe implement later. The user defined position of the Legend over the map.
public	legendTitle: string The title to be used on the Legend.
public	legendToggle: boolean Enable/Disable Legend toggle.
public	mapOnClickFunction: Function Function to be called when the user clicks on the Map (on a Feature).
public	maxFeatures: number The max number of features to be displayed.
public	maxPointSize: number The maximum size of the points to be drawn on the Map.
public	memorySaver: boolean If false each feature will have it's own WebGLBuffer, otherwise the geometry will be grouped creating one WebGLBuffer by Aesthetic class. As the name implies allows memory saving and with this improves performance in lower end devices. Only Available/Relevant to Dot Maps.
public	minPointSize: number The minimum size of the points to be drawn on the Map.
public	minuend: string The minimum property of the GeoJSON feature object.
public	numberOfClasses: * Number of classes to be used on the map Legend.
public	numberOfLegendItems: number The number of legend items.
public	profiling: * ##################### OTHER GLOBAL OPTIONS ##############################
public	showLegend: boolean Whether or not to show the map Legend.
public	showLoader: boolean Whether to show or not the loader when we the API is loading the needed data.
public	showPropertiesOnClick: string[] Properties and description to be shown when the user clicks on a Feature.
public	sizeByClass: boolean If the user wants to specify the size of the dots on a PSymbols Map using classes, this attribute should be true.
public	subtrahend: string The property of the GeoJSON feature object to subtract from the minimum.
public	tileSize: number The size of each background map tile.
public	useCustomMapService: boolean True when the user wants to use another background map service than those who are supported by default by the API.

Method Summary

Public Methods
public	getAvailableClassBreaksMethods(): string[] Returns the available class break methods.

Public Constructors

public constructor(userOptions: Object) source

Creates a new Options object. User options take precedence over default options.

Params:

Name	Type	Attribute	Description
userOptions	Object		The user defined options.
userOptions.attr	string		The attribute to be mapped.
userOptions.colorScheme	string[]	optional	The color scheme to be used.
userOptions.numberOfClasses	number	optional	Number of classes to be used on the map Legend.
userOptions.classBreaksMethod	string	optional default: quantile	Algorithm to be used by the API to calculate classes intervals.
userOptions.classBreaks	number[]	optional default: undefined	Class intervals.
userOptions.interactive	boolean	optional default: true	Show pop-up when the user clicks on a Feature.
userOptions.showPropertiesOnClick	boolean	optional default: null	Show pop-up when the user clicks on a Feature.
userOptions.showLegend	boolean	optional default: true	Show map Legend.
userOptions.minuend	string	optional default: undefined	The minimum property of the GeoJSON feature object.
userOptions.subtrahend	string	optional default: undefined	The property to subtract from minuend.
userOptions.legendTitle	string	optional default: this.attr	Legend title for the Legend.
userOptions.showLoader	boolean	optional default: true	Show loader when loading data.
userOptions.useCustomMapService	boolean	optional default: false	Use custom map service.
userOptions.minPointSize	number	optional default: 1.0	Minimum point size.
userOptions.maxPointSize	number	optional default: 10.0	Maximum point size.
userOptions.sizeByClass	boolean	optional default: false	Specify the size of the dots on a PSymbols Map using classes.
userOptions.memorySaver	boolean	optional default: false	Save memory on Dot Maps.
userOptions.colorSchemeId	boolean	optional default: 1	The color scheme id to use.
userOptions.legendOnClickFunction	Function	optional	Function to be called when the user clicks on a Legend class.
userOptions.mapOnClickFunction	Function	optional	Function to be called when the user clicks on the Map (on a Feature).
userOptions.alpha	number	optional default: 0.8	Alpha to be used in WebGL.
userOptions.maxFeatures	number	optional default: Number.MAX_VALUE	The max number of features to be displayed.
userOptions.numberOfLegendItems	number	optional default: 2	The number of Legend items (Used on PSymbols Map).
userOptions.intensity	number	optional default: 1	Intensity for Heat Map.
userOptions.legendPosition	string	optional default: br	The Legend position(br=bottom right).
userOptions.legendNumberFormat	number	optional default: 0	Number of decimal numbers to show on the numerical values of the Legend.
userOptions.tileSize	number	optional default: 256	Size of each background map tile.

Public Members

public alpha: number source

Alpha to be used in WebGL. 0 means fully transparent <-> 1 fully opaque.

Test:

public attr: string source

The attribute to be mapped.

Test:

See:

Chapter 4 Page 50 of Diogo's thesis.

public classBreaks: number[] source

Class intervals. If this is defined then numberOfClasses and classBreakMethod are ignored.

Test:

public classBreaksMethod: string source

Algorithm to be used by the API to calculate classes intervals. Defaults to quantile if the user does not provide any or if it provides one that isn't on the list of available algorithms. Available options are 'quantile', 'equidistant', 'k-means'.

Test:

public colorScheme: string[] source

Array of colors to be used by the API.

Test:

See:

Chapter 4 Page 50 of Diogo's thesis.

public intensity: number source

this member was deprecated. Not used ATM, should probably be used for Heat Maps.

Intensity of a heat map. Higher values of intensity means more red in the end color. Otherwise more green.

Test:

Test GisplayOptions. User options are empty so all defaults should be used. intensity(deprecated) is 1.0

public interactive: boolean source

When we click on a feature that is on the map, show properties of said Feature or not.

Test:

public isDynamic: boolean source

If it is dynamic or not. When dynamic is set to true it will join all Features on one Aesthetic class in the same Feature and this way it can draw all elements at once. It's the inverse of the memorySaver value.

Test:

public legendNumberFormat: number source

this member was deprecated. Currently not in use. Maybe implement later.

Number of decimal numbers to show on the numerical values of the Legend.

Test:

Test GisplayOptions. User options are empty so all defaults should be used. legendNumberFormat(deprecated) is 0

public legendOnClickFunction: Function source

Function to be called when the user clicks on a Legend class. This function should receive an object of type Aesthetic.

Test:

public legendPosition: string source

this member was deprecated. Currently not in use. Maybe implement later.

The user defined position of the Legend over the map. Allowed positions tl, tr, bl, br.

public legendTitle: string source

The title to be used on the Legend. Third option is used for Change Map.

Test:

public legendToggle: boolean source

Enable/Disable Legend toggle.

Test:

public mapOnClickFunction: Function source

Function to be called when the user clicks on the Map (on a Feature). This function should receive an array, which are the Feature properties.

Test:

public maxFeatures: number source

The max number of features to be displayed. If not given by the user then it is the maximum numnber allowed. Number.MAX_VALUE = 1.79E+308

Test:

public maxPointSize: number source

The maximum size of the points to be drawn on the Map. Will be used on PSymbols. The dot with highest value on the features will have the size given by the user.

Test:

public memorySaver: boolean source

If false each feature will have it's own WebGLBuffer, otherwise the geometry will be grouped creating one WebGLBuffer by Aesthetic class. As the name implies allows memory saving and with this improves performance in lower end devices. Only Available/Relevant to Dot Maps.

Test:

public minPointSize: number source

The minimum size of the points to be drawn on the Map. Will be used on PSymbols and maybe on Dot Map/Heat Map.

Test:

public minuend: string source

The minimum property of the GeoJSON feature object. Used on Change Map.

Test:

public numberOfClasses: * source

Number of classes to be used on the map Legend. This option should be used when the user wants the API to calculate the classes (aka ranges) using the given number. Otherwise the API will calculate the appropriate number of classes to use. @type{number}

Test:

public numberOfLegendItems: number source

The number of legend items. Used for PSymbols Map.

Test:

public profiling: * source

##################### OTHER GLOBAL OPTIONS ##############################

public showLegend: boolean source

Whether or not to show the map Legend.

Test:

public showLoader: boolean source

Whether to show or not the loader when we the API is loading the needed data.

Test:

public showPropertiesOnClick: string[] source

Properties and description to be shown when the user clicks on a Feature.

Test:

TODO:

NOT USED?

public sizeByClass: boolean source

If the user wants to specify the size of the dots on a PSymbols Map using classes, this attribute should be true.

Test:

public subtrahend: string source

The property of the GeoJSON feature object to subtract from the minimum. Used on Change Map.

Test:

public tileSize: number source

The size of each background map tile. Used by most background map providers is 256.

public useCustomMapService: boolean source

True when the user wants to use another background map service than those who are supported by default by the API. If this is true then the user should send the custom map service when creating the new Map.

Test:

Public Methods

public getAvailableClassBreaksMethods(): string[] source

Returns the available class break methods.

Return:

string[]

All available class break methods under Gisplay API.