To configure hslayers-ng based map project different config options can be used. They have to be specified in the main application file (usually app.js) using module.value('config') service: ``` module.value('config', { terrain_provider: 'https://assets.agi.com/stk-terrain/v1/tilesets/world/tiles', terrain_providers: [{ title: 'EU-DEM', url: 'https://assets.agi.com/stk-terrain/v1/tilesets/world/tiles', active: true }], default_layers: [ ... ``` The following page describes all the configuration options grouped by use case ## Map **box_layers** An array of ol.layer.Group objects, which is used to group layers into topics. Each box layer must contain layers property which is an array of ol.layer.Layer objects similar to default_layers config property. Name of the group is contained in "title" property and path to icon image can be provided in "img" property. **default_layers** ``` Array of layers which are OpenLayers layers and are not part of a layer group or "box" layer. The can contain extra parameters not specified in OL api such as "path", "show_in_manager", "base", "position", etc. Example: new ol.layer.Tile({ title: "Ilida plastics kg/ha per year", source: new ol.source.TileWMS({ url: 'http://gis.lesprojekt.cz/cgi-bin/mapserv?map=/home/dima/maps/ilida/ilida.map', params: { LAYERS: 'ilida_cultivation_plastics', INFO_FORMAT: undefined, FORMAT: "image/png", ABSTRACT: "Plastic waste in Ilida municipality" }, crossOrigin: "anonymous" }), path: 'Ilida Thematic Data', base: false, visible: true, opacity: 0.8 }) ``` **default_view** Openlayers view which specifies default map center, projection, zoom etc. Example: ``` new ol.View({ center: ol.proj.transform([17.474129, 52.574000], 'EPSG:4326', 'EPSG:3857'), //Latitude longitude to Spherical Mercator zoom: 4, units: "m" }) ``` ## Layer manager **layer_order** 1 for ascending order, -1 for descending. Layers are ordered by position in the layer array (default_layers config option). **open_lm_after_comp_loaded** Set to true to open layer manager when map composition is loaded ## Cesium 3D maps **cesiumAccessToken** Access token for cesium. Register for it here https://cesium.com/ion/assets/ **cesiumAnimation** Boolean property to specify if cesium should animate 3D objects **cesiumBase** Directory of cesium library. Example: ./node_modules/cesium/Build/Cesium/ **cesiumBingKey** API key for bing maps used as Cesium base layer. See: https://www.bingmapsportal.com/ **cesiumdDebugShowFramesPerSecond** Boolean property to turn on or off FPS counter which is used for performance benchmarking. **cesiumInfoBox** Boolean property to specify weather to show get feature info results in Cesiums interface. **cesiumShadows** Boolean property to specify weather to sho shadows for objects and terrain. **cesiumTime** Cesium.JulianDate class object which specifies default time value to set Cesiums viewer.clockViewModel.currentTime to. See: https://cesiumjs.org/Cesium/Build/Documentation/JulianDate.html **cesiumTimeline** Boolean parameter to turn on and off Cesiums timeline **creditContainer** optional Element | String The DOM element or ID that will contain the CreditDisplay. If not specified, the credits are added to the bottom of the widget itself. **createWorldTerrainOptions** optional Object. If no terrain_provider config parameter is present, then createWorldTerrainOptions object is used in Cesium.createWorldTerrain function to create terrain layer. See: https://cesiumjs.org/Cesium/Build/Documentation/createWorldTerrain.html **imageryProvider** Cesium.ImageryProvider object. optional. The imagery provider to use instead of default bing maps. This value is only valid if Cesiums options.baseLayerPicker is set to false. See: https://cesiumjs.org/Cesium/Build/Documentation/ImageryProvider.html **terrain_provider** optional Object. This is passed to viewer.terrainProvider configuration option. See: https://cesiumjs.org/Cesium/Build/Documentation/Viewer.html and https://cesiumjs.org/Cesium/Build/Documentation/TerrainProvider.html . Example: ``` new Cesium.CesiumTerrainProvider({ url : Cesium.IonResource.fromAssetId(3956), requestVertexNormals : true }) ``` **terrain_providers** optional Array of TerrainProvider objects between which user will be able to choose in layer manager. See terrain_provider config option. **terrainExaggeration** Number optional A scalar used to exaggerate the terrain. Default value is 1.0. Note that terrain exaggeration will not modify any other primitive as they are positioned relative to the ellipsoid. ## Status manager and Compositions catalogue **advanced_form** Boolean parameter to use advanced form of status creator to save compositions. **comp_keywords** Boolean parameter to show dropdown for filtering of compositions based on keywords. **compositions_catalogue_url** String URL of compositions catalogue. Example: https://atlas.kraj-lbc.cz/php/metadata/csw/index.php **hostname** Object used to build GUI where the user can change the source for compositions catalogue or add his own **hostname.default** Object default endpoint of the application if multiple endpoints are available (for compositions catalogue, etc.) **hostname.default.url** String, Fully qualified domain name part of the URL used as the remote endpoint **hostname.compositions_catalogue** String URL of compositions catalogue. Example: https://atlas.kraj-lbc.cz/php/metadata/csw/index.php **hostname.status_manager** **hostname.status_manager.url** URL or path of status manager. Usually its on the same server and then '/wwwlibs/statusmanager2/index.php' or similar can be used. **hostname.user.url** **hostname.user.type** String, the type of the hostname (denoting for which purposes it should be used) – e.g. compositions_catalogue (for compositions catalogue), status_manager (for status manages), default (fallback for the previous two), user (overriding the defaults) **hostname.user.editable** Boolean parameter denoting whether the user should be able to delete or change this hostname object from the list of hostnames. **hostnames** **project_name** String variable of project name which is used as a project GET parameter queries to status manager when loading compositions list and making updates and deletes. **status_manager_url** URL or path of status manager. Usually its on the same server and then '/wwwlibs/statusmanager2/index.php' or similar can be used. ## Datasources **connectTypes** Array of possible dataset types in own panel. Default value is ["", "WMS", "KML", "GeoJSON"] **datasources** Array of datasource catalogues which are used in Datasource explorer panel. Example: ``` [ { title: "Datasets", url: "http://otn-dev.intrasoft-intl.com/otnServices-1.0/platform/ckanservices/datasets", language: 'eng', type: "ckan", download: true }, { title: "Services", url: "http://cat.ccss.cz/csw/", language: 'eng', type: "micka", code_list_url: 'http://www.whatstheplan.eu/php/metadata/util/codelists.php?_dc=1440156028103&language=eng&page=1&start=0&limit=25&filter=%5B%7B%22property%22%3A%22label%22%7D%5D' }, { title: "Hub layers", url: "http://opentnet.eu/php/metadata/csw/", language: 'eng', type: "micka", code_list_url: 'http://opentnet.eu/php/metadata/util/codelists.php?_dc=1440156028103&language=eng&page=1&start=0&limit=25&filter=%5B%7B%22property%22%3A%22label%22%7D%5D' } ] ``` **dsPaging** How many items to display in dataset list **dss_disallow_add** Boolean parameter to specify, that datasets must not be allowed to be added to map. ## GUI **createExtraMenu** A function which manipulates sidebar items and creates extra menu items by using AngularJs $compile function. Example: ``` function ($compile, $scope, element) { $scope.uploadClicked = function () { alert("UPLOAD!") } var el = angular.element("
  • Upload
    • "); element.find('ul').append(el); $compile(el)($scope); } ``` **design** String. Set this to 'md' to use Material Design instead of Bootstrap **draggable_windows** Boolean parameter to specify if panels can be dragged out of sidepanel. **importCss** Boolean parameter True by default to specify if to import css files (openlayers.css, bootstrap.min.css, icon fonts). Set this to false for webpack usage where css is imported/required specifically outside hsl. **useIsolatedBootstrap** Load bootstrap css from node_modules/bootstrap/dist/css/bootstrap.isolated.css , which can be generated using ```npm explore hslayers-ng -- npm run isolate-bootstrap``` if hslayers-ng is dependency of your app or ```npm run isolate-bootstrap``` if you have cloned hslayers-ng repo directly. ## Sharing **permalinkLocation** Object which specifies parameters for generation of sharable link of map **permalinkLocation.origin** Domain name of url where parmalink points to **permalinkLocation.pathname** Path name of application on the server which permalink points to **shortenUrl** By default tinyurl is used, but user provided function in config.shortenUrl can be used. Example: ``` function(url) { return new Promise(function(resolve, reject){ $http.get("http://tinyurl.com/api-create.php?url=" + url, { longUrl: url }).then(function(response) { resolve(response.data); }, function(err) { reject() }) }) } ``` **social_hashtag** String. Hashtag or any other text to append to title generated for sharing in social networks ## Senslog **senslog_url** Senslog server URL. Example: http://portal.sdi4apps.eu/SensLog-VGI/rest/vgi **user_name** Senslog user name ## Other **crossfilterable_layers** DEPRECATED. Array of layers to be crossfilterable. Each element is an object which contains layer indexes and feature property to group/count the features. Example: ``` [{ layer_ix: 1, attributes: ["http://gis.zcu.cz/poi#category_osm"] }] ``` **locationButtonVisible** Show or hide geolocation button on map. Possible values: true/false **queryPoint** How to display point clicked on the map. Possible values are: hidden, notWithin **query.multi** Boolean. Allow selecting and displaying info about multiple vector layer features. **search_provider** String to specify which search provider should be used. Can contain values: "sdi4apps_openapi", "geonames"