mapbox-maps-android/com.mapbox.maps/ViewAnnotationOptions/Builder

Builder

class Builder

Constructors

Link copied to clipboard
open fun Builder()

Functions

Link copied to clipboard
open fun allowOverlap(@Nullable allowOverlap: Boolean): ViewAnnotationOptions.Builder
If true, the annotation will be visible even if it collides with other previously drawn annotations.
Link copied to clipboard
open fun allowOverlapWithPuck(@Nullable allowOverlapWithPuck: Boolean): ViewAnnotationOptions.Builder
If true, the annotation will be visible even if it collides with the puck.
Link copied to clipboard
open fun allowZElevate(@Nullable allowZElevate: Boolean): ViewAnnotationOptions.Builder
If true, position annotation on buildings' (both fill extrusions and models) rooftops.
Link copied to clipboard
open fun annotatedFeature(@Nullable annotatedFeature: AnnotatedFeature): ViewAnnotationOptions.Builder
Associates a view annotation with the geometry provided by the `AnnotatedFeature`.
Link copied to clipboard
Link copied to clipboard
open fun height(@Nullable height: Double): ViewAnnotationOptions.Builder
View annotation height in `platform pixels`.
Link copied to clipboard
open fun ignoreCameraPadding(@Nullable ignoreCameraPadding: Boolean): ViewAnnotationOptions.Builder
If true, the annotation will be visible even if it is outside the bound that defined by the camera padding.
Link copied to clipboard
open fun maxZoom(@Nullable maxZoom: Float): ViewAnnotationOptions.Builder
maximum zoom value in Mapbox zoom levels [0.0, 25.5] to display View Annotation.
Link copied to clipboard
open fun minZoom(@Nullable minZoom: Float): ViewAnnotationOptions.Builder
minimum zoom value in Mapbox zoom levels [0.0-25.5] to display View Annotation.
Link copied to clipboard
open fun priority(@Nullable priority: Long): ViewAnnotationOptions.Builder
Sorts annotations in descending order based on this value.
Link copied to clipboard
open fun selected(@Nullable selected: Boolean): ViewAnnotationOptions.Builder
Specifies if this view annotation is selected meaning it should be placed on top of others.
Link copied to clipboard
open fun variableAnchors(@Nullable variableAnchors: List<ViewAnnotationAnchorConfig>): ViewAnnotationOptions.Builder
Provide anchor choices for annotation placement.
Link copied to clipboard
open fun visible(@Nullable visible: Boolean): ViewAnnotationOptions.Builder
Specifies if this view annotation is visible or not.
Link copied to clipboard
open fun width(@Nullable width: Double): ViewAnnotationOptions.Builder
View annotation width in `platform pixels`.

Extensions

Link copied to clipboard
inline fun ViewAnnotationOptions.Builder.annotatedLayerFeature(layerId: String, block: AnnotatedLayerFeature.Builder.() -> Unit = {}): ViewAnnotationOptions.Builder

DSL function to set AnnotatedLayerFeature to ViewAnnotationOptions.Builder.annotatedFeature.

Link copied to clipboard
inline fun ViewAnnotationOptions.Builder.annotationAnchor(block: ViewAnnotationAnchorConfig.Builder.() -> Unit): ViewAnnotationOptions.Builder

DSL function to set single ViewAnnotationAnchorConfig to ViewAnnotationOptions.Builder.variableAnchors.

Link copied to clipboard
fun ViewAnnotationOptions.Builder.annotationAnchors(vararg blocks: ViewAnnotationAnchorConfig.Builder.() -> Unit): ViewAnnotationOptions.Builder

DSL function to set multiple ViewAnnotationAnchorConfig's to ViewAnnotationOptions.Builder.variableAnchors. Anchors will be applied in the order they are specified.

Link copied to clipboard
fun ViewAnnotationOptions.Builder.geometry(geometry: Geometry): ViewAnnotationOptions.Builder

DSL function to set Geometry to ViewAnnotationOptions.Builder.annotatedFeature.