logo
API Documentation
Tutorials
Getting Started Initialization Layers Third party Controls Geometries Vector styles Measures InfoBox Utils
Releases

Documentation

Modules

  • Constants

Events

  • FEATURE_CLICK
  • FEATURE_HOVER
  • CENTER_DATE_IMAGE
  • CHANGE_MEASURE
  • CLICK
  • COMPLETE_COLLECTIONS
  • FEATURES_CLICK
  • FIND_IMAGES_LOADED
  • FINISH_MEASURE
  • MAP_INITIALIZE
  • MAP_STATUS_EVENT
  • MOVE_END
  • NO_3D_IMAGES
  • POINTER_MOVE
  • START_MEASURE
  • TILES_END_LOAD
  • TILES_START_LOAD
  • FEATURE_CLICK
  • FEATURE_HOVER

General

Classes / Controls

  • Bar
  • Button
  • Swipe
  • Toggle

Classes / Managers

  • CollectionManager
  • OverlayManager

Classes

  • Map

Classes / View

  • MapStatusView

Geometry

Classes

  • Extent
  • Feature
  • Line
  • Location
  • MultiPolygon
  • Point
  • Polygon

Classes / Readers

  • GeoJSON
  • WKT

InfoBox

Classes

  • InfoBox

Layers

Classes

  • ArcGISLayer
  • BingLayer
  • GroupLayer
  • ImageryLayer
  • OSMLayer
  • VectorLayer
  • VectorTileLayer
  • WFSLayer
  • WMSLayer
  • WMTSLayer
  • XYZLayer

Classes / Base Layers

  • BaseLayer
  • BaseVectorLayer

Measurements

Classes / Tools

  • CircleTool
  • HeightTool
  • LineTool
  • PointTool
  • PolygonTool
  • RectangleTool
  • RelativeHeightTool

Classes

  • Measure

Objects

Classes

  • Collection
  • CollectionStatus
  • Image
  • LayerCollections
  • LayerCollectionsStatus
  • MapStatus

Services

Classes

  • UserService

Styles

Classes

  • Circle
  • Fill
  • Icon
  • RegularShape
  • Stroke
  • Style
  • Text

Utils

Classes

  • Transform

Class

GroupLayer

GroupLayer(opts)

Group Layer definition

Learn more about Group Layers in our Group Layer tutorial.

Constructor

# new GroupLayer(opts)

Initialization object

Parameters:
Name Type Attributes Default Description
opts object

Group layer options.

name string <optional>

Layer name

order number <optional>

The order for layer rendering. At rendering time, the layers will be ordered, first by order and then by position. When undefined, a order of 0 is assumed for layers that are added to the map's layers collection.

visible boolean <optional>
true

Visibility

layers Array.<BaseLayer> <optional>

Array of layers to be included in the group.

Tutorials:
  • Group Layer
Example

Create empty layer

const layer = new Vexcel.Layers.GroupLayer();

Extends

  • BaseGroupLayer

Classes

GroupLayer

Methods

# getMaxZoom() → {number}

Gets the maximum zoom level of the layer.

Overrides:
  • BaseGroupLayer#getMaxZoom

The maximum zoom level of the layer.

number

# getMinZoom() → {number}

Gets the minimum zoom level of the layer.

Overrides:
  • BaseGroupLayer#getMinZoom

The minimum zoom level of the layer.

number

# getOpacity() → {number}

Gets the opacity of the layer (between 0 and 1).

Overrides:
  • BaseGroupLayer#getOpacity

The opacity of the layer.

number

# getVisible() → {boolean}

Return the visibility of the layer (true or false).

Overrides:
  • BaseGroupLayer#getVisible

The visibility of the layer.

boolean

# setMaxZoom(maxZoom)

Sets the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters:
Name Type Description
maxZoom number

The maximum zoom of the layer.

Overrides:
  • BaseGroupLayer#setMaxZoom

# setMinZoom(minZoom)

Sets the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters:
Name Type Description
minZoom number

The minimum zoom of the layer.

Overrides:
  • BaseGroupLayer#setMinZoom

# setOpacity(opacity)

Sets the opacity of the layer, allowed values range from 0 to 1.

Parameters:
Name Type Description
opacity number

The opacity of the layer.

Overrides:
  • BaseGroupLayer#setOpacity

# setVisible(visible)

Set the visibility of the layer (true or false).

Parameters:
Name Type Description
visible boolean

The visibility of the layer.

Overrides:
  • BaseGroupLayer#setVisible

Documentation generated by Vexcel Imaging