MapLibre Native Android/org.maplibre.android.location/LocationComponentOptions/Builder

Builder

open class Builder

Builder class for constructing a new instance of LocationComponentOptions.

Functions

Link copied to clipboard
@NonNull
open fun accuracyAlpha(accuracyAlpha: Float): LocationComponentOptions.Builder
Set the opacity of the accuracy view to a value from 0 to 1, where 0 means the accuracy view is completely transparent and 1 means the view is completely opaque.
Link copied to clipboard
open fun accuracyAnimationEnabled(accuracyAnimationEnabled: Boolean): LocationComponentOptions.Builder
Enable or disable smooth animation of the accuracy circle around the user's position.
Link copied to clipboard
@NonNull
open fun accuracyColor(accuracyColor: Int): LocationComponentOptions.Builder
Solid color to use as the accuracy view color property.
Link copied to clipboard
@NonNull
open fun backgroundDrawable(backgroundDrawable: Int): LocationComponentOptions.Builder
Defines the drawable used for the background state icon.
Link copied to clipboard
@NonNull
open fun backgroundDrawableStale(backgroundDrawableStale: Int): LocationComponentOptions.Builder
Defines the drawable used for the stale background icon.
Link copied to clipboard
@NonNull
open fun backgroundName(@Nullable backgroundName: String): LocationComponentOptions.Builder
Given a String image name, identical to one used in the first parameter of addImage, the component, will used this image in place of the provided or default maplibre_backgroundDrawable.
Link copied to clipboard
@NonNull
open fun backgroundStaleName(@Nullable backgroundStaleName: String): LocationComponentOptions.Builder
Given a String image name, identical to one used in the first parameter of addImage, the component, will used this image in place of the provided or default maplibre_backgroundDrawableStale.
Link copied to clipboard
@NonNull
open fun backgroundStaleTintColor(@Nullable backgroundStaleTintColor: Integer): LocationComponentOptions.Builder
Defines the background stale color as an integer.
Link copied to clipboard
@NonNull
open fun backgroundTintColor(@Nullable backgroundTintColor: Integer): LocationComponentOptions.Builder
Defines the background color as an integer.
Link copied to clipboard
@NonNull
open fun bearingDrawable(bearingDrawable: Int): LocationComponentOptions.Builder
Defines the drawable used for the bearing icon.
Link copied to clipboard
@NonNull
open fun bearingName(@Nullable bearingName: String): LocationComponentOptions.Builder
Given a String image name, identical to one used in the first parameter of addImage, the component, will used this image in place of the provided or default maplibre_bearingDrawable.
Link copied to clipboard
@NonNull
open fun bearingTintColor(@Nullable bearingTintColor: Integer): LocationComponentOptions.Builder
Defines the bearing icon color as an integer.
Link copied to clipboard
@NonNull
open fun build(): LocationComponentOptions
Build a new instance of this LocationComponentOptions class.
Link copied to clipboard
open fun compassAnimationEnabled(compassAnimationEnabled: Boolean): LocationComponentOptions.Builder
Enable or disable smooth animation of compass values for org.maplibre.android.location.modes.CameraMode and org.maplibre.android.location.modes.RenderMode.
Link copied to clipboard
@NonNull
open fun elevation(elevation: Float): LocationComponentOptions.Builder
Sets the base elevation of this view, in pixels.
Link copied to clipboard
@NonNull
open fun enableStaleState(enabled: Boolean): LocationComponentOptions.Builder
Enable or disable to stale state mode.
Link copied to clipboard
@NonNull
open fun foregroundDrawable(foregroundDrawable: Int): LocationComponentOptions.Builder
Supply a Drawable that is to be rendered on top of all of the content in the Location Component layer stack.
Link copied to clipboard
@NonNull
open fun foregroundDrawableStale(foregroundDrawableStale: Int): LocationComponentOptions.Builder
Defines the drawable used for the stale foreground icon.
Link copied to clipboard
@NonNull
open fun foregroundName(@Nullable foregroundName: String): LocationComponentOptions.Builder
Given a String image name, identical to one used in the first parameter of addImage, the component, will used this image in place of the provided or default maplibre_foregroundDrawable.
Link copied to clipboard
@NonNull
open fun foregroundStaleName(@Nullable foregroundStaleName: String): LocationComponentOptions.Builder
Given a String image name, identical to one used in the first parameter of addImage, the component, will used this image in place of the provided or default maplibre_foregroundDrawableStale.
Link copied to clipboard
@NonNull
open fun foregroundStaleTintColor(@Nullable foregroundStaleTintColor: Integer): LocationComponentOptions.Builder
Defines the foreground stale color as an integer.
Link copied to clipboard
@NonNull
open fun foregroundTintColor(@Nullable foregroundTintColor: Integer): LocationComponentOptions.Builder
Defines the foreground color as an integer.
Link copied to clipboard
@NonNull
open fun gpsDrawable(gpsDrawable: Int): LocationComponentOptions.Builder
Defines the drawable used for the navigation state icon.
Link copied to clipboard
@NonNull
open fun gpsName(@Nullable gpsName: String): LocationComponentOptions.Builder
Given a String image name, identical to one used in the first parameter of addImage, the component, will used this image in place of the provided or default maplibre_gpsDrawable.
Link copied to clipboard
@NonNull
open fun layerAbove(layerAbove: String): LocationComponentOptions.Builder
Sets the id of the layer that's referenced when placing the component on the map using addLayerAbove.
Link copied to clipboard
@NonNull
open fun layerBelow(layerBelow: String): LocationComponentOptions.Builder
Sets the id of the layer that's referenced when placing the component on the map using addLayerBelow.
Link copied to clipboard
@NonNull
open fun maxZoomIconScale(maxZoomIconScale: Float): LocationComponentOptions.Builder
Sets the scale factor of the location icon when the map is zoomed in.
Link copied to clipboard
@NonNull
open fun minZoomIconScale(minZoomIconScale: Float): LocationComponentOptions.Builder
Sets the scale factor of the location icon when the map is zoomed out.
Link copied to clipboard
@NonNull
open fun padding(@Nullable padding: Array<Int>): LocationComponentOptions.Builder
Sets the distance from the edges of the map view’s frame to the edges of the map view’s logical viewport.
Link copied to clipboard
open fun pulseAlpha(pulseAlpha: Float): LocationComponentOptions.Builder
Sets the opacity of the LocationComponent's pulsing circle.
Link copied to clipboard
open fun pulseColor(@ColorInt pulseColor: Int): LocationComponentOptions.Builder
Sets the color of the LocationComponent's pulsing circle.
Link copied to clipboard
open fun pulseEnabled(pulseEnabled: Boolean): LocationComponentOptions.Builder
Enable or disable the LocationComponent's pulsing circle.
Link copied to clipboard
open fun pulseFadeEnabled(pulseFadeEnabled: Boolean): LocationComponentOptions.Builder
Enable or disable fading of the LocationComponent's pulsing circle.
Link copied to clipboard
open fun pulseInterpolator(pulseInterpolator: Interpolator): LocationComponentOptions.Builder
Sets the pulsing circle's interpolator animation.
Link copied to clipboard
open fun pulseMaxRadius(pulseMaxRadius: Float): LocationComponentOptions.Builder
The maximum radius that a single pulse should expand the LocationComponent's pulsing circle to.
Link copied to clipboard
open fun pulseSingleDuration(pulseSingleDuration: Float): LocationComponentOptions.Builder
Sets the number of milliseconds it takes for a single pulse of the LocationComponent's pulsing circle.
Link copied to clipboard
@NonNull
open fun staleStateTimeout(timeout: Long): LocationComponentOptions.Builder
Set the timeout before the location icon becomes stale.
Link copied to clipboard
@NonNull
open fun trackingAnimationDurationMultiplier(trackingAnimationDurationMultiplier: Float): LocationComponentOptions.Builder
Sets the tracking animation duration multiplier.
Link copied to clipboard
@NonNull
open fun trackingGesturesManagement(trackingGesturesManagement: Boolean): LocationComponentOptions.Builder
Set whether gesture threshold should be adjusted when camera is in one of the tracking modes.
Link copied to clipboard
@NonNull
open fun trackingInitialMoveThreshold(moveThreshold: Float): LocationComponentOptions.Builder
Sets minimum single pointer movement (map pan) in pixels required to break camera tracking.
Link copied to clipboard
@NonNull
open fun trackingMultiFingerMoveThreshold(moveThreshold: Float): LocationComponentOptions.Builder
Sets minimum multi pointer movement (map pan) in pixels required to break camera tracking (for example during scale gesture).
Link copied to clipboard
@NonNull
open fun trackingMultiFingerProtectedMoveArea(@Nullable rect: RectF): LocationComponentOptions.Builder
Sets protected multi pointer gesture area.