public final class

SteerpathLayerOptions

extends Object
java.lang.Object
   ↳ com.steerpath.sdk.maps.SteerpathLayerOptions

Class Overview

Wraps Mapbox Layer and Filter. When SteerpathLayerOptions is added to the map via addAnnotation(SteerpathAnnotationOptions)}, Layer is added to MapboxMap:
addLayer(Layer l);

Floor specific markers are set visible or invisible with Filters:
Filter.all(
SteerpathLayerOptions.getFilterStatement(), <<<<<<< your custom Filter
Filter.eq("layerIndex", currentFloorIndex),
Filter.eq("buildingRef", visibleBuildingRef)));

When removeAnnotation(SteerpathAnnotation)} is called, Layer is removed from the map.

Deprecated: Will be removed when proper replacement has been implemented for managing Layers.

Summary

Nested Classes
@interface SteerpathLayerOptions.BaseFilter  
Constants
String BUILDING_REF JsonObject property name which is needed for floor switching.
String DEFAULT_SOURCE Steerpath default Source and SourceLayer name.
String LAYER_INDEX JsonObject property name which is needed for floor switching.
Public Constructors
SteerpathLayerOptions()
Default constructor.
Public Methods
String[] getBaseFilters()
TODO
FeatureCollection getFeatureCollection()
TODO
Expression getFilterStatement()
Return filter statement.
HashMap<String, Integer> getImages()
TODO
Layer getLayer()
Returns Layer
Source getSource()
Return Source
String toString()
SteerpathLayerOptions withBaseFilters(String... baseFilters)
TODO
SteerpathLayerOptions withFeatureCollection(FeatureCollection featureCollection)
TODO
SteerpathLayerOptions withFillExtrusionLayer(FillExtrusionLayer layer)
Adds FillExtrusionLayer to the map.
SteerpathLayerOptions withFilterStatement(Expression expression)
Additional and optional Filter.Statement that is applied when building or floor switching takes place.
SteerpathLayerOptions withImage(String imageId, int drawableRes)
TODO
SteerpathLayerOptions withLineLayer(LineLayer layer)
Adds LineLayer to the map.
SteerpathLayerOptions withSource(Source source)
If Layer depends on custom (non-default "blueprint") Source, and it is not added to Mapbox in Activity or Fragment, it can be given to SteerpathLayerOptions.
SteerpathLayerOptions withSymbolLayer(SymbolLayer layer)
Adds SymbolLayer to the map.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String BUILDING_REF

JsonObject property name which is needed for floor switching.

Constant Value: "buildingRef"

public static final String DEFAULT_SOURCE

Steerpath default Source and SourceLayer name.

Constant Value: "blueprint"

public static final String LAYER_INDEX

JsonObject property name which is needed for floor switching.

Constant Value: "layerIndex"

Public Constructors

public SteerpathLayerOptions ()

Default constructor.

Public Methods

public String[] getBaseFilters ()

TODO

public FeatureCollection getFeatureCollection ()

TODO

public Expression getFilterStatement ()

Return filter statement.

public HashMap<String, Integer> getImages ()

TODO

public Layer getLayer ()

Returns Layer

public Source getSource ()

Return Source

public String toString ()

public SteerpathLayerOptions withBaseFilters (String... baseFilters)

TODO

public SteerpathLayerOptions withFeatureCollection (FeatureCollection featureCollection)

TODO

public SteerpathLayerOptions withFillExtrusionLayer (FillExtrusionLayer layer)

Adds FillExtrusionLayer to the map.

public SteerpathLayerOptions withFilterStatement (Expression expression)

Additional and optional Filter.Statement that is applied when building or floor switching takes place.

public SteerpathLayerOptions withImage (String imageId, int drawableRes)

TODO

public SteerpathLayerOptions withLineLayer (LineLayer layer)

Adds LineLayer to the map.

public SteerpathLayerOptions withSource (Source source)

If Layer depends on custom (non-default "blueprint") Source, and it is not added to Mapbox in Activity or Fragment, it can be given to SteerpathLayerOptions. Source will be added to Mapbox when floor changes and removed when annotation is removed.

public SteerpathLayerOptions withSymbolLayer (SymbolLayer layer)

Adds SymbolLayer to the map.