public static interface

MapApi.Layers

com.mapsted.map.MapApi.Layers
Known Indirect Subclasses

Class Overview

Access/manage map-layer related functionality

Summary

Public Methods
abstract void clearPropertyAndBuildingPinLayers(int propertyId)
Clear all pin layers for property and buildings
abstract void clearPropertyAndBuildingRoutingLayers(int propertyId)
Clear all routing layers for property and buildings
abstract BuildingLayers getBuildingLayers(int buildingId)
Call this function to get building layers corresponding to the building id.
abstract PropertyLayers getPropertyLayer(int propertyId)
Call this function to get the property layer
abstract BuildingLayers getSelectedBuildingLayers()
Call this function to get current selected building layers.
abstract VectorElementMapLayer getTopLayer()
Get the top layer (always on top)
abstract void initialize(int propertyId, VectorElementEventListener vectorElementListener, IMapstedVectorTileClicked vectorTileClickedListener, Consumer<Boolean> callback)
Initializes property (and building) layers for a given property

Public Methods

public abstract void clearPropertyAndBuildingPinLayers (int propertyId)

Clear all pin layers for property and buildings

Parameters
propertyId the propertyId

public abstract void clearPropertyAndBuildingRoutingLayers (int propertyId)

Clear all routing layers for property and buildings

Parameters
propertyId the propertyId

public abstract BuildingLayers getBuildingLayers (int buildingId)

Call this function to get building layers corresponding to the building id.

If you want to get selected building's building layer. Use getSelectedBuildingLayers() instead.

Parameters
buildingId Building id corresponding to the building layer you get.
Returns
  • A building layer contains a list of floor layers which contains a list of map layers. Each layer contains a list of element that's added to the map. If the building layer has not initiated yet, it will return null.

public abstract PropertyLayers getPropertyLayer (int propertyId)

Call this function to get the property layer

Returns
  • Property Layer object

public abstract BuildingLayers getSelectedBuildingLayers ()

Call this function to get current selected building layers.

If you want to get a building layer based on building id. Use getBuildingLayers(int) instead.

Returns
  • A building layer contains a list of floor layers which contains a list of map layers. Each layer contains a list of element that's added to the map. If the building layer has not initiated yet, it will return null.

public abstract VectorElementMapLayer getTopLayer ()

Get the top layer (always on top)

Returns
  • MapLayer dedicated for top layer

public abstract void initialize (int propertyId, VectorElementEventListener vectorElementListener, IMapstedVectorTileClicked vectorTileClickedListener, Consumer<Boolean> callback)

Initializes property (and building) layers for a given property

Parameters
propertyId the property layers to initialize
vectorElementListener the vector element listener
vectorTileClickedListener the vector tile clicked listener
callback callback for whether or not initialization was successful