Namespace: layer

Classes

Annotations

Cesium3DTileset

Group

LiDARProjects

Measurements

Mesh3DProjects

Panoramas

PanoramasPoints

Profile3d

Tile

Vector

Type Definitions

---

Cesium3DTilesetOptions

Options for a Mapspace.layer.Cesium3DTileset.

Properties:

Name	Type	Description
minResolution	number | undefined	The minimum resolution (inclusive) at which this layer will be visible.
maxResolution	number | undefined	The maximum resolution (exclusive) below which this layer will be visible.
opacity	number | undefined	Opacity. 0-1. Default is 1.
source	Mapspace.source.Cesium3DTileset | undefined	Source.
visible	boolean | undefined	Visibility. Default is true (visible).
zIndex	number | undefined	The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. The default Z-index is 0.
extent	ol.Extent | undefined	The bounding extent for layer rendering. The layer will not be rendered outside of this extent.

Source:

mapspace/typedefs.js

---

GroupOptions

Options for a Mapspace.layer.Group.

Properties:

Name	Type	Description
groupID	number	The layer group ID. The layer group ID is a unique number that identifies each layer group in Mapspace server for all clients.
groupPaths	string	The layer group paths for this layer. The layer group paths identifies which subgroups must be used in the layer group. If all the layer group must must be used then the layer group paths is equal to an array with the ayer group ID as string.

Source:

mapspace/typedefs.js

---

OrderDefinition

The definition of the best order of layers. The order in the list is the order from top to bottom that should follow the layers, so the last in the list renders on bottom.

Source:

mapspace/typedefs.js

---

TypeDefinition

The definition of the type of layer.

Properties:

Name	Type	Description
layerType	Object	The type of layer.
sourceType	Object | undefined	The type of source.

Source:

mapspace/typedefs.js

---

VectorEventType

Event types of a Mapspace.layer.Vector.

Name	Value	Description
Mapspace.layer.VectorEventType.RULEVISIBLECHANGED	rulevisiblechanged	The visibility of a rule in a style collection has changed.

Source:

mapspace/enums.js

---

VectorOptions

Options for a Mapspace.layer.Vector.

Properties:

Name	Type	Description
renderOrder	ol.RenderOrderFunction | null | undefined	Function to be used when sorting features before rendering. By default features are drawn in the order that they are created. Use null to avoid the sort, but get an undefined draw order.
minResolution	number | undefined	The minimum resolution (inclusive) at which this layer will be visible.
maxResolution	number | undefined	The maximum resolution (exclusive) below which this layer will be visible.
opacity	number | undefined	Opacity. 0-1. Default is 1.
renderBuffer	number | undefined	The buffer around the viewport extent used by the renderer when getting features from the vector source for the rendering or hit-detection. Recommended value: the size of the largest symbol, line width or label. Default is 100 pixels.
source	ol.source.Vector | undefined	Source.
map	ol.Map | undefined	Sets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use ol.Map#addLayer.
style	ol.style.Style | Array.<ol.style.Style> | ol.StyleFunction | undefined	Layer style. See ol.style for default style which will be used if this is not defined.
updateWhileAnimating	boolean | undefined	When set to true, feature batches will be recreated during animations. This means that no vectors will be shown clipped, but the setting will have a performance impact for large amounts of vector data. When set to false, batches will be recreated when no animation is active. Default is false.
updateWhileInteracting	boolean | undefined	When set to true, feature batches will be recreated during interactions. See also updateWhileAnimating. Default is false.
visible	boolean | undefined	Visibility. Default is true (visible).
extent	ol.Extent | undefined	The bounding extent for layer rendering. The layer will not be rendered outside of this extent.
zIndex	number | undefined	The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. The default Z-index is 0.
name	string | undefined	A name for the layer to be shown when rendered in a list of layers. Names do not need to require to be unique.
useStyleCollection	boolean | undefined	If layer must be rendered using the customStyleCollection or not. By default is false.
customStyle	ol.style.Style | undefined	A custom style, only one, that will be applied to all the features in the layer when features do not have its own style. This will override any style option and will create a ol.StyleFunction to render the layer.
customStyleCollection	Mapspace.StyleCollection | undefined	A custom style collection that will be applied to features when useStyleCollection property is true. This will override any style option and will create a ol.StyleFunction to render the layer.
point3DStyle	Mapspace.Point3DStyle | undefined	The style to use to render points in a 3D viewer. By default is POINT2D that means that points are rendering as plain icons in dran in a horizontal plane.
snappingOptions	Mapspace.SnappingOptions | undefined	The snapping options for the layer, that allow to edit snapping geometries to other existing geometries.
filter	Mapspace.Filter | undefined	The array of conditions with the filter to apply to features. Only features that comply with conditions are downloaded if the source is a server source or/and rendered for all sources.
pointHeight	Mapspace.HeightReference | undefined	The option that controls how points are positioned in height in 3D viewers. By default it is NONE = 0, meaning that the Z values in the geometries is what is used to as heights.
formatFunctions	Object.<string, Mapspace.MeasurementFormatFunction> | undefined	An object with any Mapspace.MeasurementType as keys and functions as values. This functions only applies to layers that contains measurements although could be applied to any layer.

Source:

mapspace/typedefs.js

---

VectorStatistics

Statistics for attributes in a Mapspace.layer.Vector.

Properties:

Name	Type	Description
layerid	number	Layer ID in Mapspace servers.
layername	string	Layer name in Mapspace servers.
attributes	Array.<Mapspace.layer.VectorValueGroupStatistics>	Statistics of each different value in attributes.
geometrytype	ol.geom.GeometryType	Main type of geometry in the layer.

Source:

mapspace/typedefs.js

---

VectorStatus

Status of a Mapspace.layer.Vector inside a Mapspace.Viewer.

Name	Value
Mapspace.layer.VectorStatus.IDLE	idle
Mapspace.layer.VectorStatus.UPDATING	updating
Mapspace.layer.VectorStatus.UPDATED	updated

Source:

mapspace/enums.js

---

VectorValueGroupStatistics

Statistics for one value group in a Mapspace.layer.Vector.

Properties:

Name	Type	Description
max	number	Maximum value in the value group.
min	number	Minium value in the value group.
area	number	Total area of features that match this value group.
name	string	Attribute name.
type	string	Type of value group. Can be TEXT, NUMBRE or DECIMAL.
count	number	Number of feaures that match this value group.

Source:

mapspace/typedefs.js