{ "Layers": { "_information": { "title": "Layers: what you write in a layer", "description": "A layer is one entry of the query's list, between { }. Its source sets its kind: no source (a published map), \"calculate\", \"file\" or \"xyz\". The groups below are the keys and functions you write in a layer, and the buttons of its row.\nNot every key works on every kind: calculated, file and tile layers have a panel (descriptionHtml) and row buttons (paramsButtonConfig), a published map does not. Each entry says when it is limited to some kinds; what one kind adds is under Kinds of layer.\nA layer that shows one published map:", "example": "[\n {\n // The Layer name\n title: 'My first layer!',\n\n // The map that will be shown\n name: 'CSR:altimetria',\n\n // Flag to make the map show on start\n visibility: true,\n },\n]" }, "LayersProperties": [ { "key": "_information", "description": "Keys of a layer object: which map it shows (name, source, styles), how it looks (title, opacity, visibility) and how its row and panel behave.", "name": "Layer properties" }, { "key": "categorical", "description": "Switches the generated legend of a `source: 'calculate'` layer to categorical mode.\nWhen `true`, every distinct value returned by `expression()` becomes its own legend entry (values are\ngrouped by value, never into ranges) and the colours come from `categoricalPalette`. When `false`\nthe values are grouped into at most `maxQntEntries` ranges coloured with the sequential\n(blue to red) palette. Use it when the expression returns classes (land use, geology, ...) instead\nof a continuous number.", "type": "Boolean", "examples": [ "[\n {\n title: 'Categorical result',\n color: '#FFA500',\n elements: [\n {\n title: 'One legend entry per geology class',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n updateAutomatically: true,\n categorical: true,\n expression: function(layersVals, inputs) {\n return layersVals[0];\n },\n },\n ],\n },\n]" ], "default": "false" }, { "key": "categoricalPalette", "description": "Colours of the legend entries of a categorical `source: 'calculate'` layer (see `categorical`),\nas an array of `[R, G, B]` triplets (0 to 255). The entries are assigned, in the sorted order of the\nvalues returned by `expression()`, spreading evenly over the palette. When omitted a built-in\n300-colour palette is used. The palette length is also the upper limit for `maxQntEntries`.", "type": "Array.>", "examples": [ "[\n {\n title: 'Custom categorical colours',\n color: '#FFA500',\n elements: [\n {\n title: 'Geology classes with a four colour palette',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n updateAutomatically: true,\n categorical: true,\n categoricalPalette: [[43, 3, 192], [126, 222, 20], [243, 99, 6], [34, 67, 2]],\n expression: function(layersVals, inputs) {\n return layersVals[0];\n },\n },\n ],\n },\n]" ], "default": "300 built-in colours" }, { "key": "description", "description": "Define the text that will be displayed when the mouse hover the Legend Window Title.\nThis description applies when the 'source' of the map is 'xyz' or the Layer is a 'vector'.", "type": "String", "examples": [ "[\n {\n title: 'Example of description for XYZ map',\n color: '#666699',\n elements: [\n {\n title: 'This is the Layer Legend Window Title, hover me!',\n name: 'planet:planet',\n source: 'xyz',\n url: 'https://tiles.planet.com/basemaps/v1/planet-tiles/planet_medres_visual_2021-09_mosaic/gmap/${z}/${x}/${y}.png?api_key=PLAK78456687760442eaa3d3da16aaac5f2d',\n visibility: true,\n description: 'Hover the Layer Title',\n },\n ],\n },\n]" ], "default": "'XYZ Title' or 'Vector Title'" }, { "key": "descriptionHtml", "description": "Define the content that will be displayed at the Query section (\"Exibir Consulta\" button).\nThis property accepts any string in HTML format. Besides that, you can also use predefined tools.\nOnly calculated, file and tile (xyz) layers have this panel; on a published map (no `source`,\n`source: 'local'` or a server added with `addRemoteWMSServer`) it is ignored.", "type": "String", "examples": [ "[\n {\n title: 'Example of descriptionHTML',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has a custom descriptionHTML',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n {\n type: 'query',\n pressed: true\n },\n ],\n descriptionHtml:\n '

You can use HTML tags

'\n +\n '{{label|text=Or the tools from Mappia:}}'\n +\n '{{button|text=I\\'m a button from Mappia}}',\n },\n ],\n },\n]" ], "default": "string.empty", "see": [ "You can find more information about the tools available for use in: [Tools Section](#group_Tools)." ] }, { "key": "disabledAttributes", "description": "Define which styles will be hidden in the Style Chooser Combobox from Layers that has the 'source' property as 'local'.\nYou need to pass the name of a style as in the GetCapabilities() xml. They follow the pattern of the map name, underline (_) and then the number of the style. (_).\nYou can hide more than one style. For this you only need to separate their names by commas.", "type": "String", "examples": [ "[\n {\n title: 'Example of disabledAttributes',\n color: '#666699',\n elements: [\n {\n title: 'This Layer hides the styles \\'Mapa geológico\\' and \\'Tempo geológico\\' from the styles choose combobox',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n // geologia_2 is the style 'Tempo geológico'\n // geologia_1 is the style 'Mapa geológico'\n // The 'disabledAttributes' property is used to hide the styles from the styles chooser combobox\n // All styles that are hidden must be separated by commas\n disabledAttributes: 'geologia_2,geologia_1',\n },\n ],\n },\n]" ], "default": "null" }, { "key": "exclusiveGroupDetails", "description": "Define a name for a Layer Details. Between all Layers with the same ‘exclusiveGroupDetails’ name, only one Layer can have its Legend open each time.", "type": "String", "examples": [ "[\n {\n viewTitle: 'Only one Legend can be open each time',\n title: 'Example of exclusiveGroupDetails',\n color: '#666699',\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:estados',\n source: 'calculate',\n exclusiveGroupDetails: 'ExampleName',\n visibility: true,\n },\n {\n title: 'Layer 2',\n name: 'CSR:rios_principais',\n source: 'calculate',\n exclusiveGroupDetails: 'ExampleName',\n visibility: true,\n },\n {\n title: 'Layer 3',\n name: 'CSR:geologia',\n source: 'calculate',\n exclusiveGroupDetails: 'ExampleName',\n visibility: true,\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "extents", "description": "Define which tiles will be used to render the map. All the tiles that are within the 'extents' coordinates will be used to render the map.\nThe extents must be in EPSG:4326 (coordinates in lat,long). Also, the array values need to be in the order: [minX, minY, maxX, maxY].", "type": "Array.", "examples": [ "// Play around with the maps visibility to check the regions defined by the extents.\n[\n {\n title: 'Example of extents',\n color: '#FFA900',\n elements: [\n {\n title: 'Restricted extents',\n name: 'CSR:altimetria',\n visibility: true,\n // Follows the order [minX, minY, maxX, maxY]\n extents: [-48.5, -14.5, -46.0, -13.0],\n },\n {\n title: 'Restricted extents 2',\n name: 'CSR:altimetria',\n visibility: true,\n // Follows the order [minX, minY, maxX, maxY]\n extents: [-43.9, -19.8, -43.1, -18.9],\n },\n {\n title: 'This Layer displays the hole map',\n name: 'CSR:altimetria',\n // This extents render the whole world.\n extents: [-180.0000, -90.0000, 180.0000, 90.0000],\n startListed: true,\n },\n ],\n },\n]" ], "default": "Array.empty" }, { "key": "global", "description": "A second way to declare query globals from a layer: an object whose properties\nbecome temporary globals, passed to `ExtjsUtils.QUERY.setQueryGlobalProperties`\nwhile the layer is interpreted. The usual form is the\n`ExtjsUtils.QUERY.setQueryGlobalProperties({...}) && [...]` chain at the top of\nthe query; the production survey found no query using this key (zero users).", "type": "Object", "examples": [ "[\n {\n title: 'Group',\n elements: [\n {\n title: 'Layer with its own globals',\n name: 'CSR:estados',\n source: 'local',\n visibility: true,\n global: {\n statesLoaded: function() { ExtjsUtils.ALERTIFY.log('States ready'); }\n }\n }\n ]\n }\n]" ] }, { "key": "hideLegendButton", "description": "Hides the legend of the layer in its Legend Window. Set it to 'true' to hide it, 'false' to display it.\nIt applies to every layer source: on a `local` layer it hides the \"show legend\" toggle button of the row;\non a `calculate`, `file` or `xyz` layer it hides the generated legend container (with the legend title\nand the opacity slider) and the \"show legend\" button at the bottom of the query section, so only the\n`descriptionHtml` remains.", "type": "Boolean", "examples": [ "[\n {\n title: 'Hiding the Legend Button',\n color: '#FFA500',\n elements: [\n {\n title: 'The Layer Legend Button will be hidden',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n hideLegendButton: true,\n descriptionHtml:\n '{{label|text=The legend button is hidden, only the descriptionHtml is visible}}',\n },\n ],\n },\n]" ], "default": "false" }, { "key": "hideListing", "description": "Hides the layer from its group's menu at the top of the screen: the list that appears\nwhen the mouse is over the group title. Set it to `true` to leave the layer out of that\nmenu; `false` (the default) lists it.", "type": "Boolean", "examples": [ "[\n {\n title: 'A Group with 3 Layers, but one is hidden',\n color: '#FFA500',\n elements: [\n {\n title: 'Map of the altitude in Brazil',\n name: 'CSR:altimetria',\n source: 'local',\n },\n {\n title: 'This Layer will be hidden at the Group list',\n name: 'CSR:rios_principais',\n source: 'local',\n hideListing: true,\n },\n {\n title: 'Map of the geology in Brazil',\n name: 'CSR:geologia',\n source: 'local',\n },\n ],\n },\n]" ], "default": "false" }, { "key": "hideMetadata", "description": "If true, hides the metadata button in the Legend Window for this layer.\nThe button is also hidden when the link has `options=hidemetadata`: either one hides it, and\n`hideMetadata: false` cannot bring it back. Calculated, file and tile (xyz) layers only have\nthis button when their `paramsButtonConfig` has a `{type: 'metadata'}` entry.", "type": "Boolean", "examples": [ "[\n {\n title: 'Hiding the metadata button',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has no metadata button',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n hideMetadata: true,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "hideStyleChooser", "description": "Define if should hide the Combobox with the map possible styles that can be applied to a map in a Layer that has the 'source' 'local'.", "type": "Boolean", "examples": [ "[\n {\n title: 'Example with hidden style Combobox',\n color: '#FFA500',\n elements: [\n {\n title: 'Map of the geology in Brazil',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n startLegendOpen: true,\n hideStyleChooser: true,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "hideTilePlaceholder", "description": "Removes the stretched placeholder tile that is shown while the real tiles load (the OpenLayers\n`resize` transition). Set it to `true` for layers whose content changes between loads, such as\ntimeline or calculated maps, to avoid the previous image being stretched before the new one\nappears. Applies to `local` and `calculate` layers; a composed layer also passes it on to the\nmaps replaced with `changeLayers`.", "type": "Boolean", "examples": [ "[\n {\n title: 'No stretched tiles while loading',\n color: '#FFA500',\n elements: [\n {\n title: 'Map of the geology in Brazil',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n hideTilePlaceholder: true,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "insideOpacity", "description": "Defines the opacity for the maps defined in the 'name' property.\nThis property is an array of values which are the opacity that will be applied in the same order that the map was defined in the 'name' property. For example, the first value in the 'insideOpacity' array will define the opacity for the first map defined in the 'name' property, the second value is the opacity for the second map, and so on.\nThe opacity value is a number between 0 and 1. 0 being transparent and 1 opaque.", "type": "Array.", "examples": [ "[\n {\n title: 'Example of insideOpacity',\n color: '#666699',\n elements: [\n {\n name: 'CSR:estados,CSR:rios_principais,CSR:geologia',\n source: 'calculate',\n // The values are applied to the layers in the same order as they are defined in the name property. So the CSR:estados map has the opacity of 0.5, the CSR:rios_principais map has the opacity of 1, and the CSR:geologia map has the opacity of 0.7.\n insideOpacity: [0.5, 1, 0.7],\n visibility: true,\n },\n ],\n },\n]" ], "default": "[1, 1, 1, ...]" }, { "key": "legendTitle", "description": "Defines the text that will be displayed at the top of the 'legendhtml tool' declared at the 'descriptionHtml' property", "type": "String", "examples": [ "[\n {\n title: 'Example custom legend title',\n color: '#FFA500',\n elements: [\n {\n title: 'Map of the geology in Brazil',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n legendTitle: 'This is a custom legend title',\n descriptionHtml:\n '{{legendhtml}}',\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "maxQntEntries", "description": "Maximum number of legend entries generated from the values returned by `expression()` on a\nnon-categorical `source: 'calculate'` layer; when there are more distinct values than this they are\ngrouped into value ranges. The value is clamped to the length of the active palette.\nPS: the automatic grouping currently always uses the built-in limit of 18, so a custom value is kept\non the layer but does not change the generated legend. Use `setCalculateLegend()` when you need full\ncontrol over the legend entries.", "type": "Number", "examples": [ "{\n name: 'CSR:altimetria',\n source: 'calculate',\n maxQntEntries: 10,\n expression: function(layersVals, inputs) {\n return layersVals[0];\n },\n}" ], "default": "18" }, { "key": "name", "description": "Defines the maps that will be a part of the Layer. Every map defined in here will be shown when the Layer is active. Besides that, all of their information can be used to calculate a new map combining their data.\nIn this website you will find some of the maps that can be used: http://maps.csr.ufmg.br/geonetwork/srv/por/search.\nYou can find their name at the section \"Visão geral do mapa\" under its image. Those maps have the prefix \"CSR:\" before their names.\nMaps can also be uploaded by you. For that, you just need to define the 'source' property as 'file'.", "type": "String", "examples": [ "[\n {\n title: 'A Group with two maps',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has two maps!',\n // Each map is separated by commas\n // The first map is CSR:rios_principais that have the rivers of Brazil\n // The second map is CSR:estados that show the states of Brazil\n name: 'CSR:rios_principais,CSR:estados_cf',\n visibility: true,\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "opacity", "description": "Define the opacity of the Layer. The opacity is a value between 0 and 1 that is a scale for its transparency. 0 is completely transparent. 1 is completely visible.", "type": "Numeric", "examples": [ "[\n {\n title: 'Example of opacity in a Layer',\n color: '#666699',\n elements: [\n {\n title: 'This Layer has its opacity set to 50% of the original visibility',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n opacity: 0.5,\n },\n ],\n },\n]" ], "default": "1" }, { "key": "otherNames", "description": "Defines additional maps to be available for the query, which will be listed in the filtered stored capabilities.\nEvery map included in layer definition needs to be either in 'name' property or 'otherNames' property.\n\nPS: This property must be used along with the 'capabilities' url option, which filters the 'GetCapabilities' response with only the maps included in layer definition. (Performance Optimization, faster loading).\nPS2: This property is only needed outside of the editor mode.", "type": "String", "examples": [ "{\n name: \"CSR:estados,CSR:airports\",\n otherNames: \"CSR:municipios,CSR:rodovias\",\n beforeCalc: function(layerVals, inputVals) {\n this.changeLayers([{name: 'CSR:municipios', styles: fMapName + \"_1\", index: 0},\n {name: 'CSR:rodovias', styles: 'rodovias_1', index: 1}]);\n }\n }\n\n Function 'changeLayers' needs the definition of the 4 maps: 'estados', 'airports', 'municipios' and 'rodovias'.\n If the 'otherNames' is not defined, only the maps defined at 'name' property will be available.\nApplies to calculated layers (`source: 'calculate'`), the ones that swap maps with `changeLayers`." ] }, { "key": "priority", "description": "Defines the order of which map will be rendered on top of the others. Layers with higher 'priority' will always be rendered on top of the layers with lower 'priority'.", "type": "Number", "examples": [ "[\n {\n title: 'At the bottom will be the geology, then the states and at top the rivers',\n color: '#FFA500',\n elements: [\n {\n title: 'Map of the states in Brazil',\n name: 'CSR:estados',\n source: 'local',\n priority: 2,\n visibility: true,\n },\n {\n title: 'Map of the rivers in Brazil',\n name: 'CSR:rios_principais',\n source: 'local',\n priority: 3,\n visibility: true,\n },\n {\n title: 'Map of the geology in Brazil',\n name: 'CSR:geologia',\n source: 'local',\n priority: 1,\n visibility: true,\n },\n ],\n },\n]" ], "default": "0" }, { "key": "showLoadingModal", "description": "Shows the \"generating legend\" loading mask visibly over the page while the layer is paused\n(calculating or loading a resource). By default the mask is an invisible overlay that only changes\nthe cursor to \"wait\"; set it to `true` to make it visible. Only shown while the layer is visible.\nApplies to `calculate` and `file` layers.", "type": "Boolean", "examples": [ "[\n {\n title: 'Visible loading mask',\n color: '#FFA500',\n elements: [\n {\n title: 'A slow calculation with a visible loading mask',\n name: 'CSR:altimetria',\n source: 'calculate',\n visibility: true,\n updateAutomatically: true,\n showLoadingModal: true,\n expression: function(layersVals, inputs) {\n return layersVals[0];\n },\n },\n ],\n },\n]" ], "default": "false" }, { "key": "showRemoveBtn", "description": "Defines it the remove button at the top right of the Layer Legend Window show be displayed. Set it to 'true' to show it. Set it to 'false' to hide it.", "type": "Boolean", "examples": [ "[\n {\n title: 'Hiding the remove button',\n color: '#FFA500',\n elements: [\n {\n title: 'The \\'X\\' button at the top right of this Layer removes this map',\n name: 'CSR:rios_principais',\n source: 'local',\n visibility: true,\n },\n {\n title: 'There is no button to remove the this map',\n name: 'CSR:estados',\n source: 'local',\n visibility: true,\n showRemoveBtn: false,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "source", "description": "Defines the source from where the maps declared at the name will be loaded from. The Source can be one of the following:\n - 'local': The maps in the name will be loaded from the CSR servers\n\n - 'calculate': The maps in the name gonna be used to calculate a new map in the expression() function and the result will be displayed as the Layer\n\n - 'file': The map will be loaded from a file or other custom source. For this, you need to define the file type in the 'type' property and the file where the map should be loaded. For example, for a JSON file, you also need to define the 'json' property.\n\n - 'xyz': The map will be loaded from an url by the XYZ protocol. The url property is required for this type of source. You can find more informations about the XYZ protocol at: https://developers.planet.com/docs/basemaps/tile-services/xyz/", "type": "String", "examples": [ "// Example of how to load a map with the local source\n[\n {\n title: 'Map rendered by a local source',\n color: '#666699',\n elements: [\n {\n title: 'Map with local source',\n name: 'CSR:paises',\n source: 'local',\n visibility: true,\n },\n ],\n },\n]", "// Example of how to load a map with the calculated source\n[\n {\n title: 'Map rendered based on calculation',\n color: '#666699',\n elements: [\n {\n title: 'Filtering a part of the map',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n updateAutomatically: true,\n expression: function(layersVals, inputs) {\n // layerVals have the value of the legend applied in every pixel of the map\n let mapValue = layersVals[0];\n\n // Remove every type of relief that is not 'Mantiqueira'\n if(mapValue != 'Mantiqueira') { // If the pixel is not 'Mantiqueira'\n return undefined; // Don't show the pixel\n }\n\n // If the pixel is 'Mantiqueira', return the value of the pixel\n return mapValue;\n },\n },\n ],\n },\n]", "// Example of how to load a map with the file source\n[\n {\n title: 'Map rendered based on file source',\n color: '#FFA500',\n elements: [\n {\n title: 'Map with file source',\n name: 'example:map_file_source',\n source: 'file',\n visibility: true,\n // The map is rendered based on the GeoJSON below\n // The GeoJSON needs to be in EPSG:3857\n json: JSON.stringify(\n {\n \"type\": \"Polygon\",\n \"crs\": {\n \"type\": \"name\",\n \"properties\": {\n \"name\": \"EPSG:3857\"\n }\n },\n \"coordinates\": [\n [\n [\n -625570.6,\n 6465993.0,\n ],\n [\n -305006.9,\n 6696510.8,\n ],\n [\n -546330.2,\n 6768547.6,\n ],\n [\n -445478.6,\n 7053093.0,\n ],\n [\n -279794.0,\n 7056694.8,\n ],\n [\n -359034.5,\n 7337638.4,\n ],\n [\n -211359.0,\n 7485313.8,\n ],\n [\n 62380.8,\n 6955843.3,\n ],\n [\n 220861.7,\n 6909019.4,\n ],\n [\n 91195.5,\n 6700112.6,\n ],\n [\n 213658.1,\n 6682103.4,\n ],\n [\n -625570.6,\n 6465993.0,\n ],\n ],\n ],\n }\n ),\n },\n ],\n },\n]", "// Example of how to load a map with the XYZ source\n// The XYZ source is used to load a map from a URL that contains the {z}, {x} and {y} placeholders\n// The {z} is the zoom level, {x} is the longitude and {y} is the latitude\n[\n {\n title: 'Map rendered by a XYZ source',\n color: '#666699',\n elements: [\n {\n title: 'Base map loaded by XYZ source',\n // The name of the map that will be added. This name must be unique\n name: 'planet:planet',\n source: 'xyz',\n // The url of the map that will be loaded. The ${z}, ${x} and ${y} placeholders will be replaced by the map library\n url: 'https://tiles.planet.com/basemaps/v1/planet-tiles/planet_medres_visual_2021-09_mosaic/gmap/${z}/${x}/${y}.png?api_key=PLAK78456687760442eaa3d3da16aaac5f2d',\n visibility: true,\n },\n ],\n },\n]" ], "default": "'local'" }, { "key": "startLegendOpen", "description": "Defines if the Legend Window should start or not. Set it to 'true' to make it start open. Set it to 'false' for it to start closed.\nApplies to published maps only (no `source`, `source: 'local'` or a server added with `addRemoteWMSServer`).\nCalculated, file and tile (xyz) layers ignore it: their details already start open, and\n`paramsButtonConfig: [{type: 'query', pressed: true}]` makes them start on the layer's panel instead.", "type": "Boolean", "examples": [ "[\n {\n title: 'The Legend Window the Layer will start open',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer Legend Window will start open',\n name: 'CSR:geologia',\n source: 'local',\n startLegendOpen: true,\n visibility: true,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "startListed", "description": "Define if the Layer should start with its Legend Window visible or not. This does not make the Layer visible on the map by itself. For that, you need to set the 'visibility' property to 'true'.\n'startListed' just displays the Legend Window associated with the Layer.", "type": "Boolean", "examples": [ "[\n {\n title: 'The Legend Window of the third Layer will start visible',\n color: '#FFA500',\n elements: [\n {\n title: 'Map of the altitude in Brazil',\n name: 'CSR:altimetria',\n source: 'local',\n },\n {\n title: 'Map of the rivers in Brazil',\n name: 'CSR:rios_principais',\n source: 'local',\n },\n {\n title: 'This Layer Legend Window will start visible, but is not map',\n name: 'CSR:geologia',\n source: 'local',\n startListed: true,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "styles", "description": "Defines which styles will be applied over the maps defined at the 'name' property.\nThe styles are applied in the same order as the maps are declared in name. For example, if there are 3 maps in the 'name' property and 3 styles. The first style will be applied to the first map, the second to the second map, and so on.\nA style's Mappia identifier is the map name without its namespace plus `_` and an\nindex (`estados` published with two styles gives `estados_0` and `estados_1`), and the\nstyles a map really offers are the ones its published capabilities declare: open the\nlayer's style chooser in the interface to see and pick them, or read the `Style` entries\nof the map in the WMS capabilities. Styles are created when the map is published (a QGIS\nstyle file is converted at publication time), not by the query.\nPS: Styles are separated by comma, one per map in `name`, in the same order.", "type": "String", "examples": [ "[\n {\n title: 'Example of style',\n color: '#666699',\n elements: [\n {\n name: 'CSR:precip_monthly_average,CSR:precip_monthly_average',\n // The first style 'precip_monthly_average_1' is applied to the first map 'precip_monthly_average' and the second style 'precip_monthly_average_2' is applied to the second map 'precip_monthly_average'\n styles: 'precip_monthly_average_1,precip_monthly_average_2',\n // The source needs to be calculate to apply the style\n source: 'calculate',\n visibility: true,\n },\n ],\n },\n]", "{\n ...,\n name: 'CSR:municipios',\n style: 'municipios_0',\n ...\n }", "{\n ...,\n name: 'CSR:estados,CSR:geologia',\n style: 'estados_0,geologia_1',\n ...\n }" ], "default": "string.empty" }, { "key": "thumbUrl", "description": "Define the thumbnail image that is displayed when the mouse hovers the Legend Window title.\nYou can define any image you would like to display as the map thumbnail. You just need to pass its URL.", "type": "String", "examples": [ "[\n {\n title: 'Example of thumbUrl',\n color: '#FFA900',\n elements: [\n {\n title: 'There is a puppy hidden in here! Hover me! <3',\n name: 'CSR:altimetria',\n visibility: true,\n thumbUrl: 'https://fastly.picsum.photos/id/237/200/300.jpg?hmac=TmmQSbShHz9CdQm0NkEjx1Dyh_Y984R9LpNrpvH2D_U',\n },\n ],\n },\n]" ], "default": "undefined" }, { "key": "title", "description": "Defines the Title that will be displayed at the Legend Window in the top left corner of the screen and inside the Group List at the top center of the screen.", "type": "String", "examples": [ "[\n {\n title: 'The title of the Group shows up at the top center of the screen and has a List inside it.',\n color: '#FFA500',\n elements: [\n {\n title: 'The title of the Layer is shown at the Legend Window and inside the menu of the Group name.',\n name: 'CSR:capitals',\n visibility: true,\n },\n ],\n },\n]" ], "default": "'layer_name' The default value is the layer name." }, { "key": "updateAutomatically", "description": "Decides what happens when the reader changes an input of the layer's panel (a widget in `descriptionHtml`).\n`true`: the layer is calculated again at once. `false` (the default): a short countdown starts, with a button to\nrefresh now, so several changes make one calculation. The layer is drawn either way.\nApplies to calculated and file layers.", "type": "Boolean", "examples": [ "[\n {\n title: 'The map will be automatically calculated',\n color: '#666699',\n elements: [\n {\n title: 'This layer is showing just one type of relief',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n updateAutomatically: true,\n expression: function(layersVals, inputs) {\n // layerVals have the value of the legend applied in every pixel of the map\n let mapValue = layersVals[0];\n\n // Remove every type of relief that is not 'Mantiqueira'\n if(mapValue != 'Mantiqueira') { // If the pixel is not 'Mantiqueira'\n return undefined; // Don't show the pixel\n }\n\n // If the pixel is 'Mantiqueira', return the value of the pixel\n return mapValue;\n },\n },\n ],\n },\n]" ], "default": "false" }, { "key": "viewColor", "description": "HTML color to use on the group.", "type": "String", "examples": [ "[{\nviewColor: \"#FFFFFF\",\nviewTitle: \"DADOS BASE\",\ncolor: \"#FF000F\",\nelements: [\n {name: 'CSR:AMAZONIA_limite', showRemoveBtn: false, visibility: true,\n hideListing: true, startListed: true, priority: 10000}\n]}]" ] }, { "key": "visibility", "description": "Define if the Layer should start visible or not. \nSet it to 'true' for the Layer start visible. Otherwise, set it to 'false' and the Layer will start hidden.", "type": "Boolean", "examples": [ "[\n {\n title: 'Example of visibility in a Layer',\n color: '#666699',\n elements: [\n {\n title: 'This layer will start visible',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n },\n ],\n },\n]" ], "default": "false" } ], "ConfigLayer": [ { "key": "_information", "completeAPI": "View all layer configuration API here.", "description": "More keys of the same layer object: scale limits, grouping (group, toggleGroup, openGroup), the row's layout and, on calculated layers, how each map is read (operation).", "name": "More layer properties" }, { "key": "attribution", "description": "Recognizes someone as the platform author, showing in the \"Powered by: {insert name}\".", "type": "String" }, { "key": "customLayerClass", "description": "Extra CSS class added to the row of the layer in the Legend Window and to its vertical options\nmenu (see `verticalMenu`), so the layer can be styled with `ExtjsUtils.CSS.defineClass` or a\nstylesheet. The same key on a `viewTitle` group is added to the group node instead\n(`GroupProperties.customLayerClass`).", "type": "String", "examples": [ "[\n {\n title: 'Styled layer row',\n color: '#FFA500',\n elements: [\n {\n title: 'This row has a custom background',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n customLayerClass: 'highlighted-layer',\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "group", "description": "Only the value \"background\" does anything: it makes the layer a basemap, drawn under every other\nlayer and listed in the background picker instead of the layer list. Any other value is ignored\n(it does not group layers: groups are `{ title, elements: [...] }` objects).\nTo let only one of several layers be visible at a time, use `toggleGroup`.", "type": "String", "examples": [ "[{visibility: true, group: \"background\", name: \"CSR:planet_brasil_2024\", priority: 5}]" ] }, { "key": "maxExtent", "description": "Defines a geographical limit for a map rendering.", "type": "OpenLayers.Bounds" }, { "key": "maxZoom", "description": "Defines the limit of the real max zoom of a given layer.\nWhen map zoom exceed this, the image is reused and stretched.", "type": "Numeric" }, { "key": "maxscale", "description": "Defines the limit of the real max scale of a given layer. \nWhen the map scale value exceeds the defined one, the image is reused and stretched.", "type": "Numeric" }, { "key": "metadataUrl", "description": "Defines the url to show custom layers metadata information.\nIf empty, the default value is obtained from layer metadata from the WMS definition.\n\nPS: The linked domain must have CORS headers enabled.", "type": "string|null" }, { "key": "minscale", "description": "Defines the limit of the real min scale of a given layer. \nWhen the map scale reaches a value lower than the defined one, the image is reused and compressed.", "type": "Numeric" }, { "key": "openGroup", "description": "Defines if the group starts opened, even without any visible layers.\nSet it true to start open, false otherwise.\nPS: If one layer is visible, the group will start open.\nIt works at both levels: on a `viewTitle` group it makes that group start expanded; on a layer it\nexpands every `viewTitle` ancestor of the layer (see `GroupProperties.openGroup`).", "type": "Boolean", "default": "false" }, { "key": "operation", "description": "Defines how the pixels of each map of a `source: 'calculate'` layer are decoded into the values\nthat `expression()` receives in `layersVals`. It is a comma-separated list with one token per map\nin `name`, in the same order; an empty token keeps that map on the default decoding (for\nexample `'raw,,sum'` leaves the second map on the default). Tokens are case and whitespace\ninsensitive. The accepted tokens (see `RawMaps.operations` for the full description of each one) are:\n - *(empty or unknown)*: `NORMAL`, the regular WMS image, each pixel is a legend colour/category.\n - `raw`: the value of the most centred original cell of the region covered by the pixel.\n - `rgba`: the RGBA bytes of the pixel packed as one integer.\n - `sum`: area-weighted sum of the covered cells.\n - `average`: area-weighted mean of the covered cells.\n - `max` / `min`: largest / smallest cell at least partially covered.\n - `integral`: summed-area table, the sum over a rectangle from its four corners.\n - `areaintegral`: summed-area table of the covered areas.\n - `area`: original map area inside the covered region.\n - `cells`: weighted count of original cells inside the covered region.\nEvery token other than the default and `rgba` requires the map to be published as a Raw Map offering\nthat operation; otherwise the console logs `Error: Operation X is not defined for layer Y`.", "type": "String", "examples": [ "[\n {\n title: 'Population from raw maps',\n color: '#FFA500',\n elements: [\n {\n title: 'Total population of each pixel',\n // The same raw map is stacked twice, read with two different operations,\n // and the states map keeps the default decoding (empty token).\n name: 'CSR:pop_density_estimate_2015,CSR:estados,CSR:pop_density_estimate_2015',\n operation: 'average,,area',\n source: 'calculate',\n visibility: true,\n updateAutomatically: true,\n descriptionHtml: '{{hoverpixel}}',\n expression: function(layersVals, inputs) {\n var density = layersVals[0]; // people per km2 (area-weighted mean)\n var stateName = layersVals[1]; // legend value of the regular WMS map\n var areaKm2 = layersVals[2]; // area of the original cells covered by this pixel\n return density * areaKm2;\n },\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "shouldKeepRecord", "description": "Defines what the 'X' (remove) button of the Legend Window does (see `showRemoveBtn`). When\n`true` the layer record is kept: the layer is only hidden and removed from the listing, so it\ncan be listed again from the group menu at the top. When `false` the layer is removed from\nthe map for good.", "type": "Boolean", "examples": [ "[\n {\n title: 'Removing a layer for good',\n color: '#FFA500',\n elements: [\n {\n title: 'The X button removes this map from the query',\n name: 'CSR:rios_principais',\n source: 'local',\n visibility: true,\n shouldKeepRecord: false,\n },\n ],\n },\n]" ], "default": "true" }, { "key": "toggleGroup", "description": "Places a layer in a group of layers with mutually exclusive visibility.\n\nAt most one layer of the same group will be visible, when one is shown, the others will be hidden.", "type": "String", "examples": [ "[{name: \"CSR:estados\": toggleGroup:\"political_division\"},\n{name: \"CSR:paises\": toggleGroup:\"political_division\"}\n]" ] }, { "key": "useLayerTooltip", "description": "If false, the layer tooltip is not shown. \nIf a number, the layer tooltip is shown for the specified layer. (Only supported for layers with `source: \"calculate\"`)\nOtherwise follow tooltip default behavior that varies from map source", "type": "Boolean|Number" }, { "key": "verticalMenu", "description": "Uses the compact layout for the Legend Window of the layer: the secondary buttons (remove,\nmetadata, download, zoom to extents) and a vertical opacity slider move into a small options\nmenu opened by a gear button, instead of being drawn in the row with the horizontal opacity\nslider. Usually used together with `customLayerClass`.", "type": "Boolean", "examples": [ "[\n {\n title: 'Compact Legend Window',\n color: '#FFA500',\n elements: [\n {\n title: 'The layer options are in a vertical menu',\n name: 'CSR:geologia',\n source: 'local',\n visibility: true,\n verticalMenu: true,\n customLayerClass: 'my-compact-layer',\n },\n ],\n },\n]" ], "default": "false" } ], "LayersFunctions": [ { "key": "_information", "description": "Functions you write in a layer and the platform calls: expression, afterCalc and legendColor on calculated layers; beforeCalc, onInputsReady, onVisibilityChange and the functions map on calculated and file layers. Inside them this is the layer - except in expression, see Kinds of layer.", "name": "Layer callbacks: functions you write" }, { "key": "afterCalc", "description": "This function is executed right after the 'expression()' calculations.\nThis function is only available for a Layer with a 'source' of type 'calculate' and that has defined the 'expression()' function.\n@param inputs {Array} The value of each input defined in the descriptionHtml. The order of the values is the same as the inputs (i.e. the first input in the descriptionHtml is inputs[0], the second is inputs[1] and so on).", "type": "function", "examples": [ "[\n {\n title: 'Example of afterCalc function',\n color: '#FFA500',\n elements: [\n {\n title: 'This afterCalc function will show a message at the bottom right of the screen',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n {\n type: 'query',\n pressed: true\n },\n ],\n descriptionHtml:\n '{{label|text=The afterCalc is run after every expression() execution}}'\n +\n '{{textfield|fieldLabel=Enter your name|id=textInput|labelStyle=text-align:center;}}',\n // The expression function is mandatory to use the afterCalc function.\n expression: function(layerVals, inputs) {\n return undefined;\n },\n afterCalc: function(inputs) {\n let inputValue = inputs[0];\n ExtjsUtils.ALERTIFY.log('Hello ' + inputValue + '!');\n },\n },\n ],\n },\n]" ], "default": "null" }, { "key": "beforeCalc", "description": "This function is executed before any calculation is made in the 'expression()' function.\nIt runs on calculated layers (`source: 'calculate'`), even when there is no 'expression()', and on file layers\n(`source: 'file'`), where it runs again whenever an input changes or a resource finishes loading (see `VectorLayer.generateNewLegend`).\n@param inputs {Array} The value of each input defined in the descriptionHtml. The order of the values is the same as the inputs (i.e. the first input in the descriptionHtml is inputs[0], the second is inputs[1] and so on).", "type": "function", "examples": [ "[\n {\n title: 'Example of beforeCalc function',\n color: '#FFA500',\n elements: [\n {\n title: 'This beforeCalc function will show a message at the bottom right of the screen',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n {\n type: 'query',\n pressed: true\n },\n ],\n descriptionHtml:\n '{{label|text=The beforeCalc function will be called after every user interaction before any calculation}}'\n +\n '{{textfield|fieldLabel=Enter your name|id=textInput|labelStyle=text-align:center;}}',\n beforeCalc: function(inputs) {\n let inputValue = inputs[0];\n ExtjsUtils.ALERTIFY.log('Hello ' + inputValue + '!');\n },\n },\n ],\n },\n]" ], "default": "null" }, { "key": "expression", "description": "This function is executed for every pixel in the map. It can be used to process the information of all maps in the Layer to create a new one.\nThis function is called regularly to update the map.\n@param layerVals {Array.} Is an array that has the value associated with the current pixel for each map defined in the 'name' property.\nThe values order is the same as the one in ‘name’. For example, if in the 'name' property we have 'name: CSR:geologia,CSR:altimetria' the layerVals[0] has the value for the 'CSR:geologia' map and the layerVals[1] has the value for the 'CSR:altimetria'.\n@param inputs {Array} The value of each input defined in the descriptionHtml. The order of the values is the same as the inputs (i.e. the first input in the descriptionHtml is inputs[0], the second is inputs[1] and so on).", "type": "function", "examples": [ "[\n {\n title: 'Example of expression function',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer is the result of the calculation of two maps',\n name: 'CSR:geologia,CSR:altimetria',\n source: 'calculate',\n legendTitle: 'All geologys above 800m',\n visibility: true,\n expression: function(layerVals, inputs) {\n let geologyValue = layerVals[0];\n let altitudeValue = layerVals[1];\n\n // Hide all values lower than 800\n if (altitudeValue < 800) {\n return undefined;\n }\n\n return geologyValue;\n },\n },\n ],\n },\n]" ], "default": "null", "returnDescription": "Value of each processed pixel." }, { "key": "functions", "description": "Associate custom functions to handle events on layer callbacks such as button callbacks or any layer callbacks.\nThese functions are scoped to the Layer and can be referenced by name on layer widget callbacks.\nFunctions can also be accessed using `this.functions['']`.", "type": "Object", "examples": [ "[\n {\n title: 'Example of functions property',\n color: '#666699',\n elements: [\n {\n title: 'Click the button to see a message',\n name: 'CSR:geologia',\n group: 'Query',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n { \n type:'query',\n pressed: true,\n },\n ],\n descriptionHtml:\n '{{button|id=test_button|text=Click me!|handler=handleTestButtonClick}}',\n functions: {\n handleTestButtonClick: function() {\n ExtjsUtils.ALERTIFY.log('Button clicked!');\n },\n },\n },\n ],\n },\n]" ], "default": "null" }, { "key": "legendColor", "description": "This function generates the color of each value/category of the calculated map generated by the 'expression()' function.\nThe return value is the legend color that will be applied to the category.\nPS: This function callback is called in layer context.\n@param color {Array.} Array with three numbers (0 to 255) that define the RGB color of the original legend.\n@param inputs {Array.} The value of each input defined in the descriptionHtml. The order of the values is the same as the inputs (i.e. the first input in the descriptionHtml is inputs[0], the second is inputs[1] and so on).\n@param lastValue {String} The last legend value that had its color calculated.\n@param currentValue {String} The actual legend value that it's being calculated.\n@param ruleIndex {Numeric} The index of the actual legend value that it’s being calculated. I.e. The first legend value is 0, the second is 1, and so on.", "type": "function", "examples": [ "[\n {\n title: 'Example of legendColor',\n color: '#666699',\n elements: [\n {\n title: 'The legendColor function will generate a custom color for each category, based on its value',\n name: 'CSR:altimetria',\n source: 'calculate',\n updateAutomatically: true,\n visibility: true,\n expression: function(layersVals, inputs) {\n return layersVals[0];\n },\n // This create a custom colors palette for the legend of the result map from the 'expression' function\n legendColor: function(color, inputs, lastValue, currentValue, ruleIndex) {\n let red = 0;\n let green = currentValue * 255 / 1830;\n let blue = 0;\n \n return [red, green, blue];\n },\n },\n ],\n },\n]" ], "returnDescription": "The new color to the value in [R,G,B] format." }, { "key": "onInputsReady", "description": "This function is called when all inputs have been loaded and are ready. Even from Layers that aren’t visible.\n@param inputs {Array} The value of each input defined in the descriptionHtml. The order of the values is the same as the inputs (i.e. the first input in the descriptionHtml is inputs[0], the second is inputs[1] and so on).", "type": "function", "examples": [ "[\n {\n title: 'Example of onInputsReady function',\n color: '#666699',\n elements: [\n {\n title: 'This Layer shows the starting value of the text input field',\n name: 'CSR:geologia',\n group: 'Query',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n { \n type:'query',\n pressed: true,\n },\n ],\n descriptionHtml: \n '{{textfield|id=textInput|fieldLabel=Message|value=I love maps!|labelStyle=text-align:center;}}',\n onInputsReady: function(inputs) {\n let textInputValue = inputs[0];\n ExtjsUtils.ALERTIFY.log('The text input initial value is: ' + textInputValue);\n },\n },\n ],\n },\n]" ], "default": "null" }, { "key": "onVisibilityChange", "description": "This function is called whenever a Layer changes its visibility.\nLike, when the user toggle the value in the visibility button at the top right in the Legend Window.\n@param visibility {Boolean} It’s true if the Layer is visible or false otherwise.\n@param inputs {Object} The value of each input defined in the descriptionHtml. The order of the values is the same as the inputs (i.e. the first input in the descriptionHtml is inputs[0], the second is inputs[1] and so on).", "type": "function", "examples": [ "[\n {\n title: 'Example of callback when changing the visibility',\n color: '#FFA500',\n elements: [\n {\n title: 'The function onVisibilityChange will be called when the visibility of this layer changes.',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n {\n type:\"query\",\n pressed: true\n },\n ],\n descriptionHtml:\n '{{label|text=You can change the map visibility by clicking at the eye icon on the top of this window}}',\n onVisibilityChange: function(state, inputs) {\n if(state) {\n ExtjsUtils.ALERTIFY.log('The layer is now visible');\n }\n else {\n ExtjsUtils.ALERTIFY.log('The layer is now hidden');\n }\n },\n },\n ],\n },\n]" ], "default": "null" } ], "paramsButtonConfigProperties": [ { "key": "_information", "description": "paramsButtonConfig is a key of calculated, file and tile layers: an array with one object per button on the layer's row (query, legend, download, metadata...). These are the keys of each object; a bare object instead of an array is read as the query button.", "name": "Row buttons (paramsButtonConfig)" }, { "key": "enableToggle", "description": "Makes the row button of a `paramsButtonConfig` entry that mirrors a widget (an entry with\n`associatedButtonID`) a toggle (`true`) or a plain push button (`false`).\nPS: Once the mirrored widget is found the platform sets it from that widget (a checkbox or a\ntoggle button makes it a toggle), so your value only counts while the widget does not exist.", "type": "Boolean", "examples": [ "paramsButtonConfig: [{ type: 'associated', associatedButtonID: 'my_button', enableToggle: false }]" ], "default": "true" }, { "key": "hideBottomButton", "description": "Hides the text buttons at the bottom of the query and legend sections of the Legend Window (\"Show\nquery\"/\"Hide query\" and \"Show legend\"/\"Hide legend\"). Set it to 'true' to hide them or 'false' to display\nthem. It only works inside a `paramsButtonConfig` entry of `type: 'query'` (or in the bare object form\nof `paramsButtonConfig`, which is treated as the query entry); a `hideBottomButton` written directly on\nthe layer or in a group's `defaultProperties` is ignored.", "type": "Boolean", "examples": [ "[\n {\n title: 'Example of paramButtonConfig hideBottomButton property',\n color: '#FFA500',\n elements: [\n {\n title: 'The buttons at the bottom of the Legend Window are hidden',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=There are no buttons in here}}',\n paramsButtonConfig: [\n {\n type: 'query',\n hideBottomButton: false,\n },\n ],\n },\n ],\n },\n]" ], "default": "false" }, { "key": "hideButton", "description": "Define if the associated button should be hidden. Set it to 'true' to hide the button or 'false' to show it.\nThis property only applies to the type: 'query'", "type": "Boolean", "examples": [ "[\n {\n title: 'Example of paramButtonConfig hideButton property',\n color: '#FFA500',\n elements: [\n {\n title: 'The query button in hidden',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n { \n type: 'query',\n hideButton: true,\n },\n ],\n },\n ],\n },\n]" ], "default": "false" }, { "key": "iconCls", "description": "Define a class that will be added to the html in the associated button.\n\nThis class can be one that has a image on it like:\n - 'gxp-icon-togglevisibility' is the icon of the Show/Hide Map Button (The first icon on the Legend Window, from left to right)\n - 'gxp-icon-removelayers' is the icon of the Remove Layer Button (The second icon on the Legend Window, from left to right)\n - 'gxp-icon-parameters-expand' is the icon of the Show Query Button (The third icon on the Legend Window, from left to right)\n - 'gxp-icon-legend-expand' is the icon of the Show Legend Button (The forth icon on the Legend Window, from left to right)\n - 'gxp-icon-downloadmapbutton' is the icon of the Download Button (The fifth icon on the Legend Window, from left to right)", "type": "String", "examples": [ "[\n {\n title: 'Example of paramButtonConfig iconCls property',\n color: '#A020F0',\n elements: [\n {\n title: 'The query button is the download icon:',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=Here is the query region}}',\n paramsButtonConfig: [\n { \n type: 'query',\n tooltip: 'This is actually the query button',\n // Here you can add any class you choose\n iconCls: 'gxp-icon-downloadmapbutton',\n },\n ],\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "pressed", "description": "Defines if the button should start pressed or not. Set it to 'true' for it to start pressed or 'false' for start unpressed.\nFor example, the 'query' button type set as pressed will display the Query region (where the descriptionHtml content is) by default instead of the Legend region.\nThis property applies only to the types: 'query',", "type": "Boolean", "examples": [ "[\n {\n title: 'Example of paramButtonConfig pressed property',\n color: '#A020F0',\n elements: [\n {\n title: 'The param button config set the query button to be pressed at the start',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=The region of the descriptionHtml will start opened}}',\n paramsButtonConfig: [\n { \n type: 'query',\n pressed: true,\n },\n ],\n },\n ],\n },\n]" ], "default": "false" }, { "key": "toggleGroup", "description": "Defines a group for all the buttons that has the same toggleGroup name. From all the buttons on the same group, only one can be active at each time. Whenever another one is activated the previous one collapses.", "type": "String", "examples": [ "[\n {\n title: 'Example of paramButtonConfig toogleGroup',\n color: '#FFA500',\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=This is the description of Layer 1. Only one can be open each time.}}',\n paramsButtonConfig: [\n { \n type: 'query',\n toggleGroup: 'Group1',\n },\n ],\n },\n {\n title: 'Layer 2',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=This is the description of Layer 2. Only one can be open each time.}}',\n paramsButtonConfig: [\n { \n type: 'query',\n toggleGroup: 'Group1',\n },\n ],\n },\n {\n title: 'Layer 3',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=This is the description of Layer 3. Only one can be open each time.}}',\n paramsButtonConfig: [\n { \n type: 'query',\n toggleGroup: 'Group1',\n },\n ],\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "tooltip", "description": "Defines the help tooltip text that is displayed when the mouse hover the associated button.", "type": "String", "examples": [ "[\n {\n title: 'Example of paramButtonConfig tooltip property',\n color: '#A020F0',\n elements: [\n {\n title: 'The query button is the third of the buttons at the right:',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n descriptionHtml:\n '{{label|text=Hover the query button. That is the third button from left to right.}}',\n paramsButtonConfig: [\n { \n type: 'query',\n pressed: true,\n },\n ],\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "type", "description": "Define which button will be affected by the configurations. The type can be one of the following:\n\n - 'query': The query button shows or hides the Query panel (where the descriptionHtml is drawn).\n\n - 'download': The download button is the one with a downward arrow. This button allows the user to download the dataset. It also defines which Layer should be downloaded when more than one Layer is shown by its internal layer index.\n\n - 'metadata': The metadata button is the one with a script icon. This button displays a popup with more information about the maps used in the actual Layer. You can make it show one of the inside composite Layer by his index.\n\n - 'associated': Creates a custom button that is linked to another button defined in the descriptionHtml. When one is pressed the other is also pressed.\n\n`paramsButtonConfig` is normally an array of entries and each entry must declare its `type` (an entry\nwithout `type` is ignored). It may also be a single object instead of an array: it is then treated as\none entry of `type: 'query'` (unless the object declares another `type`).\nPS: The properties are aditional, so the common must always be present, and for each type his corresponding property must be added.", "type": "String", "examples": [ "// Example on how to use the query type paramsButtonConfig\n[\n {\n title: 'Example of paramButtonConfig types',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has custom buttons on the Legend Window',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n startLegendOpen: true,\n descriptionHtml:\n '{{label|text=The third button is the Query type}}',\n paramsButtonConfig: [\n { \n type: 'query',\n tooltip: 'This is the query button',\n pressed: true,\n handler: function handleClick(button, clickEvent) {\n ExtjsUtils.ALERTIFY.log('You\\'ve clicked the query button');\n },\n },\n ],\n },\n ],\n },\n]", "// Example on how to use the metadata type paramsButtonConfig \n[\n {\n title: 'Example of paramButtonConfig types',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has custom buttons on the Legend Window',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n startLegendOpen: true,\n descriptionHtml:\n '{{label|text=The third button is the metadata type}}',\n paramsButtonConfig: [\n { \n type: 'query',\n pressed: true,\n },\n { \n type: 'metadata',\n tooltip: 'This is the metadata button',\n handler: function handleClick(button, clickEvent) {\n ExtjsUtils.ALERTIFY.log('You\\'ve clicked the metadata button');\n },\n },\n ],\n },\n ],\n },\n]", "// Example on how to use the download type paramsButtonConfig \n[\n {\n title: 'Example of paramButtonConfig types',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has custom buttons on the Legend Window',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n startLegendOpen: true,\n descriptionHtml:\n '{{label|text=The last button is the download type}}',\n paramsButtonConfig: [\n { \n type: 'query',\n pressed: true,\n },\n { \n type: 'download',\n tooltip: 'This is the download button',\n handler: function handleClick(button, clickEvent) {\n ExtjsUtils.ALERTIFY.log('You\\'ve clicked the download button');\n },\n },\n ],\n },\n ],\n },\n]", "// Example on how to use the associated type paramsButtonConfig\n[\n {\n title: 'Example of paramButtonConfig types',\n color: '#FFA500',\n elements: [\n {\n title: 'This Layer has custom buttons on the Legend Window',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n startLegendOpen: true,\n descriptionHtml:\n '{{label|text=The third button is the associated type}}'\n +\n '{{button|id=test_button|text=This is the custom associated button|enableToggle=true}}',\n paramsButtonConfig: [\n { \n type: 'query',\n pressed: true,\n },\n { \n type: 'associated',\n tooltip: 'This is the custom button',\n associatedButtonID: 'test_button',\n // The handler only triggers for the Legend Window button (not the descriptionHtml associatedButton)\n handler: function handleClick(button, clickEvent) {\n ExtjsUtils.ALERTIFY.log('You\\'ve clicked the custom button');\n },\n },\n ],\n },\n ],\n },\n]" ], "default": "'query'" } ], "paramsButtonConfigFunctions": [ { "key": "_information", "description": "Functions a row-button object can carry; the platform calls them when the button is pressed or toggled.", "name": "Row button callbacks" }, { "key": "handler", "description": "Defines a function that will be called when the associated button is clicked.\n@param button {Object} is the button that was clicked by the mouse.\n@param clickEvent {MouseEvent} is the object that carries more information about the click event.", "type": "function", "examples": [ "[\n {\n title: 'Example of callback when clicking in a Legend Window button',\n color: '#A020F0',\n elements: [\n {\n title: 'The handleClick function will be called when the query button is clicked',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n { \n type: 'query',\n handler: function handleClick(button, clickEvent) {\n ExtjsUtils.ALERTIFY.log('You clicked the query button');\n },\n },\n ],\n },\n ],\n },\n]" ] }, { "key": "toggleHandler", "description": "This function is called whenever the associated button change its toggle state.\nPS: Using custom function, ignore the associatedButtonID \"It doesnt have to even exists\".\n@param button {Ext.Button} The button element that was clicked\n@param state {Boolean} The next state of the button, true means pressed", "type": "function", "examples": [ "[\n {\n title: 'Example of paramButtonConfig toogleHandler',\n color: '#FFA500',\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:geologia',\n source: 'calculate',\n visibility: true,\n paramsButtonConfig: [\n { \n type: 'query',\n toggleHandler: function handleToggle(button, state) {\n let queryButtonState = state ? 'pressed' : 'unpressed';\n console.log(`Layer 1 query button is: ${queryButtonState}`);\n },\n },\n ],\n },\n ],\n },\n]" ], "default": "null" } ] }, "Configuring Layers": { "_information": { "title": "Kinds of layer: what each source adds", "description": "source chooses the kind of a layer: a published map (no source, \"local\", or the key of a server registered with addRemoteWMSServer), a calculated layer (\"calculate\"), a file layer (\"file\") or a tile layer (\"xyz\"). Each group below belongs to one kind: the keys only that kind reads, and the methods its layer object has at run time - what this is inside its functions." }, "QGIS": [ { "key": "_information", "description": "A published map's styles are made when it is published, from its QGIS style file; the automatic publication creates the same-looking style. A query picks one with styles.", "name": "Published maps: styles from QGIS" }, { "key": "styles", "description": "Where a map's styles come from: they are not written in the query. A map is\npublished with one or more styles, and when it is published from QGIS the\nlayer's QGIS style is converted at publication time, so the classes, colours and\nlegend labels the map shows online are the ones set in QGIS. Each converted style\nbecomes a Mappia style identifier - the map name without its namespace, plus `_`\nand an index - and those identifiers are what a query selects with the `styles`\nproperty, what the layer's style chooser lists, and what the legend renders.\n\nSo changing how a map looks is a publication step, not a query change: restyle it\nin QGIS, publish again, and reference the style from the query.", "type": "String", "examples": [ "{\n ...,\n name: 'CSR:estados',\n styles: 'estados_0',\n ...\n }" ] } ], "RawMaps": [ { "key": "_information", "completeAPI": "View the complete Raw Maps API here.", "description": "A raw map is published with each pixel's value instead of a colour. A calculated layer reads such a map with operation (raw, sum, average...) to get exact cell values; without operation it gets the value of the map's legend at each pixel. The colours are then applied in the browser.", "name": "Calculated layers: raw maps and operation tokens" }, { "key": "operations", "description": "Enumeration of the operations a map of a `source: 'calculate'` layer can be decoded with. This is what\nthe `operation` layer key selects, one token per map in `name`; the tokens are the lower-case names\nbelow, matched case and whitespace insensitive. The values are integers; `getFromString(token)` and\n`getName(value)` convert between the two forms.\n - NORMAL (0, an empty or unknown token): a regular WMS image, each cell is a legend colour/category and not a Raw Map.\n - RAW (1, `raw`): each resulting cell has the value of the most centred original cell of the aggregated region.\n - RGBA (2, `rgba`): each resulting cell is an integer packing the RGBA bytes of the pixel (input and output are integers).\n - SUM (3, `sum`): each resulting cell is the weighted sum of the cells of the covered region, the weight being the covered fraction of each cell (VALUE * COVERED_PERCENTAGE).\n - AVERAGE (4, `average`): each resulting cell is the weighted mean of the cells of the covered region.\n - MAX (5, `max`): the greatest cell at least partially covered by the region.\n - MIN (6, `min`): the smallest cell at least partially covered by the region.\n - INTEGRAL (7, `integral`): summed-area table, so the sum inside any rectangle is obtained from its four corner cells only.\n - AREAINTEGRAL (8, `areaintegral`): summed-area table of the covered areas (no further description in the source).\n - AREA (9, `area`): each cell carries the original map area inside the aggregated region, so totals can be computed at any scale with full precision.\n - CELLS (10, `cells`): weighted count of the original cells inside the region.\nEvery operation other than NORMAL and RGBA requires the map to be published as a Raw Map that offers it.", "type": "Object", "examples": [ "LayerWorkerUtils.MapOperations.getFromString('sum'); // 3 (LayerWorkerUtils.MapOperations.SUM)\nLayerWorkerUtils.MapOperations.getName(3); // 'SUM'" ] } ], "LayerInternal": [ { "key": "_information", "completeAPI": "View all layer internal helper functions API here.", "description": "Methods of a calculated layer that your functions call on this - this.setCalculateLegend in beforeCalc, this.changeLayers to switch its maps, this.getInputs... They are not keys you write in the layer.", "name": "Calculated layers: methods (this.)", "writtenAs": "this.{key}" }, { "key": "callFunction", "description": "Calls one of the layer's own `functions` by name with the layer as `this`. Extra\narguments are passed through to the function.\n@param name {String} Key of the layer's `functions` object.\n@param anyArguments {*} Arguments forwarded to the function.", "type": "function(name, anyArguments) : *", "examples": [ "this.callFunction('getAssociatedLayer'); // or this.callFunction('getAssociatedLayer', 'param1', 2, [], {}, 'param5');" ], "returnDescription": "Whatever the function returns." }, { "key": "changeLayers", "description": "Replaces an internal layer at a given index.\nPS: It's highly recommended to pass multiple configurations in an array, instead of calling this function multiple times in the same callback.\n@param newConfigs {Array|Object} One or more layers configurations with a property 'index' indicating the replacing layer.\n Each config object must contain at least the following properties:\n [{name: 'MAP_FULL_NAME', \n styles: 'MAP_STYLE',\n index: 'MAP_INDEX_TO_CHANGE'}, ... ]\n@param force {Boolean} Force redraw even if no change is done when the layer is the same.", "type": "function(newConfigs, force)", "examples": [ "{\n name: \"CSR:rodovias,CSR:municipios\",\n otherNames: \"CSR:roads\",\n beforeCalc: function(layerVals, inputVals) {\n this.changeLayers([{name: 'CSR:roads', styles: fMapName + \"_1\", index: 0}]);\n }\n }" ] }, { "key": "generateNewLegend", "description": "Schedules a new legend: cancels the calculations in progress, runs `beforeCalc(inputs)` with the\ncurrent input values and, when every tile is loaded and the layer is not paused, recalculates the\nmap and its legend. It is the supported way to force the layer to refresh itself from outside a\nnormal calculation cycle (for example from `onVisibilityChange` or a `{{button}}` handler).", "type": "function()", "examples": [ "onVisibilityChange: function(visible, inputs) {\n if (visible && !this.isCalculationPaused()) {\n this.generateNewLegend();\n }\n}" ] }, { "key": "getInputs", "description": "Returns the current value of every input tool declared in `descriptionHtml`, in declaration order\n(the same array `beforeCalc`, `expression` and `afterCalc` receive as `inputs`). A value can be a\nsimple one (number, string) or a complex object (a CSV table, a picked point, ...). Use it from\ncallbacks that do not receive `inputs`, such as a `{{button}}` handler.", "type": "function() : Array", "examples": [ "functions: {\n onClickButton: function() {\n var inputs = this.getInputs();\n ExtjsUtils.ALERTIFY.log('First input: ' + inputs[0]);\n }\n}" ], "returnDescription": "The input values in the order the tools are declared." }, { "key": "getInsideLayers", "description": "Returns the OpenLayers WMS layers that compose this layer, one per map in `name` and in the same\norder (a copy of the internal array, so changing it does not affect the layer).", "type": "function() : Array.", "examples": [ "var firstMapName = this.getInsideLayers()[0].params.LAYERS;" ], "returnDescription": "The inside layers." }, { "key": "getLayerDefinedFunctionsByName", "description": "Returns one of the functions declared in the layer's `functions` object by its name (the same\nfunctions that markup tools reference by name, e.g. `handler=onClick`). Composed-layer twin of\n`VectorLayer.getLayerDefinedFunctionsByName`; the returned function is not bound, so call it with\n`.call(this, ...)` from a layer callback to keep the layer as `this`.\n@param name {String} Key of the layer's `functions` object.", "type": "function(name) : function|undefined", "examples": [ "{\n name: 'CSR:geologia',\n source: 'calculate',\n functions: {\n onClick: function(feature, inputs) { ExtjsUtils.ALERTIFY.log('clicked'); }\n },\n beforeCalc: function(inputs) {\n this.getLayerDefinedFunctionsByName('onClick').call(this, null, inputs);\n },\n}" ], "returnDescription": "The function, or undefined when there is no function with that name." }, { "key": "getLegendEntries", "description": "Returns the entries of the legend currently applied to the calculated map, in legend order. Each\nentry has the `[R, G, B]` colour of the pixels, the `title` shown in the legend (the value itself when\nno title was defined) and whether it represents the null value of the map. Returns an empty array\nbefore the first legend is generated. Use it to build a custom legend (e.g. an HTML gradient) or to\nmap a colour back to its category.", "type": "function() : Array.<{color: Array., title: String, isNull: Boolean}>", "examples": [ "afterCalc: function(inputs) {\n var html = this.getLegendEntries().map(function(entry) {\n return '' + entry.title + '';\n }).join('');\n}" ], "returnDescription": "The legend entries." }, { "key": "getVisibleLayerIndexes", "description": "Returns the indexes (positions in the `name` list) of the composing maps that are currently visible,\nin ascending order. Useful inside `beforeCalc`/`expression` when some of the inside maps were\ntoggled with `setInsideLayerVisibility()`.", "type": "function() : Array.", "examples": [ "beforeCalc: function(inputs) {\n var visible = this.getVisibleLayerIndexes(); // e.g. [0, 2]\n}" ], "returnDescription": "Indexes of the visible inside maps." }, { "key": "isCalculationPaused", "description": "Returns calculation status.\nTrue if calculations are paused, false otherwise.", "type": "function() : Boolean", "returnDescription": "Calculation is paused" }, { "key": "pauseAndStopCalculations", "description": "Cancels the calculations in progress and pauses the start of new ones (the \"generating legend\"\nindicator is shown while paused). Call it when something the expression depends on starts loading,\nand `resumeCalculations()` when it is done. The pause is cumulative: every call needs a matching\n`resumeCalculations()` before the layer calculates again (`isCalculationPaused()` tells the state).", "type": "function()", "examples": [ "onInputsReady: function(inputs) {\n var layer = this;\n layer.pauseAndStopCalculations();\n ExtjsUtils.REQUEST.get('https://maps.csr.ufmg.br/theme/app/data/example.json', function(resp) {\n layer.myData = JSON.parse(resp.responseText);\n layer.resumeCalculations(); // redraws with the loaded data\n });\n}" ] }, { "key": "resumeCalculations", "description": "Undoes `pauseAndStopCalculations()`. Call it whenever a resource finished loading; when the last\npending pause is released the layer is redrawn (which recalculates it).\n@param qnt {Number} How many pauses to release at once. `0` releases nothing and never redraws;\n omitted means 1.", "type": "function(qnt)", "examples": [ "this.resumeCalculations();" ] }, { "key": "setCalculateLegend", "description": "Defines the legend of the calculated map yourself, which also skips the automatic legend calculation\nfor this cycle. It is meant to be called inside `beforeCalc`, the moment right before a new legend\nwould be computed, but it can also be called from a tool callback (e.g. a `{{button}}` handler).\nWhen the given entries equal the current legend nothing is redrawn.\n@param legendEntries {Array.<{color: Array., value: *, title: String}>} Legend entries sorted by `value` in ascending order (entries out of order are ignored). `color` is the `[R, G, B]` colour of the entry, `value` the highest value that maps to it, `title` the label shown in the legend.", "type": "function(legendEntries)", "examples": [ "beforeCalc: function(inputs) {\n this.setCalculateLegend([\n {color: [0, 0, 255], value: 500, title: 'Up to 500 m'},\n {color: [255, 255, 0], value: 1000, title: 'From 500 m to 1000 m'},\n {color: [255, 0, 0], value: 3000, title: 'Above 1000 m'},\n ]);\n}" ] }, { "key": "setInsideLayerVisibility", "description": "Shows or hides the maps that compose the layer (the ones listed in `name`) without touching the layer\nitself. Pass `layerIndex` to change one map only, omit it to change all of them. The platform hides\nevery inside map when the layer has an `expression()` (only the calculated result is shown) and shows\nthem all otherwise; use this to reveal one of the source maps behind a calculated result.\n@param visibility {Boolean} True to show the map(s), false to hide them.\n@param layerIndex {Number} Index of the map in the `name` list; when omitted every inside map is changed.", "type": "function(visibility, layerIndex)", "examples": [ "afterCalc: function(inputs) {\n this.setInsideLayerVisibility(true, 0); // show the first source map under the calculated result\n}" ] }, { "key": "setLayerOperation", "description": "Sets the decoding operation of one of the maps of the composed layer (the same tokens accepted by the\n`operation` layer key, e.g. `'raw'`, `'sum'`, `'average'`; `''` or `null` means the default decoding).\nThe platform calls it from the `operation` key at creation; when called at runtime the new operation\nis only used after the map legends are read again (for example when `changeLayers` replaces a map).\n@param layerIndex {Number} Index of the map in the `name` list (0 based).\n@param operation {String} Operation token, or `''`/`null` for the default decoding.", "type": "function(layerIndex, operation)", "examples": [ "this.setLayerOperation(1, 'sum');" ] } ], "ValuesCalculation": [ { "key": "_information", "description": "Inside expression, this is the calculation, which runs in a separate worker - not the layer: this.nullValue, this.isNumeric(value)... Page globals are not there. The same helpers are reachable as ValuesCalculation.prototype.<method>.", "name": "Calculated layers: this inside expression", "writtenAs": "this.{key}" }, { "key": "calcTilesValues", "description": "Internal — the pixel loop of a `calculate` layer: for every pixel of the tile it reads\none value per inner map (colour looked up in the map's legend, or the raw cell value for\n`raw`/`sum`/... operations) and calls the layer's `expression(layersVals, inputs)` with\nthem. Pixels that are null in every map become `this.nullValue` without calling the\nexpression. The expression is invoked with `this` bound to this ValuesCalculation\ninstance, which is why `this.isNumeric(v)` works inside an expression\n(`ValuesCalculation.prototype.isNumeric(v)` also works). Tenant code never calls this\ndirectly; the layer worker does.\n@param imageDataTiles {Array.} One ImageData `data` array per inner map, for the same tile position (without the result tile).\n@param inputs {Array} The layer's input values, in the order defined for the layer (what `expression` receives as its second argument).", "type": "function(imageDataTiles, inputs) : Array.<(Number|String)>", "returnDescription": "One result per pixel, in the tile's pixel order." }, { "key": "getColorFromInt", "description": "Unpacks the four RGBA bytes packed in a 32-bit integer: byte 0 (lowest) is red, byte 1\ngreen, byte 2 blue and byte 3 alpha. This is the packing the `rgba` map operation uses,\nwhere a pixel colour travels as one integer (the layer worker paints such results with\n`getNonNullColorFromInt`). Inside an `expression` function `this` is the\nValuesCalculation instance, so `this.getColorFromInt(v)` works there;\n`ValuesCalculation.prototype.getColorFromInt(v)` also works, anywhere.\n@param value {Number} The packed RGBA integer.", "type": "function(value) : Array.", "examples": [ "ValuesCalculation.prototype.getColorFromInt(0xFF0080FF); // [255, 128, 0, 255]", "expression: function(layersVals, inputs) {\n var rgba = this.getColorFromInt(layersVals[0]); // an inner map with operation: \"rgba\"\n return rgba[3] === 0 ? this.nullValue : (rgba[0] + rgba[1] + rgba[2]) / 3; // grey level\n}" ], "returnDescription": "`[r, g, b, a]`, each component in 0..255." }, { "key": "getNonNullColorFromInt", "description": "`getColorFromInt` with a null check: returns `this.nullColor` (`null`) when the packed\ninteger is one of the values listed in `nullValues`, and the unpacked `[r, g, b, a]`\notherwise. Handy when a map encodes \"no data\" as one or more specific colours. Inside\nan `expression` function `this` is the ValuesCalculation instance, so\n`this.getNonNullColorFromInt(v, nulls)` works there;\n`ValuesCalculation.prototype.getNonNullColorFromInt(v, nulls)` also works, anywhere.\n@param value {Number} The packed RGBA integer (see `getColorFromInt`).\n@param nullValues {Array.} Packed integers that should be treated as null.", "type": "function(value, nullValues) : Array.|null", "examples": [ "expression: function(layersVals, inputs) {\n var rgba = this.getNonNullColorFromInt(layersVals[0], [0, 0xFFFFFFFF]);\n return rgba === null ? this.nullValue : rgba[0];\n}" ], "returnDescription": "`[r, g, b, a]`, or `null` when `value` is in `nullValues`." }, { "key": "getValueFromLegend", "description": "Turns a legend label into the value that best represents it — the same conversion the\ncalculation applies to every map legend before the expression sees `layersVals`. A\nnumeric label (`\"12\"`, `\"1,5\"`, `\"1.000\"`) becomes that number (a single comma is read\nas the decimal separator, `\"1.000\"`/`\"1,000\"` as thousands), a range\n(`\"10 - 20\"`, `\"10 – 20\"`, `\"10 to 20\"`) becomes its midpoint, a leading comparison\noperator (`\"> 800\"`, `\"<= 5\"`, `\"> 800\"`) is stripped first, and any other text\n(`\"Floresta\"`) is returned unchanged. An empty label returns `null`. Use it to interpret\nlegend titles you read with `ExtjsUtils.LAYER.getLayerLegend` the same way the layer does.\nInside an `expression` function `this` is the ValuesCalculation instance, so\n`this.getValueFromLegend(label)` works there; `ValuesCalculation.prototype.getValueFromLegend(label)`\nalso works, anywhere. To mark a pixel transparent, pass/return `this.nullValue`.\n@param legend {String} The legend title to interpret.", "type": "function(legend) : Number|String|null", "examples": [ "ValuesCalculation.prototype.getValueFromLegend(\"10 - 20\"); // 15\nValuesCalculation.prototype.getValueFromLegend(\"> 800\"); // 800\nValuesCalculation.prototype.getValueFromLegend(\"1,5\"); // 1.5\nValuesCalculation.prototype.getValueFromLegend(\"Floresta\"); // \"Floresta\"" ], "returnDescription": "The number the label represents, the label itself when it is not numeric, or `null` when it is empty." }, { "key": "isNumeric", "description": "Tells whether a value represents a number: a Number, or a String that is a plain\ndecimal/exponential number (`\"12\"`, `\"-3.5\"`, `\"1e3\"`). Map values read from a legend\ncan be either a number or the legend's text (e.g. `\"Floresta\"`), so use this in an\n`expression` before doing arithmetic on `layersVals[i]`. Inside an `expression` function\n`this` is the ValuesCalculation instance, so `this.isNumeric(v)` works there;\n`ValuesCalculation.prototype.isNumeric(v)` also works, anywhere.\n@param value {String|Number} The value to test.", "type": "function(value) : Boolean", "examples": [ "[{\n name: \"CSR:cultivo_cafe_cafe\",\n source: \"calculate\",\n expression: function(layersVals, inputs) {\n // layersVals[0] may be a legend label instead of a number\n return this.isNumeric(layersVals[0]) ? layersVals[0] * inputs[0] : this.nullValue;\n }\n}]" ], "returnDescription": "`true` when the value is numeric, `false` otherwise." }, { "key": "nullValue", "description": "The value that stands for \"no data\" in a calculation: `NaN`. Return `this.nullValue`\nfrom an `expression` to leave the pixel transparent, and compare against it (with\n`isNaN`) when an inner map's value may be null. Inside an `expression` function `this`\nis the ValuesCalculation instance, so `this.nullValue` is the way to reach it there\n(`ValuesCalculation.prototype.nullValue` works anywhere).", "type": "Number", "examples": [ "expression: function(layersVals, inputs) {\n if (isNaN(layersVals[0]) || layersVals[0] < inputs[0]) {\n return this.nullValue; // transparent pixel\n }\n return layersVals[0];\n}" ] }, { "key": "simplifyLegend", "description": "Returns a shorter representation of a numeric value for display in a legend: values with\nan absolute value below 0.005 are written in exponential notation with 2 decimals,\nother values below 1 are kept to 3 significant digits and everything else is rounded\nto 2 decimals. Non-numeric values are returned unchanged. Useful inside `afterCalc` or\n`legendTitle` code that formats the legend entries of a calculated layer. Inside an\n`expression` function `this` is the ValuesCalculation instance, so `this.simplifyLegend(n)`\nworks there (and `ValuesCalculation.prototype.simplifyLegend(n)` works anywhere).\n@param n {Number|String} The value to simplify.", "type": "function(n) : Number|String", "examples": [ "ValuesCalculation.prototype.simplifyLegend(0.001234); // \"1.23e-3\"\nValuesCalculation.prototype.simplifyLegend(0.4567); // \"0.457\"\nValuesCalculation.prototype.simplifyLegend(1234.5678); // 1234.57" ], "returnDescription": "The simplified value (a string when exponential notation or `toPrecision` was used), or `n` itself when it is not numeric." } ], "JsonLegendReader": [ { "key": "_information", "description": "Reads the JSON legends of the maps of a Composed layer, reachable as layer.jsonLegendReader. Prefer ExtjsUtils.LAYER.getLayerLegend for the common case.", "name": "Calculated layers: legend reader" }, { "key": "getJsonLegend", "description": "Returns the loaded legend entries of a map: an array of `{color: [r, g, b], title}`\nobjects in legend order, or `undefined` while the legend has not been loaded (or\nfailed). This is the documented route to a map's legend — it accepts the layer\nobject itself and is what `ExtjsUtils.LAYER.getLayerLegend(composedLayer, index)`\nuses; the inner `jsonLegends.getJsonLegend(id)` needs the unique id instead.\n@param layer {OpenLayers.Layer|String} The layer object (an inner map of a Composed layer, typically), or its unique id.", "type": "function(layer) : Array.|undefined", "examples": [ "// inside afterCalc / onInputsReady of a Composed layer (this === the layer)\nvar entries = this.jsonLegendReader.getJsonLegend(this.layers[0]) || [];\nentries.forEach(function(entry) {\n console.log(entry.title, ExtjsUtils.HTML.rgbToColorStyle(entry.color));\n});" ], "returnDescription": "The legend entries `{color: Array, title: String}`, or `undefined` when not loaded." }, { "key": "getLayerOperationCellType", "description": "Returns the cell type (`LayerWorkerUtils.CellTypes`: `INT32`, `UINT32`, `FLOAT32`)\nthe calculation must use to decode a map under a given operation, as declared by\nthe map's description metadata. Falls back to `INT32` when the map does not declare\nthe operation (see `hasOperation`). Mostly informational for query authors; the\ncalculation calls it itself.\n@param layer {OpenLayers.Layer|String} The layer object, or its unique id.\n@param operation {Number} The operation, one of `LayerWorkerUtils.MapOperations`.", "type": "function(layer, operation) : Number", "examples": [ "var cellType = layer.jsonLegendReader.getLayerOperationCellType(layer.layers[0], LayerWorkerUtils.MapOperations.RAW);\nconsole.log(cellType === LayerWorkerUtils.CellTypes.FLOAT32);" ], "returnDescription": "The cell type, one of `LayerWorkerUtils.CellTypes`." }, { "key": "getLayerUniqueId", "description": "Returns the key under which the reader stores a layer's legend: the string itself\nwhen given a string, the layer's `id` (assigned by `Ext.id`) when given a WMS layer\nobject, and an empty string for anything else (a layer without `params`). Use it to\nbuild the id the `jsonLegends` manager methods expect.\n@param layer {OpenLayers.Layer|String} The layer object, or an id already.", "type": "function(layer) : String", "examples": [ "var id = layer.jsonLegendReader.getLayerUniqueId(layer.layers[0]);\nvar loaded = layer.jsonLegendReader.jsonLegends.wasLoaded(id);" ], "returnDescription": "The layer's unique id." }, { "key": "getLegend", "description": "Looks up the legend title of a colour in a map's legend: the `title` of the entry\nwhose `[r, g, b]` equals the first three components of `color`. Returns an empty\nstring when the map has no legend loaded, the colour is not in it, or `color` has\nfewer than three components. This is what turns a pixel colour read from an inner map\ninto its class name (e.g. for a tooltip); for the Composed layer's own calculated\nlegend use `ExtjsUtils.LEGENDS.getColorTitle(layer, r, g, b)` instead.\n@param layer {OpenLayers.Layer|String} The layer object, or its unique id.\n@param color {Array.} The colour to look up, `[r, g, b]` or `[r, g, b, a]`.", "type": "function(layer, color) : String", "examples": [ "var title = layer.jsonLegendReader.getLegend(layer.layers[0], [0, 128, 0]); // \"Floresta\"" ], "returnDescription": "The legend title, or `\"\"` when there is none." }, { "key": "hasOperation", "description": "Tells whether a map supports a given decoding operation (see `RawMaps.operations`):\nthe `normal` and `rgba` operations are always supported (they only need the WMS\nimage), the others (`raw`, `sum`, `average`, ...) only when the map's description\nmetadata declares a cell type for them. Useful to check, after the legends loaded,\nwhether an `operation` you plan to set on a layer will actually work.\n@param layerID {OpenLayers.Layer|String} The layer object, or its unique id.\n@param operationType {Number} The operation, one of `LayerWorkerUtils.MapOperations` (e.g. `LayerWorkerUtils.MapOperations.RAW`).", "type": "function(layerID, operationType) : Boolean", "examples": [ "var supportsRaw = layer.jsonLegendReader.hasOperation(layer.layers[0], LayerWorkerUtils.MapOperations.RAW);" ], "returnDescription": "`true` when the map supports the operation." }, { "key": "jsonLegends", "description": "The legend store of the reader, keyed by layer unique id (see `getLayerUniqueId`:\na layer's `id`, e.g. `layer.layers[0].id` for an inner map of a Composed layer).\nQueries reach it as `layer.jsonLegendReader.jsonLegends` and mostly call\n`getJsonLegend(id)`; prefer the outer `getJsonLegend(layer)` or\n`ExtjsUtils.LAYER.getLayerLegend(layer, index)` when you hold the layer object.\nIts four methods:\n`getJsonLegend(layerUniqueId)` → `Array<{color: [r, g, b], title: String}>|undefined` —\nthe loaded legend entries (`undefined` while not loaded or after `remove`);\n`setJsonLegend(layerUniqueId, legendArray)` — stores a legend array for that id;\n`wasLoaded(layerUniqueId)` → `Boolean` — whether a legend (even an empty one) is stored;\n`remove(layerUniqueId)` — forgets the stored legend, so it is fetched again next time.", "type": "Object", "examples": [ "// colour of the legend entry whose title matches a value, for a Composed layer's first map\nfunction getLegendColor(composedLayer, title) {\n var entries = composedLayer.jsonLegendReader.jsonLegends.getJsonLegend(composedLayer.layers[0].id) || [];\n for (var i = 0; i < entries.length; i++) {\n if (entries[i].title === title) return ExtjsUtils.HTML.rgbToColorStyle(entries[i].color);\n }\n return null;\n}" ] }, { "key": "setLayerLegend", "description": "Stores the legend of a layer from its JSON content, replacing whatever the reader had\nfor it. The platform calls it when a legend request finishes; a query can call it to\ninject a legend for a map that has none (or to override the server's), e.g. before a\n`calculate` layer reads the legend values. A string is evaluated as JSON.\n@param layer {OpenLayers.Layer|String} The layer object, or its unique id (see `getLayerUniqueId`).\n@param legendContent {String|Array.} The legend: an array of `{color: [r, g, b], title: String}` entries, or that array as JSON text.", "type": "function(layer, legendContent)", "examples": [ "layer.jsonLegendReader.setLayerLegend(layer.layers[0], [\n {color: [0, 128, 0], title: \"Floresta\"},\n {color: [255, 255, 0], title: \"Agricultura\"}\n]);" ] } ], "FileLayer": [ { "key": "_information", "description": "source: \"file\": where the features come from - json written in the query (the default type), type with a url, or type \"load\" with your own loadData.", "name": "File layers: data" }, { "key": "json", "description": "Inline data of a `source: 'file'` layer with `type: 'json'`. Either a GeoJSON object (FeatureCollection,\nFeature or a geometry; its projection is taken from `fromProj`, its `crs` or guessed from the\ncoordinates) or an array of plain objects, each converted to a feature with\n`convertJsonEntryToFeature` (see `coordinates`/`getVector`). A JSON string is also accepted.", "type": "Array.|Object", "examples": [ "{\n name: 'CSR:inline_points',\n source: 'file',\n type: 'json',\n fromProj: 'EPSG:4326',\n json: [\n {name: 'Belo Horizonte', lon: -43.94, lat: -19.92},\n {name: 'Brasilia', lon: -47.88, lat: -15.79},\n ],\n}" ] }, { "key": "loadData", "description": "Custom loader of a `source: 'file'` layer with `type: 'load'`: `function(inputs, config)` called with\nthe layer as `this`, receiving the current input values and the layer definition. Add the features\nyourself (`this.addFeatures`, `this.loadGeojson`, ...) and trigger `startLoadingLayer` before and\n`endLoadingLayer` after every asynchronous load, so the layer knows when the data is ready\n(`onInputsReady`/`onLoad` depend on it).", "type": "function", "examples": [ "{\n name: 'CSR:filtered_file',\n source: 'file',\n type: 'load',\n url: 'https://maps.csr.ufmg.br/theme/app/data/example.geojson',\n loadData: function(inputs, config) {\n var layer = this;\n layer.events.triggerEvent('startLoadingLayer');\n ExtjsUtils.REQUEST.get(config.url, function(resp) {\n var geojson = JSON.parse(resp.responseText);\n geojson.features = geojson.features.filter(function(feat) {\n return feat.properties.area > 100;\n });\n layer.loadGeojson(geojson);\n layer.events.triggerEvent('endLoadingLayer');\n }, function() {\n layer.events.triggerEvent('endLoadingLayer');\n }, false, layer);\n },\n}" ] }, { "key": "onVisibilityChange", "description": "Callback when layer visibility is changed.\n\nPS: Is not called for the initial visibility of the layer.", "type": "function", "examples": [ "[{...\n onVisibilityChange: function(visibilityChangeEvent) {\n\n alert(\"layer visibility changed\");\n }\n}]\n\nLayer scope and evt as parameter." ] }, { "key": "type", "description": "Defines how a `source: 'file'` layer gets its features (case insensitive). One of:\n\n'load': you load the data yourself in the `loadData` callback (`function(inputs, config)`, called with the layer as `this`).\n The callback must trigger `this.events.triggerEvent('startLoadingLayer')` before and `this.events.triggerEvent('endLoadingLayer')` after each load (the calls are cumulative).\n'csv': fetches the CSV file at `url`; each line becomes a feature through `convertJsonEntryToFeature` (see `coordinates`/`getVector`).\n'json': uses the inline `json` data: a GeoJSON object (FeatureCollection, Feature or geometry) or an array of plain objects converted with `convertJsonEntryToFeature`.\n'jsonurl': fetches an array of plain objects from `url` and converts each one with `convertJsonEntryToFeature`.\n'geojsonurl': fetches a GeoJSON file from `url` (projection detected from its `crs`, `fromProj` or the coordinates).\n'empty': creates no feature; the usual choice for layers that are drawn into or filled later with `loadGeojson`/`addFeatures`.\n\nWhen omitted the type is 'json'; an unknown value falls back to 'jsonurl'.", "type": "String", "examples": [ "[\n {\n title: 'Vector layers',\n color: '#FFA500',\n elements: [\n {\n title: 'Municipalities from a GeoJSON file',\n name: 'CSR:municipalities_file',\n source: 'file',\n type: 'geojsonurl',\n url: 'https://maps.csr.ufmg.br/theme/app/data/example.geojson',\n visibility: true,\n },\n {\n title: 'Empty layer to draw on',\n name: 'CSR:drawing_file',\n source: 'file',\n type: 'empty',\n visibility: true,\n },\n ],\n },\n]" ], "default": "\"json\"" }, { "key": "url", "description": "URL of the data of a `source: 'file'` layer, used by the types `csv` (a CSV file), `jsonurl` (a JSON\narray of plain objects) and `geojsonurl` (a GeoJSON file). Relative URLs are resolved against the\nMappia page. Also available inside `loadData` as `config.url` for `type: 'load'`.", "type": "String", "examples": [ "{\n name: 'example_points',\n source: 'file',\n type: 'jsonurl',\n // shipped with the platform: [{\"lon\":-50, \"lat\":-10, \"name\":\"name1\"}, ...]\n url: '/theme/app/data/points_example.json',\n coordinates: {x: 'lon', y: 'lat'},\n}" ] } ], "VectorLayer": [ { "key": "_information", "completeAPI": "View complete VectorLayer documentation API here.", "description": "Keys and methods of a file layer: styles, clustering, click and hover callbacks (onClick, onHover), drawing (drawable), and the methods your functions call on this.", "name": "File layers: style, events, drawing" }, { "key": "activateDrawMode", "description": "Select polygon/line tool and enter edit mode when needed (split-button menu).\n@param mode {String} 'polygon' or 'line' — must be one of the layer's configured `drawModes`.", "type": "function(mode) : Boolean", "returnDescription": "true if the mode was activated (entering edit mode if not already active);\n false if `mode` isn't in the layer's `drawModes`." }, { "key": "applyFeatureChanges", "description": "Finish sketch or deselect feature (triggers featureEditEnd when applicable).", "type": "function() : Boolean", "returnDescription": "true if a sketch was finished or a feature was deselected; false if\n there was no active modify control." }, { "key": "applyGeomOp", "description": "Replace geometries on this **drawable VectorLayer** with id/attribute control via one options object.\nOnly available on vector layers from ``VectorFileSource`` (e.g. ``drawable: true``).\nImplementation helpers live in {@link DrawableSplit.applyGeomOp}.\n@param sourceGeoms {Array.} Features selected by `feature.geometry` identity.\n@param options {Object|function} If a function, treated as ``{ operation: fn }``.\n@param options.operation {String|function} ``'difference'`` | ``'intersection'`` | ``'keep'`` or ``function(sourceGeom, sourceFeature) => Geometry[]``.\n@param options.with {OpenLayers.Geometry} Operand for difference / intersection.\n@param options.attributes {String|function} ``'keep'`` | ``'empty'`` or ``function(sourceAttrs, pieceIndex, pieceCount) => Object``.\n@param options.preserveId {Boolean} First piece of each source keeps OpenLayers id/fid.", "type": "function(sourceGeoms, options) : Object", "examples": [ "// Cut overlaps (difference) — ``layer`` must be a drawable VectorLayer\n layer.applyGeomOp(intersecting, {\n operation: 'difference', with: editedUnion\n });\n // Clip to CAR (intersection)\n layer.applyGeomOp(outsideGeoms, {\n operation: 'intersection', with: carGeometry\n });\n // Custom pieces + empty attrs\n layer.applyGeomOp(geoms, {\n operation: function(g) { return [myTransform(g)]; },\n attributes: 'empty'\n });" ] }, { "key": "callFunction", "description": "Calls one of the layer's own `functions` by name with the layer as `this`;\nfalls back to a method of the layer with that name. Extra arguments are\npassed through to the function.\n@param name {String} Key of the `functions` object (or a layer method name).\n@param anyArguments {*} Arguments forwarded to the function.", "type": "function(name, anyArguments) : *", "examples": [ "{...\n functions: {\n FUNCTION_NAME: function(parameter1) {\n var layer = this;\n console.log(this, parameter1);\n }\n },\n beforeCalc: function () {\n this.callFunction('FUNCTION_NAME', 'parameter1');\n }\n}" ], "returnDescription": "Whatever the function returns; undefined when no function was found." }, { "key": "cancelDrawing", "description": "Cancel the in-progress sketch/edit without committing changes.", "type": "function() : Boolean", "returnDescription": "true if a sketch was cancelled; false if there was no active modify control." }, { "key": "cluster", "description": "AnimatedCluster options. Truthy object enables clustering even when\n`clusterDistance` is omitted.\n\nZoom / map state is **not** passed into callbacks — read it yourself via\n`this.layer.map` (call scope is the strategy) or `ExtjsUtils.JS.getMap()`.", "type": "Object", "examples": [ "cluster: {\n distance: function() {\n return this.layer.map.getZoom() > 14 ? 40 : 80;\n },\n clusterKey: function(feature) {\n var zoom = this.layer.map.getZoom();\n if (zoom <= 10) return feature.attributes.regiao;\n if (zoom <= 14) return feature.attributes.bairro;\n return null; // distance only\n },\n clusterGeometry: function(cluster) {\n var key = cluster.attributes.clusterKey;\n var zoom = this.layer.map.getZoom();\n if (zoom <= 10 && REGION_GEOMS[key]) return REGION_GEOMS[key];\n if (zoom <= 14 && BAIRRO_GEOMS[key]) return BAIRRO_GEOMS[key];\n return this.defaultClusterGeometry(cluster); // hull / point\n },\n minClusterPolygonPx: 28\n}" ] }, { "key": "clusterDistance", "description": "Defines the minimum relative distance (in pixels) to clusterize points.\nSet 0 to never clusterize, or a value greater than 0 to set the minimum distance.\nFor a membership key or dynamic distance, use {@link VectorLayer.cluster} instead\n(or together — `cluster` options win; `clusterDistance` fills default `distance`).\nPS: When filters are applied, you can use the property 'count' on 'VectorLayer.styleMap' property to check how many points exists in the current cluster.\n\n(Standalone doc comment: the value is read inside `strategies` below, which\ncarries the `cluster` block, so this one is named explicitly.)", "type": "Numeric" }, { "key": "convertJsonEntryToFeature", "description": "Converts a JsonObject into a Layer Feature (that can be added to layer).\n@param curObj {JsonObject} Object with properties.\n@param optionalGetLonLat {function} Optional function to get position coordinates from JSON.\n P.S.: Optional function to get X,Y values from Obj. (By default Longitude and Latitude use fields: lon and lat)\n function optionalGetLonLat(curObj) returns OpenLayers.LonLat\n curObj: Object with JSON properties.\n This function receive the 'curObj' and expects to returns the object properties.", "type": "function(curObj, optionalGetLonLat) : OpenLayers.Feature.Vector", "returnDescription": "Returns the Feature from JsonObj." }, { "key": "coordinates", "description": "Redefines the coordinate property names to {x, y}.\nPS: Used only if the 'VectorLayer.getVector' is not defined.", "type": "Object", "examples": [ "coordinates: {\n 'x': 'lon',\n 'y': 'lat'\n }" ] }, { "key": "defaultStyle", "description": "Defines the default style that will be applied to the geometry. \nPS: Accepts 'context' and 'rules'.\n Property 'context': allows definition of functions.\n Property 'rules': allows definition of filters (only the geometries that fit into this rule will be displayed).\n\nLook at some examples at: http://dev.openlayers.org/examples/", "type": "Object", "examples": [ "defaultStyle: {color: '${getColor}', context: {getColor: function(attr){return 'green';} }" ] }, { "key": "deselectFeature", "description": "Deselect the currently selected/edited feature without discarding it.", "type": "function() : Boolean", "returnDescription": "true if a feature was deselected; false if there was no active modify\n control or nothing was selected." }, { "key": "drawable", "description": "Makes a vector layer editable: users can sketch, edit and delete polygon\n(optionally polygon+line) features, with configurable overlap resolution.\nSet to `true` for defaults, or an object to configure:\n - `maxGeomCount` {Number} — maximum number of features allowed on the layer.\n - `onFeaturesChange` {Function(evt)} — fires on any feature-set change\n (add/remove/clear/load); `evt.type` identifies the cause.\n - `onGeomLimitReached` {Function} — called when a draw attempt would exceed `maxGeomCount`.\n - `onEditToggle` {Function(active, detail)} — sketch/edit mode turned on or off.\n `detail`: `{ active, editingIntent, reason }`, `reason` is `'toggle'` (user/tenant)\n or `'visibility'` (layer show/hide).\n - `onDrawingStatusChange` {Function(detail)} — fine-grained sketch/edit state for UI.\n `detail.status`: `'off'|'ready'|'drawing'|'drawing_line'|'feature_selected'|'vertex_drag'`,\n plus `drawMode`, `canFinishDrawing`, `canApplyFeatureChanges`, `sketchPointCount`,\n `selectedFeature`.\n - `drawModes` {Array} — `['polygon']` (default) or `['polygon','line']`,\n the sketch tools available in edit mode. Alias: `drawingTypes`.\n - `drawingHints` {String|Boolean} — `false`|`true`|`'toolbar'`|`'bar'`|`'both'`,\n lightweight on-map edit guidance.\n - `onOverlap` {String|Array} — a single action key (applied without prompt)\n or an ordered list of keys to prompt for when a new/edited feature overlaps\n another. Defaults to merge/cut/keep ({@link DrawableSplit.OVERLAP_ACTIONS}).\n Applied by ``layer.resolveOverlap``.\n - `buttons` {Object} — layer-row toolbar overrides: `edit`, `clear`, `removeLast`, `loadFile`.\n\nExposed at runtime as `layer.drawableController` — see VectorLayer.activateDrawMode,\nVectorLayer.finishDrawing, VectorLayer.cancelDrawing, VectorLayer.deselectFeature,\nVectorLayer.applyFeatureChanges.", "type": "Boolean|Object", "examples": [ "[{\n name: \"CSR:file_draw\", source: \"file\", type: \"empty\",\n drawable: {\n maxGeomCount: 5,\n drawModes: ['polygon', 'line'],\n onOverlap: ['merge', 'cut', 'keep'],\n onDrawingStatusChange: function(detail) { console.log(detail.status); },\n onEditToggle: function(active, detail) { console.log(active, detail.reason); }\n }\n}]" ] }, { "key": "fillGeometryLayer", "description": "Loads (or reloads) the layer's features from a data-loading config, following\nits `type` strategy: `load` calls `config.loadData`, `csv`/`jsonurl`/\n`geojsonurl` fetch `config.url`, `json` uses the inline `config.json`, `empty`\nadds nothing. Unknown types fall back to `jsonurl`. This is what the platform\ncalls with the layer definition; call it yourself to swap the data at runtime.\n@param config {GeometryLayerConfig} Data-loading configuration.", "type": "function(config)", "examples": [ "layer.fillGeometryLayer({\n url: 'https://maps.csr.ufmg.br/theme/app/data/conab/limite_macroregioes.geojson',\n type: 'load',\n loadData: function(inputs, config) {\n var layer = this;\n function featFilterCb(feat){\n return ['31', '35'].indexOf(feat.properties.geocodigo.toString().substring(0, 2)) !== -1;\n }\n layer.events.triggerEvent('startLoadingLayer');\n ExtjsUtils.REQUEST.get(config.url, function(resp) {\n var jsonObjects = JSON.parse(resp.responseText);\n jsonObjects.features = jsonObjects.features.filter(featFilterCb);\n layer.addFeatures(layer.convertGeojson2Features(jsonObjects));\n layer.events.triggerEvent('endLoadingLayer');\n }, function() {\n layer.events.triggerEvent('endLoadingLayer');\n }, false, layer);\n }\n})" ] }, { "key": "findFeatureById", "description": "Find a feature by the id returned from ``getFeatureId`` (fid, id, or index).\nPrefer this over OpenLayers ``getFeatureById`` when callers use getFeatureId ids.\n@param featureId {String|Number} Id as returned by `getFeatureId`.", "type": "function(featureId) : OpenLayers.Feature.Vector|null", "returnDescription": "The matching feature, or null." }, { "key": "finishDrawing", "description": "Commit in-progress polygon sketch (same as double-click).", "type": "function() : Boolean", "returnDescription": "true if a sketch was committed; false if there was no active modify control." }, { "key": "fromProj", "description": "Defines the projection of the JSON (accepts only EPSG:4326 and EPSG:900913).", "type": "String", "examples": [ "EPSG:900913" ] }, { "key": "generateNewLegend", "description": "Runs the layer's `beforeCalc(inputs)` again with the current input values. It is the supported way\nto force a vector layer to refresh whatever `beforeCalc` builds (styles, filters, charts) from\noutside a normal cycle, for example from `onVisibilityChange`; the platform calls it itself when a\nresource finishes loading. Guard it with `isCalculationPaused()` and `waitingRenderAndLoadAssync`\nso it does not run while data is still loading.", "type": "function()", "examples": [ "onVisibilityChange: function(evt) {\n if (this.getVisibility() && !this.isCalculationPaused() && this.waitingRenderAndLoadAssync == 0) {\n this.generateNewLegend();\n }\n}" ] }, { "key": "getEditingFeatureId", "description": "Feature id currently selected for vertex edit (drawable modify control), if any.", "type": "function() : String|Number|null" }, { "key": "getFeatureId", "description": "Stable-enough id for a feature on this layer: ``fid``, then OpenLayers ``id``,\notherwise the feature's index in ``layer.features`` (no synthetic attributes).\n@param feature {OpenLayers.Feature.Vector} Feature of this layer.", "type": "function(feature) : String|Number|null", "returnDescription": "Its `fid`, `id` or index; null when it is not on the layer." }, { "key": "getInputs", "description": "Returns the current value of every input tool declared in `descriptionHtml`, in declaration order\n(the same array the layer callbacks receive as `inputs`). Use it from callbacks that do not\nreceive `inputs`, such as a `{{button}}` handler or `onFeatureChangeCallback`.", "type": "function() : Array", "examples": [ "var firstInput = this.getInputs()[0];" ], "returnDescription": "The input values in the order the tools are declared." }, { "key": "getLayerDefinedFunctionsByName", "description": "Gets the layer inner function.\n\nDefine the layer inner function at VectorLayer.\nEx: {\n name: 'CSR:map_name',\n function: {\n nameFunctionExample: function(){alert('a');}\n }\n}\n@param name {String} Function name", "type": "function(name) : function|Undefined" }, { "key": "getVector", "description": "Defines the callback function to parse the layer data and get the geometry.\nCallback Function getVector function(attribute, config)\n@param attribute {Object} Object with attributes.\n@param config {Object} Layer config.", "type": "function", "returnDescription": "Return or the lat long point or the vector with the complex geometry." }, { "key": "hoverSelectedStyle", "description": "Defines the style that will be applied to the geometry when the mouse hovers over a selected feature. Default hover selected style is the selected style \nPS: Accepts 'context' and 'rules'.\n Property 'context': allows definition of functions.\n Property 'rules': allows definition of filters (only the geometries that fit into this rule will be displayed).\nPS2: Hover Select depends on both 'onHover' and 'onClick' properties to work.\n\nLook at some examples at: http://dev.openlayers.org/examples/", "type": "Object", "examples": [ "[{color: '${getColor}', context: {getColor: function(attr){return 'green';} }]" ] }, { "key": "hoverStyle", "description": "Defines the style that will be applied to the geometry when mouse is hovering. \nPS: Accepts 'context' and 'rules'.\n Property 'context': allows definition of functions.\n Property 'rules': allows definition of filters (only the geometries that fit into this rule will be displayed).\nPS2: Hover depends on 'onHover' property that allows to hovering.\n\nLook at some examples at: http://dev.openlayers.org/examples/", "type": "Object", "examples": [ "[{color: '${getColor}', context: {getColor: function(attr){return 'green';} }]" ] }, { "key": "llbbox", "description": "Bounds of the features currently on the layer, recomputed automatically after features are\nadded or removed (and extended while drawing). Despite the name it is expressed in the map\nprojection, not in lon/lat, so it can be passed straight to `map.zoomToExtent`. Read-only;\nundefined until the first feature is added.", "type": "OpenLayers.Bounds", "examples": [ "onLoad: function(inputs) {\n if (this.llbbox) {\n app.mapPanel.map.zoomToExtent(this.llbbox);\n }\n}" ] }, { "key": "loadGeojson", "description": "Function to load geojson and draw on the layer.", "type": "function()" }, { "key": "onAdded", "description": "Called when the layer is on the map with its features loaded. If the layer is still\nfetching (`jsonurl` / `geojsonurl` / `csv` / async `load`), waits for that load to\nfinish first so `this.features` / `this.getDataExtent()` are available (a failed load\nstill calls it). `this` is the layer.\n\nAddedEvent {\n element: {DOM} 'DOM element of the layer',\n layer: {OpenLayers.Layer.Vector} 'Javascript Object of the layer',\n map: {Map} 'MapPanel where the layer was added.',\n type: {String} 'Type of the event ( added )'\n}", "type": "function()", "examples": [ "onAdded: function(evt) {\n var bounds = this.getDataExtent();\n if (bounds) ExtjsUtils.JS.getMap().zoomToExtent(bounds);\n}" ] }, { "key": "onBeforeFeatureChangeCallback", "description": "Defines the callback function that is called before a layer feature is added, removed or edited.\nPS: If it returns false, the change operation is canceled.\n@param operationType {String} Receive the operation type: 'add' or 'remove' when adding or removing respectively.\n@param arrFeatures {Array} Array of features affected.", "type": "function", "examples": [ "{\n ...,\n onBeforeFeatureChangeCallback: function(operationType, arrFeatures) {\n \n },\n ...\n}" ] }, { "key": "onClick", "description": "Defines the callback function to the click event on Layer.\n@param event {Object} The click event Object.\n@param source {VectorFileSource} Auxiliary functions to deal with Vector Layer.\n@param inputs {Array.} Array with all layer input values.", "type": "function", "examples": [ "{\n ...,\n onClick: function (feature) {\n console.log(feature.attributes);\n console.log(\"Triggered click event!\");\n },\n ...\n}", "[{\n name:\"CSR:FileGeojson\",\n source: \"file\",\n type: \"geojsonurl\",\n url: \"/theme/app/data/fip_interativo/amazonia/amazonia_municipios.geojson\",\n onClick: function(feature, layerSource, inputs, toggleStatus) {\n console.log(arguments);\n }\n}]" ] }, { "key": "onClickCfg", "description": "Defines the callback function to the Click Select controller.\nThe additional parameters are listed in http://dev.openlayers.org/docs/files/OpenLayers/Control/SelectFeature-js.html.", "type": "function" }, { "key": "onFeatureChangeCallback", "description": "Defines a function that is called after a layer feature is added, removed or edited.\n@param operationType {String} One of: ``'add'`` (features added in bulk, e.g. after\n loading data), ``'add1'`` (a single feature added interactively), ``'remove'``\n (features removed), ``'editend'`` (a drawable-layer sketch/edit was committed),\n ``'editvertex'`` (a vertex was dragged/modified while editing).\n@param arrFeatures {Array} Array of features affected.\n@param detail {Object} Optional context. For ``editend``: ``{ drawMode: 'polygon'|'line' }``.", "type": "function", "examples": [ "{\n ...,\n onFeatureChangeCallback: function (operationType, arrFeatures) {\n \n },\n ...\n}" ] }, { "key": "onHover", "description": "Defines the callback function on 'Vector Layer' hover.\n@param evt {Object} Features.\n@param state {Boolean} True when hover starts, false when it ends.\n@param controller {Object} The controller itself.\n@param inputs {Object} Layer widget values.", "type": "function", "examples": [ "{\n ...,\n onHover: function (evt, state, controller, inputs) {\n console.log(state ? \"Started\": \"Ended\");\n },\n ...\n}", "[{\n name:\"CSR:FileGeojson\",\n source: \"file\",\n type: \"geojsonurl\",\n url: \"/theme/app/data/fip_interativo/amazonia/amazonia_municipios.geojson\",\n onHover: function(feature, state, controller, inputs) {\n console.log(feature.attributes);\n console.log(arguments);\n }\n}]" ] }, { "key": "onInputsReady", "description": "Called when all inputs are ready on layer.", "type": "function" }, { "key": "onLoad", "description": "Defines the callback function to be called after the layer is loaded or added to a map.\nPS: You can use 'this' to access layer properties.\n@param widgetValues {Array} inputs for onLoad callback", "type": "function", "examples": [ "{\n ...,\n onLoad: function (widgetValues) {\n print(this.title) // prints the layer title\n },\n ...\n}" ] }, { "key": "onSelectionToggle", "description": "Defines the callback function to the unselect feature.\n@param event {Object} The click event Object.\n@param source {VectorFileSource} Auxiliary functions to deal with Vector Layer.\n@param inputs {Array.} Array with all layer input values.", "type": "function", "examples": [ "[{\n name:\"CSR:FileGeojson\",\n source: \"file\",\n type: \"geojsonurl\",\n url: \"/theme/app/data/fip_interativo/amazonia/amazonia_municipios.geojson\",\n onSelectionToggle: function(feature, layerSource, inputs, toggleStatus) {\n console.log(feature.attributes);\n alert(toggleStatus);\n }\n}]" ] }, { "key": "popupCallback", "description": "Not implemented for file layers: accepted but never called (see `popupTemplate`). Use\n`onClick`, which receives the clicked feature.\n@param attributes {Array} attributes for popupCallback\n@param inputs {Array} inputs for popupCallback", "type": "function", "examples": [ "{\n ...,\n popupCallback: function (attributes, inputs) {\n \n },\n ...\n}" ] }, { "key": "popupTemplate", "description": "Not implemented for file layers: the value is accepted and kept on the layer, but nothing\nreads it, so no popup ever opens (the template belongs to the gxp feed sources this layer\ndoes not extend). Show a feature's attributes from `onClick` instead - for example with\n`ExtjsUtils.ALERTIFY.log` or `ExtjsUtils.TooltipHelper.CreateTooltipOnPosition`.", "type": "String", "examples": [ "onClick: function (feature) { ExtjsUtils.ALERTIFY.log(\"\" + feature.attributes.name + \"\"); }" ] }, { "key": "resolveOverlap", "description": "Resolve overlaps between edited and existing polygons on this drawable VectorLayer.\nUses ``drawable.onOverlap``: a single key applies immediately; an array prompts\nvia ``ALERTIFY.confirmChoice`` (``merge`` / ``cut`` / ``keep``).\n@param editedGeoms {Array.} Geometries just drawn or edited.\n@param intersectingGeoms {Array.} Existing geometries they overlap.\n@param options {Object} Optional overrides.\n@param options.onOverlap {String|Array.} Override controller ``onOverlap``.\n@param options.message {String} Prompt text.\n@param options.onComplete {function} After the chosen action (or no-op).", "type": "function(editedGeoms, intersectingGeoms, options)", "examples": [ "drawableLayer.resolveOverlap(editedGeoms, intersectingGeoms, {\n onComplete: function() { drawableLayer.callFunction('validateGeometries'); }\n });" ] }, { "key": "selectController", "description": "The selection control created for the layer when `onClick`, `onSelectionToggle` or `onHover` is\ndefined (undefined otherwise). It is the `OpenLayers.Control.CustomSelectFeature` instance, so you can\ncall its `select(feature)`, `unselect(feature)`, `unselectAll()`, `activate()`/`deactivate()` from\nlayer callbacks, e.g. to select a feature found with `findFeatureById`.", "type": "OpenLayers.Control.CustomSelectFeature", "examples": [ "functions: {\n selectFirst: function() {\n if (this.selectController && this.features.length) {\n this.selectController.unselectAll();\n this.selectController.select(this.features[0]);\n }\n }\n}" ], "default": "undefined" }, { "key": "selectStyle", "description": "Defines the default style that will be applied to the selected geometry. \nPS: Accepts 'context' and 'rules'.\n Property 'context': allows definition of functions.\n Property 'rules': allows definition of filters (only the geometries that fit into this rule will be displayed).\nPS2: Selected depends on 'onClick' property that allows to select.\n\nLook at some examples at: http://dev.openlayers.org/examples/", "type": "Object", "examples": [ "[{color: '${getColor}', context: {getColor: function(attr){return 'green';} }]" ] }, { "key": "setDrawing", "description": "Defines drawing features on layers.\nPS: Function is available to the VectorLayer.\n@param enabled {Boolean} True to enable drawing, False otherwise.\n@param callbackOnAdd {function} Callback when a new feature is drew.\n P.S.: You can use 'this' to access layer properties.\n P.S.2: The callback function receives 2 parameters:\n - vectorLayer: Current layer.\n - drawEvent: The info of the added polygon.", "type": "function(enabled, callbackOnAdd)", "examples": [ "this.setDrawing(false, function (vectorLayer, drawEvent) {})" ] }, { "key": "showLoadingModal", "description": "Shows the \"generating legend\" loading mask visibly over the page while the layer is paused (loading\nits data or another resource). By default the mask is an invisible overlay that only changes the\ncursor to \"wait\"; set it to `true` in the layer definition to make it visible. Only shown while the\nlayer is visible. The same key exists for `calculate` layers (`LayersProperties.showLoadingModal`).", "type": "Boolean", "examples": [ "{\n name: 'CSR:my_points',\n source: 'file',\n type: 'geojsonurl',\n url: 'https://maps.csr.ufmg.br/theme/app/data/example.geojson',\n showLoadingModal: true,\n}" ], "default": "false" }, { "key": "styleMap", "description": "Customizes the layer visualization. \nPS: It is an advanced parameter, so it might be easier to use selectedStyle, defaultStyle and hoverStyle.\nPS2: The 'hover' style is applied on hover event.", "type": "Object|OpenLayers.StyleMap", "examples": [ "StyleMap{[default, select, hover, selectedHover]: Style {rules:[Rule,], context: {getRadius: function() {return Math.random()}}}" ] }, { "key": "waitingRenderAndLoadAssync", "description": "Number of asynchronous resources of the layer still loading (its own data for `csv`, `json`, `jsonurl`,\n`geojsonurl` and `load` types, plus `{{loadcsv}}`/`{{loadjson}}` inputs and any `startLoadingLayer`\nyou trigger yourself). It is increased on `startLoadingLayer`/`startLoadingResource` and decreased on\n`endLoadingLayer`/`endLoadingResource`; `onInputsReady` fires when it reaches 0. Read-only: use it as\na guard before refreshing the layer.", "type": "Number", "examples": [ "if (this.waitingRenderAndLoadAssync == 0) { this.generateNewLegend(); }" ], "default": "0" } ], "CustomSelectFeature": [ { "key": "_information", "description": "The select/hover control created for vector layers with onClick/onHover callbacks, reachable as layer.selectController. Extends OpenLayers.Control.SelectFeature.", "name": "File layers: click and hover control" }, { "key": "click", "description": "Select on click. When `true`, clicking a feature selects it (`select`), clicking a\nselected one again unselects it when `toggle` is set, and clicking outside unselects\nall when `clickout` is set. The platform sets it for layers with `onClick` /\n`onSelectionToggle`. When `false`, `select`/`unselect` are no-ops.", "type": "Boolean", "default": "false" }, { "key": "clickFeature", "description": "Internal — feature-handler callback run when a feature is clicked (only registered\nwhen `click` is `true`): toggles the feature off when it was selected and `toggle`\nis set, otherwise unselects the others (unless `multiple`) and selects it. Tenant\ncode normally does not call it; call `select`/`unselect` instead.\n@param feature {OpenLayers.Feature.Vector} The clicked feature.", "type": "function(feature)" }, { "key": "clickoutFeature", "description": "Internal — feature-handler callback run when the user clicks outside a previously\nclicked (selected) feature: unselects everything when the `clickout` option is set.\nTenant code normally does not call it.\n@param feature {OpenLayers.Feature.Vector} The feature that was selected before the click.", "type": "function(feature)" }, { "key": "defaultStyle", "description": "Name of the StyleMap render intent used to draw a feature that is neither hovered\nnor selected (`getFeatureCurrentStyle` returns it in that case).", "type": "String", "default": "\"default\"" }, { "key": "getFeatureCurrentStyle", "description": "Returns the name of the StyleMap render intent a feature should be drawn with\nright now, given whether it is selected (in `layer.selectedFeatures`) and whether\nit is hovered: `selectHoverStyle` when both, `selectedStyle` when only selected,\n`hoverStyle` when only hovered, `defaultStyle` otherwise. Useful when redrawing a\nfeature yourself (`layer.drawFeature(feature, style)`) after changing its attributes.\n@param feature {OpenLayers.Feature.Vector} The feature to inspect.\n@param hovered {Boolean} Whether the mouse is currently over the feature.", "type": "function(feature, hovered) : String", "examples": [ "feature.attributes.value = newValue;\nlayer.drawFeature(feature, layer.selectController.getFeatureCurrentStyle(feature, false));" ], "returnDescription": "The render intent name, e.g. `\"select\"`." }, { "key": "highlight", "description": "Highlights a feature as if the mouse were over it, without selecting it: redraws it\nwith `hoverStyle` (or `selectHoverStyle` when it is selected) and fires the\ncontrol's `beforefeaturehighlighted`/`featurehighlighted` events — which, on a file\nlayer, run the `onHover` callback with state `true`. Use it to mirror a hover coming\nfrom a list or chart outside the map; call `unhighlight` to revert.\n@param feature {OpenLayers.Feature.Vector} The feature to highlight.", "type": "function(feature)", "examples": [ "// highlight a municipality when its row is hovered in a table\nlayer.selectController.highlight(layer.findFeatureById(rowId));" ] }, { "key": "hover", "description": "Highlight on mouse over and unhighlight on mouse out (without selecting). The\nplatform sets it for layers with `onHover`; the `featurehighlighted` /\n`featureunhighlighted` events of the control fire the layer's `onHover` callback.", "type": "Boolean", "default": "false" }, { "key": "hoverStyle", "description": "Name of the StyleMap render intent used to draw a hovered, unselected feature. It\nmatches the `VectorLayer.hoverStyle` entry of the layer's `styleMap`.", "type": "String", "default": "\"hover\"" }, { "key": "multiple", "description": "Allows more than one selected feature at a time: with `false` selecting a feature\nunselects the previous one. Pass it through `onClickCfg: {multiple: true}`.", "type": "Boolean", "default": "false" }, { "key": "outFeature", "description": "Internal — feature-handler callback run when the mouse leaves a feature (only\nregistered when `hover` is `true`): unhighlights it, redrawing with `defaultStyle`\nor, if it is selected, `selectedStyle`; when another select control had highlighted\nthe feature before, that control's highlight is restored instead. Tenant code\nnormally does not call it; call `unhighlight` instead.\n@param feature {OpenLayers.Feature.Vector} The feature the mouse left.", "type": "function(feature)" }, { "key": "overFeature", "description": "Internal — feature-handler callback run when the mouse enters a feature (only\nregistered when `hover` is `true`): highlights it, redrawing with `hoverStyle` or,\nif it is selected, `selectHoverStyle`. Tenant code normally does not call it; call\n`highlight` instead.\n@param feature {OpenLayers.Feature.Vector} The feature under the mouse.", "type": "function(feature)" }, { "key": "select", "description": "Selects a feature programmatically, exactly as a click would: adds it to\n`layer.selectedFeatures`, redraws it with `selectedStyle` (or `selectHoverStyle`\nwhile hovered), fires the layer's `beforefeatureselected`/`featureselected` events\nand calls the `onSelect` option — so a file layer's `onClick`/`onSelectionToggle`\ncallback runs too. Does nothing when the control was created with `click: false`.\nUse it to select a feature from a list or a parent-page message; `unselectAll()`\n(inherited) clears the selection.\n@param feature {OpenLayers.Feature.Vector} The feature to select (must belong to the control's layer).", "type": "function(feature)", "examples": [ "// select the feature whose attribute matches, from a tenant global called by a button\nvar layer = ExtjsUtils.LAYER.getLayerByName(\"CSR:municipios\");\nvar feature = layer.findFeatureById(featureId);\nif (feature) {\n layer.selectController.unselectAll();\n layer.selectController.select(feature);\n}" ] }, { "key": "selectHoverStyle", "description": "Name of the StyleMap render intent used to draw a feature that is selected AND\nhovered. It matches the `VectorLayer.hoverSelectedStyle` entry of the layer's `styleMap`.", "type": "String", "default": "\"selectedHover\"" }, { "key": "selectedStyle", "description": "Name of the StyleMap render intent used to draw a selected feature that is not\nhovered. The platform passes `\"select\"` for file layers (the `VectorLayer.selectStyle`\nentry of the layer's `styleMap`); this is the stock default otherwise.", "type": "String", "default": "\"selected\"" }, { "key": "unhighlight", "description": "Removes the hover highlight of a feature: redraws it with the feature's own `style`\nif it has one, else the layer's `style`, else `defaultStyle` (or `selectedStyle`\nwhen it is selected), and fires the control's `featureunhighlighted` event — which,\non a file layer, runs the `onHover` callback with state `false`. When several\nselect controls highlighted the feature, the previous control's highlight is kept.\n@param feature {OpenLayers.Feature.Vector} The feature to unhighlight.", "type": "function(feature)", "examples": [ "layer.selectController.unhighlight(layer.findFeatureById(rowId));" ] }, { "key": "unselect", "description": "Unselects a feature programmatically: removes it from `layer.selectedFeatures`,\nredraws it with `defaultStyle` (or `hoverStyle` while hovered), fires the layer's\n`featureunselected` event and calls the `onUnselect` option — so a file layer's\n`onSelectionToggle` callback runs with its unselect status. Does nothing when the\ncontrol was created with `click: false`.\n@param feature {OpenLayers.Feature.Vector} The feature to unselect.", "type": "function(feature)", "examples": [ "var selected = layer.selectedFeatures.slice();\nselected.forEach(function(feature) { layer.selectController.unselect(feature); });" ] } ], "CustomModifyFeature": [ { "key": "_information", "description": "The vertex-editing control of drawable vector layers, reachable as layer.drawableController.modifyFeatureControl. Extends OpenLayers.Control.ModifyFeature.", "name": "File layers: vertex editing control" }, { "key": "Drawing", "description": "Pure drawing/status constants and helpers of the modify control (no control instance\nneeded), reachable as `OpenLayers.Control.CustomModifyFeature.Drawing`. What a query\nuses from it is `DRAWING_STATUS`, the enum of the `detail.status` values that\n`drawable.onDrawingStatusChange(detail)` reports: `OFF: \"off\"` (not editing),\n`READY: \"ready\"` (editing active, nothing sketched or selected), `DRAWING: \"drawing\"`\n(a polygon sketch is in progress), `DRAWING_LINE: \"drawing_line\"` (a line sketch is in\nprogress), `FEATURE_SELECTED: \"feature_selected\"` (an existing feature is selected for\nediting) and `VERTEX_DRAG: \"vertex_drag\"` (a vertex of the selected feature is being\ndragged). It also holds `DRAW_MODES` (`POLYGON: \"polygon\"`, `LINE: \"line\"`, the\n`detail.drawMode` values), the default Portuguese `STATUS_LABELS` per status,\n`MIN_POLYGON_SKETCH_POINTS` (4) / `MIN_LINE_SKETCH_POINTS` (2) and\n`minSketchPointsForMode(drawMode)`. Compare against the constants instead of\nhard-coding the strings.", "type": "Object", "examples": [ "drawable: {\n onDrawingStatusChange: function(detail) {\n var S = OpenLayers.Control.CustomModifyFeature.Drawing.DRAWING_STATUS;\n finishButton.setDisabled(!(detail.status === S.DRAWING || detail.status === S.DRAWING_LINE) || !detail.canFinishDrawing);\n applyButton.setDisabled(detail.status !== S.FEATURE_SELECTED);\n }\n}" ] }, { "key": "buildStatusDetail", "description": "Builds the current drawing/edit status of the control on demand — the same `detail`\nobject `drawable.onDrawingStatusChange(detail)` receives, so a host UI can read the\nstate at any moment (e.g. when it is first shown) instead of waiting for the next\nchange. Fields: `status` (one of `CustomModifyFeature.Drawing.DRAWING_STATUS`, never\n`\"off\"` here — the control only exists while editing), `drawMode`, `isDrawing`,\n`featureSelected`, `vertexDrag`, `selectedFeature` (the `OpenLayers.Feature.Vector`\nor `null`), `sketchPointCount`, `canFinishDrawing`, `canDeselectFeature`,\n`canApplyFeatureChanges` and `canCancelDrawing`. Reachable as\n`layer.drawableController.modifyFeatureControl.buildStatusDetail()`.", "type": "function() : Object", "examples": [ "var detail = layer.drawableController.modifyFeatureControl.buildStatusDetail();\nif (detail.canApplyFeatureChanges) {\n layer.drawableController.applyFeatureChanges();\n}" ], "returnDescription": "The status detail object described above." }, { "key": "getActiveDrawMode", "description": "The geometry mode new sketches use on this control: `\"polygon\"` (default) or\n`\"line\"` (only when the layer's `drawable.drawModes` includes it), i.e. one of\n`CustomModifyFeature.Drawing.DRAW_MODES`. Reachable as\n`layer.drawableController.modifyFeatureControl.getActiveDrawMode()`; the same value\narrives as `detail.drawMode` in `onDrawingStatusChange`.", "type": "function() : String", "examples": [ "var control = layer.drawableController.modifyFeatureControl;\nif (control.getActiveDrawMode() === OpenLayers.Control.CustomModifyFeature.Drawing.DRAW_MODES.LINE) {\n console.log(\"next sketch cuts polygons along a line\");\n}" ], "returnDescription": "`\"polygon\"` or `\"line\"`." }, { "key": "getSelectedFeatureId", "description": "Id of the feature currently selected for editing.", "type": "function() : String|Number|null" }, { "key": "isFeatureSelected", "description": "Whether a feature of the layer is currently selected for editing on this control\n(its vertices are shown and draggable). Reachable as\n`layer.drawableController.modifyFeatureControl.isFeatureSelected()`; use\n`getSelectedFeatureId()` to know which one.", "type": "function() : Boolean", "examples": [ "var control = layer.drawableController.modifyFeatureControl;\nif (control.isFeatureSelected()) {\n console.log(\"editing feature \" + control.getSelectedFeatureId());\n}" ], "returnDescription": "`true` while a feature is selected for editing." } ], "XYZLayer": [ { "key": "_information", "completeAPI": "View complete tile layer documentation API here.", "description": "source: \"xyz\": tiles of a tile service, addressed by ${z}, ${x} and ${y} in url.", "name": "Tile layers (xyz)" }, { "key": "name", "description": "Defines a map identifier. This name should be unique.", "type": "String", "examples": [ "[\n ...\n {\n source: \"xyz\",\n name:\"XYZ:map_name\",\n }\n ...\n]" ] }, { "key": "source", "description": "Adds a layer to store the source.\n@param layerCfg {LayerConfig} Layer XYZ configuration.\nLayerConfig {\n url: url,\n name: name,\n isBaseLayer: isBaseLayer,\n sphericalMercator: sphericalMercator\n}", "type": "Object" }, { "key": "url", "description": "Defines the url where the map can be fetched from. \nUse the ${x} ${y} ${z} as placeholder for x, y and z coordinates.", "type": "String", "examples": [ "\"https://tiles.planet.com/basemaps/v1/planet-tiles/planet_medres_visual_2021-09_mosaic/gmap/${z}/${x}/${y}.png?api_key=b24ae87a99624d2cbd8ed6aeb9703280\"" ] } ] }, "Groups": { "_information": { "title": "Groups: what you write in a group", "description": "A group holds layers, or other groups, in its elements. A top-level group with title is an entry of the top menu that lists its layers, each with a switch; a group with viewTitle is a heading in the layer panel. defaultProperties passes layer properties to every layer inside that does not set them itself.\nNot the same as the layer key group, of which only group: \"background\" does something (it makes the layer a basemap).\nTwo groups, each an entry of the top menu:", "example": "[\n {\n title: 'My first Group!',\n color: '#A020F0',\n elements: [\n {\n title: 'Layer 1 of group 1',\n name: 'CSR:batimetria',\n visibility: true,\n },\n ],\n },\n {\n title: 'My second Group!!',\n color: '#FFA900',\n elements: [\n {\n title: 'Layer 1 of group 2',\n name: 'CSR:altimetria',\n visibility: true,\n },\n ],\n },\n]" }, "GroupProperties": [ { "key": "_information", "description": "Keys of a group object, written next to its elements: title or viewTitle, color, openGroup, defaultProperties...", "name": "Group properties" }, { "key": "color", "description": "Defines the Color of the group. This is the Color of the Title and some elements inside the sub menu on the top of the screen.", "type": "String", "examples": [ "[\n {\n title: 'My orange group',\n color: '#FFA500',\n },\n]" ], "default": "string.empty" }, { "key": "customLayerClass", "description": "Extra CSS class added to the node of a `viewTitle` group in the Legend Window, so the group title\nand its rows can be styled with `ExtjsUtils.CSS.defineClass` or a stylesheet. Only groups with a\n`viewTitle` create a node; on a layer the same key styles the layer row instead\n(`ConfigLayer.customLayerClass`).", "type": "String", "examples": [ "[\n {\n viewTitle: 'Styled group',\n viewColor: '#FFA500',\n title: 'Group 1',\n color: '#666699',\n customLayerClass: 'highlighted-group',\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:estados',\n source: 'local',\n startListed: true,\n },\n ],\n },\n]" ], "default": "string.empty" }, { "key": "defaultProperties", "description": "Specifies properties that apply universally to all layers within a group, including nested subgroups and their respective layers.\nPriority is determined by specificity: a property defined at the layer level takes precedence, followed by properties defined in the nearest group, and so forth.", "type": "Object", "examples": [ "[\n {\n title: 'Example of defaultProperties',\n color: '#FFA500',\n defaultProperties: {\n source: 'local',\n visibility: true,\n opacity: 0.7,\n },\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:geologia',\n },\n {\n title: 'Layer 2',\n name: 'CSR:rios_principais',\n },\n {\n title: 'Layer 3',\n name: 'CSR:estados',\n // Any internal redefinition will override the defaultProperties\n visibility: false,\n },\n ],\n },\n]" ], "default": "{}" }, { "key": "elements", "description": "Defines the Layers that will be part of the Group. Each Layer can have multiple maps inside it.\nAll maps inside a Layer will be shown together when that Layer is enabled.\nBesides that, all information about those maps can be used to calculate a new one using custom functions that can be writen in JavaScript.", "type": "Array.", "examples": [ "[\n {\n title: 'A group with Layers!',\n color: '#FFA500',\n elements: [\n // Define your Layers here\n ],\n },\n]" ], "default": "Array.empty", "see": [ "To learn more about Layers and it’s properties, check their documentation at: [Layer Section](#group_Layers)." ] }, { "key": "global", "description": "A second way to declare query globals: an object whose properties become temporary\nglobals, passed to `ExtjsUtils.QUERY.setQueryGlobalProperties` while the group is\ninterpreted (before its layers). The usual form is the\n`ExtjsUtils.QUERY.setQueryGlobalProperties({...}) && [...]` chain at the top of the\nquery; the production survey found no query using this key (zero users).", "type": "Object", "examples": [ "[\n {\n title: 'Group with its own globals',\n global: {\n formatArea: function(value) { return ExtjsUtils.NUMBER.abbreviateNumber(value) + ' ha'; }\n },\n elements: [\n { title: 'Layer 1', name: 'CSR:estados', source: 'local', visibility: true }\n ]\n }\n]" ] }, { "key": "openGroup", "description": "Defines if the 'viewTitle' should start opening or collapse.\nSet it to 'true' for the 'viewTitle' start open or 'false' for it to start closed.\nThis property only applies to a group that has the 'viewTitle' property defined.\nIf the Group View has any visible Layers or any Layer has the 'openGroup' property set to 'true', the Group View will start open.\nIt works at both levels: on the `viewTitle` group it makes the group start expanded, on a layer it\nexpands every `viewTitle` ancestor of that layer.", "type": "Boolean", "examples": [ "[\n {\n viewTitle: 'This Group View will start opened',\n viewColor: '#FFFFFF',\n title: 'Group 1',\n color: '#666699',\n openGroup: true,\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:estados',\n source: 'calculate',\n startListed: true,\n },\n ],\n },\n {\n viewTitle: 'This Group View will start closed',\n viewColor: '#FFFFFF',\n title: 'Group 2',\n color: '#666699',\n elements: [\n {\n title: 'Layer 2',\n name: 'CSR:rios_principais',\n source: 'calculate',\n startListed: true,\n },\n ],\n },\n]" ], "default": "false" }, { "key": "title", "description": "Defines the Title of the group. The Title is shown at the sub menu on the top of the screen.", "type": "String", "examples": [ "[\n {\n title: 'My new group!',\n },\n]" ], "default": "string.empty" }, { "key": "viewTitle", "description": "Define the Title of the View that will gather together the elements inside it (Groups or other Views).\nIf an external View has in its elements another definition of a 'viewTitle', subviews will be created, like in the second example.", "type": "String", "examples": [ "// Exemple 1: View with a Layers inside it\n[\n {\n viewTitle: 'This View has a Group 3 Layers',\n title: 'This is a Group with 3 Layers',\n color: '#5BA300',\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:estados',\n source: 'local',\n opacity: 0.5,\n visibility: true,\n },\n {\n title: 'Layer 2',\n name: 'CSR:rios_principais',\n source: 'local',\n opacity: 0.5,\n visibility: true,\n },\n {\n title: 'Layer 3',\n name: 'CSR:geologia',\n source: 'local',\n opacity: 0.65,\n visibility: true,\n },\n ],\n },\n]", "// Exemple 2: View with others 'viewTitle' defined inside it\n[\n {\n // This is the definition of the View\n viewTitle: 'This External View has 2 others Inner Views inside it, each with 1 Group that has 1 Layer',\n title: 'This View has 2 Groups, each with 1 Layer',\n color: '#0073E6',\n elements: [\n {\n title: 'Group 1',\n // This 'viewTitle' will create a division in the menu that shows when the mouse hovers the navigation bar option 'This View has 2 Groups, each with 1 Layer' \n viewTitle: 'Inner View with Group 1',\n color: '#E6308A',\n elements: [\n {\n title: 'Group 1 - Layer 1',\n name: 'CSR:altimetria',\n source: 'local',\n visibility: true,\n },\n ],\n },\n {\n title: 'Group 2',\n // This 'viewTitle' will create a division in the menu that shows when the mouse hovers the navigation bar option 'This View has 2 Groups, each with 1 Layer'\n viewTitle: 'Inner View with Group 2',\n color: '#B51963',\n elements: [\n {\n title: 'Group 2 - Layer 1',\n name: 'CSR:batimetria',\n source: 'local',\n visibility: true,\n },\n ],\n },\n ],\n },\n]" ], "default": "string.empty" } ], "GroupFunctions": [ { "key": "_information", "description": "Functions a viewTitle group can carry; the platform calls them when its heading in the layer panel is clicked or toggled. Inside them this is the heading's node.", "name": "Group callbacks (viewTitle groups)" }, { "key": "onClickViewGroup", "description": "Called whenever the user clicks the title of a `viewTitle` group in the Legend Window. It belongs on\na group that has `viewTitle`: the handler is bound to that group's tree node, so `this` is the node\nand `view.expanded` tells whether the group is open after the click. When declared on a layer\ninstead of a group, it is attached to the layer's nearest `viewTitle` ancestor (once per layer\nthat declares it); on a flat layer with no `viewTitle` ancestor it is bound to the invisible\nroot node, i.e. it never fires.\n@param view {Ext.tree.TreeNode} The tree node of the group that was clicked (`view.expanded`, `view.text`, `view.childNodes`).\n@param clickEvent {Ext.EventObject} The click event, with details such as the mouse position.", "type": "function", "examples": [ "[\n {\n viewTitle: 'Example View (Click me!)',\n viewColor: '#FFA500',\n title: 'Click the view to change its state',\n color: '#666699',\n openGroup: true,\n onClickViewGroup: function handleClickViewGroup(view, clickEvent) {\n let viewState = (view.expanded ? 'open' : 'closed');\n ExtjsUtils.ALERTIFY.log('The ' + view.text + ' is ' + viewState );\n },\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:estados',\n source: 'local',\n startListed: true,\n },\n ],\n },\n]" ], "default": "null" }, { "key": "onToggleViewGroup", "description": "Called whenever a `viewTitle` group of the Legend Window is expanded or collapsed (by the user or by\ncode). It belongs on a group that has `viewTitle`: the handler is bound to that group's tree node,\nso `this` is the node and `view.expanded` is `true` after an expand and `false` after a collapse.\nWhen declared on a layer instead of a group, it is attached to the layer's nearest `viewTitle`\nancestor (once per layer that declares it); on a flat layer with no `viewTitle` ancestor it is\nbound to the invisible root node, i.e. it never fires. A typical use is hiding the layers of the\ncollapsed group and restoring them on expand.\n@param view {Ext.tree.TreeNode} The tree node of the group whose state changed (`view.expanded`, `view.text`, `view.childNodes`).", "type": "function", "examples": [ "[\n {\n viewTitle: 'Example View (Click me!)',\n viewColor: '#FFA500',\n title: 'Click the view to change its state',\n color: '#666699',\n openGroup: true,\n onToggleViewGroup: function handleToggleViewGroup(view) {\n let viewState = (view.expanded ? 'open' : 'closed');\n ExtjsUtils.ALERTIFY.log('The ' + view.text + ' is ' + viewState );\n },\n elements: [\n {\n title: 'Layer 1',\n name: 'CSR:estados',\n source: 'local',\n startListed: true,\n },\n ],\n },\n]" ], "default": "null" } ] }, "Tools": { "_information": { "title": "Panel widgets", "description": "Controls written inside the descriptionHtml of a calculated, file or tile layer, as {{tag|param=value|param2=value}}: sliders, lists, buttons, windows. A widget with an id becomes an input of the layer's functions. Not the toolbar buttons of a map link (tools=, under Map links and embedding).\nThe markup rules shared by every widget come first; each widget also has a page with a live example under the Tools tab.\nExamples:", "example": "{\n ...,\n descriptionHtml: '{{toolIdentifier|paramName=paramValue}}',\n ...\n}\n\n{\n ...,\n descriptionHtml: '{{button|id=btn_id|enableToggle=false}}' + '{{opacityslider}}',\n ...\n}" }, "MarkupSyntax": [ { "key": "_information", "description": "Rules shared by every tool written inside descriptionHtml as {{tool|param=value|param2=value2}}: how parameters are parsed, the values they accept and the special parameters (getid, function, on_<event>, isnumeric, cls, key=false, nested a=b=c, escaped \\= ) available to all tools.\nFunction-valued parameters (handler, runOnClick, runOnHover, onSelect, ...) are resolved in this order: a key of the layer 'functions' object, then a global with that name (setQueryGlobalProperties), then the text itself evaluated as a function (a body, or a full 'function(){...}' expression).", "name": "Markup rules for every widget" }, { "key": "cls", "description": "`cls=` adds CSS classes to the created element. Unlike other keys, repeating it concatenates the\nvalues (with no separator — start the second one with a space, or list all classes in a single `cls`).", "type": "String", "examples": [ "{{label|cls=slider_label bold|text=0%}}" ] }, { "key": "defaultParsing", "description": "How a plain `param=value` is converted before reaching the tool: a value that looks like a number\n(`10`, `-4.5`, `1e3`) becomes a JavaScript number, an empty value (`param=`) becomes the empty string\n(falsy), and anything else stays a string — tools that need arrays or objects (`data`, `steps`, `values`,\n`filterLayers`, `backgroundColors`) parse the string themselves as JSON. `true`/`false` are NOT converted:\n`param=true` is the string `\"true\"` (truthy) and `param=false` is rewritten to an empty value (see\n`falseValue`). A parameter written without `=` (`|pressed|`) also gets the empty string, except for the\nspecial keys listed in this group (`isnumeric`). The same parameter written twice keeps the last value\n(`cls` and `on_` accumulate instead).", "type": "String|Number", "examples": [ "{{slider|id=s|minValue=0|maxValue=100|value=20|fieldLabel=Deforestation}}" ] }, { "key": "escapedEquals", "description": "Write `\\=` to put a literal `=` inside a value; a bare `=` would start a nested key (see `nestedKeys`).\nNeeded above all in URLs with query strings. Inside a JavaScript string remember to double the backslash\n(`'\\\\='`). The value of `html=` is exempt: everything after its first `=` is kept as is.", "type": "String", "examples": [ "{{loadcsv|id=csv|url=/wmtp/calc/areacategorical/?layers\\=CSR:estados&styles\\=1}}" ] }, { "key": "falseValue", "description": "`param=false` is rewritten to `param=` (an empty, falsy value) before parsing, because the literal text\n`\"false\"` would otherwise be a truthy string. Use it to switch off a boolean parameter whose default is\ntrue (`unselect=false`, `notify=false`, `hideLabel=false`). Only a `false` at the very end of the parameter\nis rewritten.", "type": "Boolean", "examples": [ "{{pickpoint|id=pick|unselect=false|notify=false}}" ] }, { "key": "function", "description": "`function=` stores a function whose body is the given text (`function () { }`), evaluated\nwith no `try/catch` and no lookup in the layer `functions`. Use the nested form `param=function=`\nto assign it to a parameter (a top-level `function=` only sets a `function` key); escape any `=` in the\nbody as `\\=`. Rarely needed: the callback parameters of the tools (`handler`, `runOnClick`, `onSelect`...)\nalready accept function names or inline text.", "type": "function", "examples": [ "{{button|id=b|text=Log|handler=function=console.log('clicked')}}" ] }, { "key": "getid", "description": "`getid=ID` gives access to an element created EARLIER in the same description (by any tag with that\n`id`). At the top level (`|getid=slider1|`) the element is stored in the tool config under `getid`;\nthe common use is to attach a listener to it with `getid=ID|getid=on_=...` (see `on_event`), or the\nnested `param=getid=ID` to hand the element to a parameter (`scope=getid=btn`). Order matters: the\nreferenced tag must appear before the one using `getid`.", "type": "Object", "examples": [ "{{slider|id=perc_slider|value=20}}{{label|id=perc_label|text=20%|getid=perc_slider|getid=on_change=Ext.getCmp('perc_label').setText(this.getValue() + '%')}}" ] }, { "key": "html", "description": "`html=` is the one key whose value is taken verbatim up to the next `|`: `=` characters inside it are kept\nand no nesting happens. Used by `label` and `window`.", "type": "String", "examples": [ "{{label|html=open}}" ] }, { "key": "isnumeric", "description": "`|isnumeric|` (or `isnumeric=true`) installs a validator that only accepts numeric text — the field is\nmarked invalid with the localized \"must be a number\" message otherwise. Meant for `textfield`. Note that\nthe input value is still delivered as a string; convert it with `parseFloat`.", "type": "Boolean", "examples": [ "{{textfield|id=soy_value|value=43|isnumeric|fieldLabel=Value (US$/Ton)}}" ] }, { "key": "nestedKeys", "description": "`a=b=c` creates a nested object: the tool receives `{a: {b: c}}`. The innermost `key=value` is parsed with\nthe same rules as a top-level one, so the special keys work at any depth — `plugins=tip=...` builds a\nslider tip plugin, `scope=getid=ID` assigns an element created earlier, `listeners=on_change=...` is not\nneeded because `getid`/`on_` already cover the common case.", "type": "Object", "examples": [ "{{slider|id=s|plugins=tip={0}% of the area}}" ] }, { "key": "on_event", "description": "`on_=` adds a listener for an Ext event (`change`, `select`, `afteredit`, `toggle`...) on an\nelement referenced with `getid` — the form is `getid=ID|getid=on_=`; it cannot be used on the\ntag's own element. `` is either a full `function(...) {...}` or a statement body; it is evaluated\ndirectly (no lookup in the layer `functions` or in globals) and runs with `this` = the referenced\nelement and the event's own arguments. Several `on_` listeners may be attached to the same element.", "type": "function", "examples": [ "{{textfield|id=price|isnumeric}}{{label|id=price_lbl|getid=price|getid=on_afteredit=Ext.getCmp('price_lbl').setText('US$ ' + this.getRawValue())}}" ] }, { "key": "tip", "description": "`tip=` builds an `Ext.slider.Tip` whose text is `String.format(format, thumbValue, value of thumb 0,\nvalue of thumb 1...)`, so `{0}` is the dragged thumb value. It must be assigned to a slider's `plugins`\nwith the nested form `plugins=tip=`; a top-level `tip=` is stored in the config but not used by the\nslider.", "type": "Object", "examples": [ "{{slider|id=perc_slider|plugins=tip={0}% of the area|increment=5}}" ] } ], "HTML": [ { "key": "_information", "completeAPI": "", "description": "Any HTML is possible to be added to the layer description.", "name": "Free HTML" }, { "key": "content", "description": "Free HTML inside a layer's `descriptionHtml`: everything that is not a `{{tag}}` is\npassed through to the panel untouched, so a description can carry headings, images,\nlinks, tables and the container elements a chart or a custom control needs. Widgets and\nHTML mix freely in the same string, and the HTML around a widget is rendered before the\nwidget is created, so an element declared here can already be referenced by an `id`.\n\nTwo things to keep in mind. Inside a `{{tag|...}}` the pipe separates parameters, so HTML\nthat must live in a parameter goes in `html=` (verbatim to the end of the value) or has\nits `=` escaped as `\\\\=`. And the description is written inside a JavaScript string in the\nquery, so quotes have to be escaped or alternated as usual.", "type": "String", "examples": [ "descriptionHtml:\n '

Deforestation

' +\n '

Pick the minimum area to highlight.

' +\n '{{slider|id=threshold|minValue=0|maxValue=100|value=20}}' +\n '
'" ] } ], "AreaIntegral": [ { "key": "_information", "completeAPI": "View the complete AreaIntegral API here.", "description": "Two clicks on the map define a rectangle; the tool sums the map values inside it using summed-area (integral) maps, so it only works with maps published with the 'integral' operation.\nCallback parameters (layersValues {Array[Number]}, inputs {Array}, boundingBox {Array[Number]} in EPSG:4326, pixel {x,y}, lastInfo {first, second})\nUsage: {{areaintegral|runOnClick=onAreaSummed}}", "name": "areaintegral · sum inside a rectangle (input)" }, { "key": "getLayerValues", "description": "Reads the composed map at one screen position: one value per inner layer (decoded from the tile\ncolours through the legend, null cells read as 0) plus one extra entry with the layer `expression`\nresult for those values. The tool samples the four corners of the rectangle with it and combines\nthem as a summed-area table (`sum = minXY + maxXY - minXmaxY - maxXminY`), which is why the maps\nmust be published with the `integral` operation. Returns `null` when the layer is hidden or the\nposition is outside the map data.\n@param mousePoint {Object} Absolute screen position `{x, y}` to sample.\n@param layer {OpenLayers.Layer.Composed} The composed layer to read (normally the tool's own layer).", "type": "function(mousePoint, layer) : Array.|null", "returnDescription": "`[value of layer 0, ..., value of layer n-1, expression result]`, or `null`." }, { "key": "iconCls", "description": "Defines the CSS class of the toggle switch icon; replace the default to restyle the switch.", "type": "String", "examples": [ "|iconCls=my-toggle-icon|" ], "default": "cmn-toggle-icon" }, { "key": "id", "description": "Defines the id of the tool: the key used in `inputs.id[ID]` and the id of the container component\n(`Ext.getCmp(id)`; the switch itself is `Ext.getCmp(id).items.get(0)`). Generated when omitted.", "type": "String", "examples": [ "|id=integral_tool|" ] }, { "key": "labelBefore", "description": "Set true to render the `text` label before (left of) the toggle switch instead of after it.", "type": "Boolean", "examples": [ "|labelBefore=true|" ], "default": "false" }, { "key": "notify", "description": "Set false to suppress the notification shown when the tool is activated.", "type": "Boolean", "examples": [ "|notify=false|" ], "default": "true" }, { "key": "runOnClick", "description": "Defines the callback run after the second click closes the rectangle, with the sums computed. Called\nas `runOnClick(layersValues, inputs, boundingBox, pixel, lastInfo)` with `this` = the layer:\n`layersValues` has one summed value per inner layer (see `getLayerValues`), `inputs` is\n`layer.getInputs()`, `boundingBox` is `[minLon, minLat, maxLon, maxLat]` in EPSG:4326, `pixel` the\n`{x, y}` of the second click and `lastInfo` the `{first, second}` `{lon, lat}` of the two clicks.\nThe name is resolved as a key of the layer `functions` object, then as a global function, then as\ninline function text. The tool deactivates itself after the callback.", "type": "function", "examples": [ "|runOnClick=onAreaSummed|", "functions: {\n onAreaSummed: function(layersValues, inputs, boundingBox, pixel, lastInfo) {\n ExtjsUtils.ALERTIFY.log('Sum inside ' + boundingBox.join(', ') + ': ' + layersValues[0]);\n }\n}" ] }, { "key": "text", "description": "Defines the text shown next to the toggle switch.", "type": "String", "examples": [ "|text=Sum a rectangle|" ] }, { "key": "unselect", "description": "Only changes the activation message (`true`: one selection expected, `false`: several); the tool\nalways deactivates itself after the second click.", "type": "Boolean", "examples": [ "|unselect=false|" ], "default": "true" }, { "key": "value", "description": "Value stored in `inputs.id[ID]`: the `layersValues` array of the tool — one summed value per inner\nlayer of the composed map for the last rectangle (empty before the first one). The array is updated in\nplace after the second click, so `beforeCalc`/`expression` always read the latest sums. The input is\nregistered on the `forceupdatelayer` event of the switch, which the tool does not fire by itself:\nreact inside `runOnClick`, or call `Ext.getCmp(id).items.get(0).forceUpdateLayer()` there to\nrecalculate the layer with the new sums.", "type": "Array.", "examples": [ "{{areaintegral|id=integral_tool|runOnClick=onAreaSummed}}", "functions: {\n onAreaSummed: function(layersValues, inputs) {\n Ext.getCmp('integral_tool').items.get(0).forceUpdateLayer(); // beforeCalc will see inputs.id['integral_tool']\n }\n}" ] } ], "Button": [ { "key": "_information", "completeAPI": "This button is created from Button.Configs.\nOnly some properties are listed in API here.", "description": "Create a simple button to user interact with the map.", "name": "button · push or toggle button" }, { "key": "enableToggle", "description": "Defines the button type as toggle.\nSet true to use as toggle, false otherwise.\nPS: When its true the callback is 'toggleHandler', otherwise the callback is 'handler'.", "type": "Boolean", "examples": [ "|enableToggle=true|" ], "default": "false" }, { "key": "fieldLabel", "description": "Defines the button label.", "type": "String", "examples": [ "|fieldLabel=A button|" ] }, { "key": "handler", "description": "Defines the callback function on button click event. This should be used\nwhen the enableToggle property is false. `this` inside the callback is the layer.\n\nThe value is resolved in this order: (1) a key of the layer `functions` object with that name;\n(2) a global function with that name (e.g. defined with `setQueryGlobalProperties`); (3) otherwise the\ntext itself is evaluated as a function — either a full `function(){...}` expression or a plain\nstatement body. With `enableToggle=true` and no `toggleHandler`, `handler` is used as the toggle handler.\n@param button {Ext.Button} The button element that was clicked.\n@param clickEvent {EventObject} An event object carrying information about the click event.", "type": "function", "examples": [ "|handler=onExportClick|", "|handler = function (button, clickEvent){\n console.log(button, clickEvent);\n}|" ], "default": "undefined" }, { "key": "hidden", "description": "Set true to create the button hidden (Ext `hidden` config); show it later with `Ext.getCmp(id).show()`.\nThis is one example of the pass-through: every other `Ext.Button` config (`iconCls`, `tooltip`, `cls`,\n`width`, `disabled`, `scale`...) written in the markup is handed to the button unchanged.", "type": "Boolean", "examples": [ "|hidden=true|" ], "default": "false" }, { "key": "id", "description": "Defines the id to identify the object.", "type": "String", "examples": [ "|id=exemple_button|" ] }, { "key": "pressed", "description": "Defines the button initial state. \nSet it true to start pressed (only if enableToggle = true), false otherwise.", "type": "Boolean", "examples": [ "|pressed=true|" ], "default": "false" }, { "key": "text", "description": "Defines the button text.", "type": "String", "examples": [ "|text=Click On Me|" ] }, { "key": "toggle", "description": "Alias of `toggleHandler`: a function given as `toggle=` is moved to `toggleHandler` (unless one is\nalready defined), so the Ext `toggle()` method of the button is never overwritten. Prefer\n`toggleHandler`.", "type": "function", "examples": [ "|enableToggle=true|toggle=onToggleDetails|" ] }, { "key": "toggleHandler", "description": "Defines the callback function on button toggle event. This should be used\nwhen the enableToggle property is true. `this` inside the callback is the layer.\n\nThe value is resolved in this order: (1) a key of the layer `functions` object with that name;\n(2) a global function with that name (e.g. defined with `setQueryGlobalProperties`); (3) otherwise the\ntext itself is evaluated as a function — either a full `function(){...}` expression or a plain\nstatement body.\n@param button {Ext.Button} The button element that was clicked.\n@param state {Boolean} The next state of the button, true means pressed.", "type": "function", "examples": [ "|enableToggle=true|toggleHandler=onToggleDetails|", "|toggleHandler = function (button, pressed){\n console.log(button, pressed);\n}|" ], "default": "undefined" } ], "Checkbox": [ { "key": "_information", "completeAPI": "This tool is created from Ext.form.Checkbox.\nOnly customized properties are listed here.", "description": "A checkbox that calls a function of the layer when toggled. It is not registered as an input: read its state inside the handler.\nUsage: {{checkbox|text=Show details|handler=onToggleDetails}}", "name": "checkbox · on/off, calls a function" }, { "key": "checked", "description": "Set true to start checked. `handler` is not run for the initial state.", "type": "Boolean", "examples": [ "|checked=true|" ], "default": "false" }, { "key": "fieldLabel", "description": "Defines a label at the left of the whole field (Ext `fieldLabel`), in addition to the `text` shown\nnext to the switch. `hideLabel=true` removes it and its reserved space.", "type": "String", "examples": [ "|fieldLabel=Options|" ] }, { "key": "forceUpdateLayer", "description": "Fires the `forceupdatelayer` event of the widget. For the map-interaction tools registered as inputs\n(summedarea, areaintegral) this is the event the layer listens to, so calling it marks the input as\nchanged and recalculates the layer with the values currently stored in `inputs.id[ID]`.", "type": "function()", "examples": [ "Ext.getCmp('sum_tool').items.get(0).forceUpdateLayer();" ] }, { "key": "handler", "description": "Defines the callback run whenever the checkbox is checked or unchecked (by the user or by `toggle()`).\nCalled as `handler(checkbox, checked)` with `this` = the layer. The value is resolved in this order:\na key of the layer `functions` object, then a global function with that name, then the text itself\nevaluated as a function (a full `function(){...}` or a statement body). The checkbox is not a layer\ninput: read `checked` here and act (e.g. `setValues` on an InputManager, `changeLayers`...). It is\nalso called once with `checked=false` when the widget is removed together with its layer.", "type": "function", "examples": [ "|handler=onToggleDetails|", "functions: {\n onToggleDetails: function(checkbox, checked) {\n this.getInputs().id['state'].setValues({details: checked});\n }\n}" ] }, { "key": "iconCls", "description": "Defines the CSS class of the toggle switch icon; replace the default to restyle the switch.", "type": "String", "examples": [ "|iconCls=my-toggle-icon|" ], "default": "cmn-toggle-icon" }, { "key": "id", "description": "Defines the id of the checkbox component (`Ext.getCmp(id)`), e.g. to call `toggle()` or `setBoxLabel()`\nfrom a button. Generated when omitted.", "type": "String", "examples": [ "|id=show_details|" ] }, { "key": "inputValue", "description": "Defines the DOM `value` attribute of the underlying `` (useful inside an HTML form).", "type": "String", "examples": [ "|inputValue=details|" ] }, { "key": "labelBefore", "description": "Set true to render the `text` before (left of) the toggle switch instead of after it.", "type": "Boolean", "examples": [ "|labelBefore=true|" ], "default": "false" }, { "key": "notify", "description": "Accepted for parity with the map-picking switches (pickpoint, hoverpixel...), where it controls the\nactivation notification. A plain checkbox shows no notification, so the value has no effect here.", "type": "Boolean", "default": "true" }, { "key": "setBoxLabel", "description": "Changes the text shown next to the checkbox (the markup `text` parameter) after it was rendered.\nAvailable on every checkbox-style tool (checkbox, pickpoint, hoverpixel, summedarea, areaintegral);\nget the component with `Ext.getCmp(id)`.\n@param boxLabel {String} New label text (HTML allowed).", "type": "function(boxLabel)", "examples": [ "Ext.getCmp('my_checkbox').setBoxLabel('Show details (3)');" ] }, { "key": "text", "description": "Defines the text shown next to the toggle switch (the checkbox `boxLabel`).", "type": "String", "examples": [ "|text=Show details|" ] }, { "key": "toggle", "description": "Checks or unchecks the checkbox from code, running its `handler` as if the user had clicked it.\nWithout an argument the current state is inverted. Get the component with `Ext.getCmp(id)`.\n@param forceState {Boolean} `true` to check, `false` to uncheck; omit to invert the current state.", "type": "function(forceState)", "examples": [ "Ext.getCmp('show_details').toggle(false); // uncheck" ] }, { "key": "unselect", "description": "Accepted for parity with the map-picking switches, where it selects the activation message. A plain\ncheckbox never unchecks itself, so the value has no effect here.", "type": "Boolean", "default": "true" } ], "Combobox": [ { "key": "_information", "completeAPI": "This button is created from Ext.form.ComboBox for customized properties click on API here.", "description": "It creates an input of ComboBox tool where the value is selectable from a list.\nUsage: '{{combobox}}' or examples.", "name": "combobox · pick from a list (input)" }, { "key": "data", "description": "Defines the data that will be displayed in the Combobox.", "type": "Array.>", "examples": [ "|data = [[\"Val_1\"], [\"Val_2\"],..]|" ], "default": "undefined" }, { "key": "editable", "description": "Determines if the Combobox is editable. That is, if it allows the user to type inside the input field.\nSet it true to allow it, false otherwise.", "type": "Boolean", "examples": [ "|editable=true|" ], "default": "false" }, { "key": "fieldLabel", "description": "Defines a label for the Combobox.\nIt will be shown at the left of the Combobox, by default.", "type": "String", "examples": [ "|fieldLabel=This is the field label|" ] }, { "key": "getValue", "description": "Returns the currently selected value (the text of the chosen `data` entry). Call it on the component\n(`Ext.getCmp(id)` or a `getid=` reference); `inputs.id[ID]` already holds the same value.", "type": "function() : String", "examples": [ "var region = Ext.getCmp('region_combo').getValue();" ], "returnDescription": "The selected value." }, { "key": "hideLabel", "description": "Defines if the label of the Combobox should be displayed.\nSet true to hide the label, false to show it.", "type": "Boolean", "examples": [ "|hideLabel=true|" ], "default": "false" }, { "key": "id", "description": "Defines the id to identify the object.", "type": "String", "examples": [ "|id=legend_combobox|" ] }, { "key": "labelStyle", "description": "Defines the style of the label.\nYou can use CSS to style the label element.", "type": "String", "examples": [ "|labelStyle=font-weight: bold; color: red;|" ] }, { "key": "onSelect", "description": "Defines a callback run when the user picks an entry. It receives the Ext `select` event arguments\n`(combo, record, index)` — read the chosen text with `record.get('value')` — and `this` is the layer.\nThe value is resolved as a key of the layer `functions` object or, failing that, the text itself is\nevaluated as a function (a body or a full `function(){...}`); unlike the other callbacks it does NOT\nlook for a global (setQueryGlobalProperties) function of that name.\nPS: the layer is recalculated on `select` anyway; use `onSelect` for side effects such as changing\nlayers or updating a window.", "type": "function", "examples": [ "|onSelect=onRegionSelected|", "functions: {\n onRegionSelected: function(combo, record, index) {\n this.changeLayers({name: 'CSR:' + record.get('value'), index: 0});\n }\n}" ] }, { "key": "setValue", "description": "Selects an entry from code. Pass one of the `data` values; it does not fire `select`, so call\n`forceRecalc()` on an InputManager (or fire the event) when the layer must be recalculated.\n@param value {String} One of the values listed in `data`.", "type": "function(value)", "examples": [ "Ext.getCmp('region_combo').setValue('Protected Areas');" ] }, { "key": "value", "description": "Value stored in `inputs.id[ID]` (and `inputs[i]`): the selected entry of `data` as a string (the first\nentry is selected initially). The layer recalculates on the combobox `select` event (user choice).", "type": "String", "examples": [ "{{combobox|id=region_combo|fieldLabel=Region|data=[['Municipalities'],['Protected Areas']]}}", "beforeCalc: function(inputs) {\n var region = inputs.id['region_combo']; // 'Municipalities' or 'Protected Areas'\n}" ] }, { "key": "width", "description": "Defines the width of the combobox in pixels.", "type": "Number", "examples": [ "|width=250|" ], "default": "190" } ], "FileField": [ { "key": "_information", "completeAPI": "View all FileField documentation API here.", "description": "Tool that allows handle and local files.\nPS: This object cannot be sent to 'expression'.\nUsage: {{filefield|fieldLabel=loadshp|id=loadshp|_onChange=function(){alert('changed')}}}", "name": "filefield · open a local file (input)" }, { "key": "eventNames", "description": "Defines the list of events by name.\nUse this property to define callback functions to any of the following events.", "type": "Array.", "examples": [ "['added', 'afterrender', 'beforedestroy', 'beforehide', 'beforerender', 'beforeshow', 'beforestaterestore',\n'beforestatesave', 'blur', 'change', 'destroy', 'disable', 'enable', 'focus', 'hide', 'invalid', 'move', 'removed', 'render',\n'resize', 'show', 'specialkey', 'staterestore', 'statesave', 'valid']" ] }, { "key": "fieldLabel", "description": "Defines the label shown at the left of the file input (Ext `fieldLabel`). `hideLabel=true` removes the\nlabel and its reserved space; other `Ext.form.Field` configs are passed through unchanged.", "type": "String", "examples": [ "|fieldLabel=Load a shapefile (.zip)|" ] }, { "key": "hideLabel", "description": "Set true to hide the label element and the space reserved for it.", "type": "Boolean", "examples": [ "|hideLabel=true|" ], "default": "false" }, { "key": "id", "description": "Defines the id of the input; it is the key used in `inputs.id[ID]` and the id of the Ext field\n(`Ext.getCmp(id)`), so it must be unique in the page.", "type": "String", "examples": [ "|id=loadshp|" ] }, { "key": "ignoreUpdate", "description": "Defines if it should ignore the widget change event.\nIf it's false, it dispatches the update event at every file selection.", "type": "Boolean", "default": "false" }, { "key": "inputType", "description": "The HTML input type. It is always forced to `file` by the tool, so a value written in the markup is\nignored (documented only to explain why it cannot be changed).", "type": "String", "default": "file" }, { "key": "value", "description": "Value stored in `inputs.id[ID]`: not the file itself but a getter function. Call it —\n`inputs.id[ID]()` — to obtain the selected `File` (the first entry of the DOM `files` list) or `undefined`\nwhen nothing is selected. It is a function so the value can never be serialized to the calculation\nWebWorker (`expression`); read it in `beforeCalc`, in a `_onchange=` callback or in a button handler.\nThe layer recalculates on the `change` event of the input (a new file chosen) unless\n`ignoreUpdate=true`.", "type": "function", "examples": [ "{{filefield|fieldLabel=loadshp|id=loadshp|_onChange=onSelectFile}}", "functions: {\n onSelectFile: function() {\n var file = this.getInputs().id['loadshp']();\n if (file) ExtjsUtils.GEOJSON.shapefile2GeojsonAsync(file, {layer: this, fromProj: 'EPSG:4326'});\n }\n}" ] } ], "Hoverpixel": [ { "key": "_information", "completeAPI": "View the complete HoverPixel API here.", "description": "Create a tool to instantly inspect pixel under mouse. The value of the map can also be used as input for another functions.\nUsage: {{hoverpixel}}", "name": "hoverpixel · value under the mouse (input)" }, { "key": "checked", "description": "Defines if the hoverPixel should start enabled.\nSet true to start enabled, false otherwise.", "type": "Boolean", "examples": [ "|checked = true|" ], "default": "false" }, { "key": "fieldLabel", "description": "Define the text that will be displayed at the left of the toggler", "type": "String", "examples": [ "|text=This is the label text|" ] }, { "key": "getLayerValues", "description": "Reads the values of the composed map under a mouse event: one value per inner layer (from the\nlegend colours of the rendered tiles) plus one extra entry with the result of the layer\n`expression` for those values. This is the `layerVals` argument of `runOnClick`/`runOnHover`;\ncall it from code (`Ext.getCmp(id).items.get(0).getLayerValues(evt, layer)`) to sample the map\nfrom any mouse event. Returns `null` when the layer is hidden, the legend is not loaded yet, or the\nmouse is outside the map data (all layers null/transparent).\n@param evt {MouseEvent} Mouse event with the screen position to sample.\n@param layer {OpenLayers.Layer.Composed} The composed layer to read (normally the tool's own layer).", "type": "function(evt, layer) : Array.|null", "returnDescription": "`[value of layer 0, ..., value of layer n-1, expression result]`, or `null`." }, { "key": "hideLabel", "description": "Defines if the label of the HoverPixel should be displayed.\nSet true to hide the label, false to show it.", "type": "Boolean", "examples": [ "|hideLabel=true|" ], "default": "false" }, { "key": "iconCls", "description": "Defines the CSS class of the toggle switch icon; replace the default to restyle the switch.", "type": "String", "examples": [ "|iconCls=my-toggle-icon|" ], "default": "cmn-toggle-icon" }, { "key": "id", "description": "Defines the id to identify the object.", "type": "String", "examples": [ "|id=exemple_hover_pixel|" ] }, { "key": "labelBefore", "description": "Set true to render the `text` label before (left of) the toggle switch instead of after it.", "type": "Boolean", "examples": [ "|labelBefore=true|" ], "default": "false" }, { "key": "labelStyle", "description": "Defines the style of the label at the HoverPixel toggler.\nYou can use CSS to style the label element.", "type": "String", "examples": [ "|labelStyle=font-weight: bold; color: red;|" ] }, { "key": "notify", "description": "Set false to suppress the notification shown when the tool is activated (\"click on the map...\").", "type": "Boolean", "examples": [ "|notify=false|" ], "default": "true" }, { "key": "runOnClick", "description": "Defines a callback when the user clicks on the map.\n\nIt passes the following parameters for the callback function:\nhandleOnClick(layerVals, inputs, coordinates, clickEvent, lastCoordinates)\n@param layerVals {Array} Array with the values of the maps at the pixel that was clicked.\n@param inputs {Array} Array with the values of the inputs defined in the descriptionHtml.\n@param coordinates {OpenLayers.LonLat} The point that was clicked, in the map's projection (Web\n Mercator, metres) despite the names: `lon` is x and `lat` is y. For degrees, transform it:\n `coordinates.clone().transform(ExtjsUtils.JS.getMap().getProjectionObject(), new OpenLayers.Projection(\"EPSG:4326\"))`\n (lastCoordinates below already holds degrees, of the previous click and hover).\n@param clickEvent {MouseEvent} Mouse event that triggered the function.\n@param lastCoordinates {Object} Object with the last coordinates (latitude, longitude) from the last click and the last hover events.\n lastCoordinates = {\n click: {\n lat: // Latitude of the last click\n lon: // Longitude of the last click\n },\n hover: {\n lat: // Latitude of the last hover\n lon: // Longitude of the last hover\n }\n }", "type": "function", "examples": [ "|handleOnClick: function(layerVals, inputs, coordinates, clickEvent, lastCoordinates) {\n var degrees = coordinates.clone().transform(ExtjsUtils.JS.getMap().getProjectionObject(), new OpenLayers.Projection(\"EPSG:4326\"));\n ExtjsUtils.ALERTIFY.log(\"Latitude: \" + degrees.lat.toFixed(3) + \" Longitude: \" + degrees.lon.toFixed(3));\n}|" ], "default": "undefined" }, { "key": "runOnClickOutside", "description": "True to run the callback function even when clicking outside of the layer, False to disable. (Default False)", "type": "function" }, { "key": "runOnHover", "description": "Defines a callback when the user hovers the map.\n\nIt passes the following parameters for the callback function:\nhandleOnClick(layerVals, inputs, coordinates, clickEvent, lastCoordinates)\n@param layerVals {Array} Array with the values of the maps at the pixel that was hovered.\n@param inputs {Array} Array with the values of the inputs defined in the descriptionHtml.\n@param coordinates {OpenLayers.LonLat} The point that was hovered, in the map's projection (Web\n Mercator, metres) despite the names: `lon` is x and `lat` is y. For degrees, transform it:\n `coordinates.clone().transform(ExtjsUtils.JS.getMap().getProjectionObject(), new OpenLayers.Projection(\"EPSG:4326\"))`\n (lastCoordinates below already holds degrees, of the previous click and hover).\n@param mouseMoveEvent {MouseEvent} Mouse event that triggered the function.\n@param lastCoordinates {Object} Object with the last coordinates (latitude, longitude) from the last click and the last hover events.\n lastCoordinates = {\n click: {\n lat: // Latitude of the last click\n lon: // Longitude of the last click\n },\n hover: {\n lat: // Latitude of the last hover\n lon: // Longitude of the last hover\n }\n }", "type": "function", "examples": [ "|handleOnHover: function(layerVals, inputs, coordinates, mouseMoveEvent, lastCoordinates) {\n ExtjsUtils.ALERTIFY.log(\"Latitude: \" + coordinates.lat + \" Longitude: \" + coordinates.lon);\n}|" ], "default": "undefined" }, { "key": "runOnHoverOutside", "description": "True to run the callback function even when hovering outside of the layer, False to disable. (Default False)", "type": "function" }, { "key": "text", "description": "Define the text that will be displayed at the right of the toggler", "type": "String", "examples": [ "|text=This is the example text|" ] }, { "key": "unselect", "description": "Only changes the activation message: with the default `true` it says a single point is expected,\nwith `false` several. The hoverpixel is never deactivated automatically after a click.", "type": "Boolean", "examples": [ "|unselect=false|" ], "default": "true" }, { "key": "value", "description": "Value stored in `inputs.id[ID]`: the `lastInfo` object `{click, hover}` with the coordinates\n(`{lon, lat}` in EPSG:4326, or `null` before the first event) of the last click and of the last mouse\nmove while the tool is active. The object is updated in place, so it is always current when read in\n`beforeCalc`/`expression`; it is also the last argument of `runOnClick`/`runOnHover` (inside the\ncallback it still holds the previous event — the current one is written right after the callback\nreturns; use the `coordinates` argument for the current position). The input is registered on the\n`forceupdatelayer` event of the widget, which nothing fires by itself — moving the mouse or clicking\ndoes not recalculate the layer. React inside `runOnClick`/`runOnHover` (which also receive the map\nvalues) or trigger the recalculation yourself (e.g. `forceRecalc()` on an InputManager).", "type": "Object", "examples": [ "{{hoverpixel|id=hover_tool|text=Inspect values|runOnClick=onMapClick}}", "functions: {\n onMapClick: function(layerVals, inputs, coords, evt, lastInfo) {\n console.log(coords, lastInfo.click, inputs.id['hover_tool'] === lastInfo); // current, previous, true\n }\n}" ] } ], "InputManager": [ { "key": "_information", "completeAPI": "View the complete InputManager API here.", "description": "Tool to store local variables to be used in others functions callbacks.\nPS: DOM elements cannot be used in 'expression' context, because them cannot be sent to WebWorkers (javascript language limitation).\nUsage: '{{inputmanager}}'", "name": "inputmanager · values kept for your functions (input)" }, { "key": "forceRecalc", "description": "Force a legend map recalculation.", "type": "function()" }, { "key": "getValue", "description": "Get the stored value by his property name, if it does not exists returns null.\n@param key {String} Stored property name.", "type": "function(key) : *", "returnDescription": "Desired stored property when it exists or null otherwise." }, { "key": "id", "description": "Defines the id of the input; it is the key used to reach the manager in `inputs.id[ID]` (required,\nthe tool renders nothing visible).", "type": "String", "examples": [ "|id=state|" ] }, { "key": "setDefaultValues", "description": "Set default values to the stored elements, these values are used before any other value is defined\nand never update or replace another stored values.\n\nPS: Auxiliary function to make easy wrinting the script (typically called in `onInputsReady` or at\nthe start of `beforeCalc`).\nPS: This function never fire layer update.\n@param obj {Object} Default values properties.\n@param local {Boolean} True when the properties should be store locally (and not sent to expression\n WebWorkers callbacks).", "type": "function(obj, local)", "examples": [ "inputs.id['state'].setDefaultValues({year: 2020, scenario: 'base'});" ] }, { "key": "setValues", "description": "Stores object properties for later usage.\n\nPS: If has name property collision the older is replaced.\nPS: Values go to one of two buckets of the manager: `global` (the default — serialized and sent\nto `expression`, so it must hold plain JSON-compatible data) or `_local_` (with `local=true` — kept\nin the browser only, may hold DOM elements, Ext components, functions or circular objects).\n`getValue(key)` looks in `global` first, then in `_local_`.\n@param obj {Object} Object with the properties to be stored.\n@param cancelUpdate {Boolean} False if this change must cause layer recalculation, True otherwise.\n@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)", "type": "function(obj, cancelUpdate, local)", "examples": [ "inputs.id['state'].setValues({year: 2020}); // recalculates the layer", "inputs.id['state'].setValues({lastInterval: cur}, true, true); // silent, browser-only" ] }, { "key": "value", "description": "Value stored in `inputs.id[ID]`: the manager object itself, with `getValue(key)`, `setValues(obj,\ncancelUpdate, local)`, `setDefaultValues(obj, local)` and `forceRecalc()` (listed in this group) and the\n`global` bucket where the stored properties live (`inputs.id[ID].global.key` is a shortcut for\n`getValue`). The layer recalculates on its own `change` event, which `setValues` (unless cancelled) and\n`forceRecalc` trigger. Only the `global` bucket reaches `expression` (WebWorker); values stored with\n`local=true` are kept in a bucket that is not serialized and can therefore hold DOM/Ext references.", "type": "Object", "examples": [ "{{inputmanager|id=state}}", "beforeCalc: function(inputs) {\n var year = inputs.id['state'].getValue('year') || 2020;\n}" ] } ], "Label": [ { "key": "_information", "completeAPI": "This label is created from Ext.form.Label.\nOnly some properties are listed here.", "description": "Create a simple label element to display some text.\nUsage: {{label|}}", "name": "label · text" }, { "key": "cls", "description": "Extra CSS class(es) added to the `