Class: LayerRegions

cercaliagl.control/LayerRegions


This class add administrative dividers such as: neighbourhoods, postal codes and municipalities. You can enable these layers in dropdown UI component.

new LayerRegions()

control/LayerRegions.js, line 46

Extends

Methods

disable()

control/LayerRegions.js, line 172

Disable and remove layer.

getCercaliaMap(){module:cercaliagl/Map~Map} inherited

control/Control.js, line 112

Returns cercalia Map object

Returns:
Cercalia map.

getClass(){string} inherited

control/Control.js, line 85

Get class name.

Returns:
Class name.

getElement(){Element} inherited

control/Control.js, line 103

Get control HTML Element

Returns:
HTML Element

getId(){string} inherited

control/Control.js, line 76

Get control id.

Returns:
Id.

getMap(){module:maplibre-gl~Map} inherited

control/Control.js, line 122

Returns mapboxgl Map object

getName(){string|null} inherited

control/Control.js, line 94

Get control name. Null if control has not defined name.

Returns:
Class name.

hide() inherited

control/Control.js, line 144

Hide control.

selectOption(option)

control/LayerRegions.js, line 158

Options available for regions.

  • cercaliagl.control.LayerRegionsOptions.NONE: No layer region option. Value: none
  • cercaliagl.control.LayerRegionsOptions.NEIGHBOURHOODS: Layer neighbourhoods. Value: neighbourhoods
  • cercaliagl.control.LayerRegionsOptions.POSTALCODES: Layer postal codes. Value: postalcodes
  • cercaliagl.control.LayerRegionsOptions.MUNICIPALITIES: Layer municipalities. Value: municipalities

Example: Enable postal codes feature layer.

const map = new cercaliagl.Map({ target: 'map' });
const control = map.getControlByName(cercaliagl.control.MapControls.LAYER_REGIONS);
control.enableOption(cercaliagl.control.LayerRegionsOptions.POSTALCODES);

Name Type Description
option module:cercaliagl/layer/LayerRegions~LayerRegionsType

Option to enable. See above

show() inherited

control/Control.js, line 153

Show control.