Fip Cerrado project

Fip Cerrado project

Display fire risks in the Cerrado biome.

Mappia API

 
 

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
 

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
 

paramsButtonConfig: {Object}

Choose what custom buttons are shown on the layer representation.

There are multiple types of buttons, there are some commum properties and some special properties:

Commom properties:
{
iconCls: {String} The class to add on the button. Ex: "icon-timeline-slider"
pressed: {Boolean} True to indicate if the button starts pressed, False otherwise. Ex: true,
toggleGroup: {String} Identify a group by name where only one button of the group can be pressed. Ex: 'onlyOneAtTime'
}

Types:
associated: {associatedButtonID: 'ANOTHER_BUTTON_ID', type: 'associated'}
Treat the layer button and the associated as the same button, so no matter which one is clicked both will
receive the click event.
query: {type: 'query'}
This configuration allows the user to change the default query button behavior overriting his definition.
download: {type: 'download', layerIndex: 0}
Set what layer should be downloaded when more than one layer is shown by its internal layer index.
metadata: {type: 'metadata', layerIndex: 0}
Set the metadata button to show one of the inside composite layer by his index.


PS: The layerIndex is from 0 to the quantity of layers in a composed map.
PS2: The properties are aditional, so the common must always be present, and for each type his
corresponding property must be added.
Usage: paramsButtonConfig: {
associatedButtonID: "population_2015_2036_timeline",
iconCls: "icon-timeline-slider",
pressed: true,
toggleGroup: undefined
}

Defaults to undefined
 

visibility: {Boolean}

Define the layer as initial visibility, True to start visible False otherwise. (the URL parameter visibleLayers can override this value).
Usage: {visibility: false}

Defaults to true
 

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: (inputs.id['id'].getValue('name'))

Defaults to undefined
 

forceRecalc: ()

Force a legend map recalculation.
Usage: (inputs.id['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: (inputs.id['id'].setValues({toStore:5}, ))('name'))

Defaults to undefined