Mitigation option project

Mitigation option project

Display land use transition through sankey diagram.

Mappia API


setQueryGlobalProperties: {Function}({{globalProperties}}) && {{QUERY_DESCRIPTION}}

A function that allows to define custom global functions that can be used in order to define properties or even inside the functions callbacks.
globalProperties: {Object} The object that all his functions will became globals, each property can be a value or a object or evan a function.
PS: All properties defined here are added to the global scope and are removed when the query is changed.
@param QUERY_DESCRIPTION {Array{ConfigLayer} } Array of layers in the query.
Usage: ExtjsUtils.QUERY.setQueryGlobalProperties({globalCount: 0}) && QUERY_DESCRIPTION

Defaults to undefined

changeLayers: {Array{Object} }

Change a internal layer in a given index by another.

PS: Its highly recommended to pass multiple configuration in a array, avoid call this function multiple
times in the same callback.
@param newConfig {Array|Object} One or more layers configurations with a property 'index' indicating the replacing layer.
Each config object must contain at least the following properties:
[{name: 'MAP_FULL_NAME', styles: 'MAP_STYLE', index: 'MAP_INDEX_TO_CHANGE'}, ... ]
@param force {Boolean} Force redraw even if no change is done when the layer is the same.
Usage: (layer.changeLayers({name:'CSR:estados', index:1} ))

Defaults to undefined

setCalculateLegend: {Function}({{legendEntries}})

Defines the current map legend, so it prevents from a new legends calculation process.

PS: Can be called inside the 'beforeCalculate' callback, which is the time right before the new legend calculation.
PS2: Can be called on a tool callback.

@param legendEntries {Array{{String|Array{Number, Number, Number} }, {Object}, {String} } } Array with the legends sorted entries in ascending order, the ones out of order will be ignored.
Usage: layer.setCalculateLegend([['00FF00', 10, 'lower Bound'], ['F100F3',50,'higher Bound']]);

Defaults to undefined

nextStepInterval: {Numeric}

Sets the delay in seconds between steps when timeline is playing.
Usage: |nextStepInterval={Numeric}|

Defaults to undefined

steps: {Array{Array} }

Array of all timeline steps where each element is a tuple of [VALUE,'Title']. The value is a mandatory parameter for the step, the title give a optional custom representation to value.
Usage: |steps=[[1918, 'World War 1'], [1939, 'World War 2']]|

Defaults to undefined

onSelect: {Function}({{element}}, {{value}}, {{index}})

Fires when a list item is selected.
@param element {Element} This combobox.
@param value {Record}: The record which was selected.
@param index {Numeric} Index of the selected item.

Usage: |onSelect= function(e,v) {alert('Selected ' + v);}|

Defaults to undefined

width: {Number}

Define element initial width in pixels.
Usage: |width=200|

Defaults to 190

getValue: ({String}) => {Object}

Get the stored value by his property name, if it does not exists returns null.

@param key {String} Stored property name.
@returns {*} Desired stored property when it exists or null otherwise.
Usage: (['id'].getValue('name'))

Defaults to undefined

forceRecalc: ()

Force a legend map recalculation.
Usage: (['id'].forceRecalc())

Defaults to undefined

setValues: ({{obj}}, {{cancelUpdate}}, {{local}})

Stores object properties for later usage.

PS: If has name property collision the older is replaced.
@param obj {Object} Object with the properties to be stored.
@param cancelUpdate {Boolean} False if this change must cause layer recalculation, True otherwise.
@param local {Boolean} True to store the property locally, False otherwise. The local properties aren't sent to 'expression' calbacks. (i.e. If a element is recursive or have DOM elements, it must local avoid stringify errors on 'expression' callbacks)
Usage: (['id'].setValues({toStore:5}, ))('name'))

Defaults to undefined