android-sdk-map/com.mapsted.map.views/MapParams

MapParams

open class MapParams

Constructors

constructor()

Types

open class Icon

OnlineBasemapProvider

enum OnlineBasemapProvider

Online basemap fallback provider.

Properties

allowAutomatedClickProcessing

open var allowAutomatedClickProcessing: AtomicBoolean

autoSelectNearbyProperty

open var autoSelectNearbyProperty: AtomicBoolean

When true (default) the SDK auto-plots a nearby Mapsted property as soon as the positioning engine reports it via NearbyPropertiesChangedListener.

open var baseMapStyle: Int

open var btnCompass: MapParams.Icon

btnRecenterOnPropertyOrBuilding

open var btnRecenterOnPropertyOrBuilding: MapParams.Icon

btnRecenterOnUserButton

open var btnRecenterOnUserButton: MapParams.Icon

cameraFollowUser

open var cameraFollowUser: MutableLiveData<Boolean>

open var cartoApiKey: String

API key for CARTO's basemap CDN, supplied by the host app.

clearCartoCacheOnLaunch

open var clearCartoCacheOnLaunch: AtomicBoolean

When true, Carto's persistent disk caches are wiped at SDK init.

enableFilterPropertyByLocale

open var enableFilterPropertyByLocale: AtomicBoolean

enableKineticPan

open var enableKineticPan: AtomicBoolean

Enable kinetic pan (fling-after-release) on the Carto MapView.

enableMapOverlayFeature

open var enableMapOverlayFeature: AtomicBoolean

enableMapOverlaySelection

open var enableMapOverlaySelection: AtomicBoolean

open var logoWatermark: MapParams.Icon

magneticAccuracyDialogCriteria

open var magneticAccuracyDialogCriteria: MutableLiveData<MagneticAccuracyNotificationCriteria>

manuallySelectedPropertyId

open var manuallySelectedPropertyId: AtomicInteger

Pinned property id from an explicit user selection (list tap, deep link, programmatic select).

open var mapPerspective: Int

onlineBasemapProvider

open var onlineBasemapProvider: MapParams.OnlineBasemapProvider

Online basemap tile provider used as fallback when a property has no per-property MBTiles (mapTilesFilerId is null/empty).

onlineBasemapRasterTileUrl

open var onlineBasemapRasterTileUrl: String

URL template for a custom raster tile provider.

onlineBasemapStyleAsset

open var onlineBasemapStyleAsset: String

Asset path (relative to app/src/main/assets/) of a Carto-compatible style ZIP for self-hosted OpenMapTiles vector tiles.

onlineBasemapVectorTileUrl

open var onlineBasemapVectorTileUrl: String

URL template for self-hosted OpenMapTiles vector tiles.

parallelSplashInit

open var parallelSplashInit: AtomicBoolean

When true, the TemplateApplication.onCreate prewarm path constructs the CoreApi on a background IO coroutine instead of waiting for the first Activity lazy-init.

restrictMapBounds

open var restrictMapBounds: MutableLiveData<MapstedMapBounds>

open var restrictMapPan: MutableLiveData<Integer>

restrictMapZoom

open var restrictMapZoom: MutableLiveData<MapstedMapRange>

userPositionErrBoundaryStyle

open var userPositionErrBoundaryStyle: Int

Functions

getPlotEntityTypeVisibility

open fun getPlotEntityTypeVisibility(type: PlotEntityType.Type): PlotEntityType.Visibility

getUserPositionColourScheme

open fun getUserPositionColourScheme(scenario: Int): Int

setPlotEntityTypeVisibility

open fun setPlotEntityTypeVisibility(type: PlotEntityType.Type, visibility: PlotEntityType.Visibility)

setUserPositionColourSchemes

open fun setUserPositionColourSchemes(scenario: Int, dotType: Int)

open fun update(context: Context, @NonNull mapParams: CustomMapParams)

updateCompassButton

open fun updateCompassButton(context: Context, @Nullable icon: CustomMapParams.Icon)

updateRecenterOnPropertyOrBuildingButton

open fun updateRecenterOnPropertyOrBuildingButton(context: Context, @Nullable icon: CustomMapParams.Icon)

updateRecenterOnUserLocationButton

open fun updateRecenterOnUserLocationButton(context: Context, @Nullable icon: CustomMapParams.Icon)