ol-ishare/litemap

iShare Maps LiteMap, creates a map based on a profile and enables an info interaction.

import { LiteMap } from 'ol-ishare/litemap'

Classes

LiteMap

Type Definitions

MapOptions

Properties:
Name Type Attributes Default Description
iShareUrl String

Base URL for iShare Web app
profile String

Name of profile to load
target String

DOM element that the map will be created within
view Object <optional>

Initial view as {easting: Number, northing: Number, zoom: Number}
layers Array.<String> | String | Array.<module:ol-ishare/litemap~LayerOption> <optional>

Layers to be visible at map creation, one of: an array of layer names; a comma-separated list of layer names; or an array of LayerOption objects. If only names are specified then layers are added using the default values in LayerOption overriding layer settings in the profile
defaultLayers String <optional>
 initial

In addition to those specified in layers option: 'all' - create all layers, visibility set by layer config in the profile; 'initial' - create and enable those with 'initiallyVisible':true (default); or 'none' - create no additional layers.
baseMap String <optional>

Name of basemap to load on startup (if not set, uses the default in specified profile)
map ol/PluggableMap~MapOptions <optional>

Optional OpenLayers Map Options

Properties
Name Type Attributes Description
interactions ol/Collection.<ol/interaction/Interaction> <optional>

Collection of interactions to be added to the map

Options for iShare Map object

Type:

LayerOption

Properties:
Name Type Attributes Default Description
name String

Name of layer to add to the map
visible Boolean <optional>
 true

Whether the layer should be visible when the map is created
opacity Number <optional>
 1

How opaque the layer should be at load

MapOptions layer configuration

Type: