arcgis-maps-kotlin/com.arcgismaps.mapping.view/GeoView

GeoView

sealed class GeoView : FrameLayout, DefaultLifecycleObserver

GeoView is a base class for MapView and SceneView, these represent the View in a Model View Controller (MVC) architecture, the Map and Scene that are set on these views represent the model. It contains all of the common operations and events that apply to displaying and working with Maps and Scenes. This includes changing what is viewable area by setting a viewpoint, responding to viewpoint change events, working with graphics overlays and identifying elements that displayed at a given location in the view.

Since

200.0.0

Inheritors

MapView

SceneView

Types

GeoViewLayerViewStateChanged

data class GeoViewLayerViewStateChanged

The data class emitted from the GeoView.layerViewStateChanged SharedFlow.

Properties

attributionText

val attributionText: StateFlow<String>

The attribution text for the data that is currently displayed in the GeoView.

callout

val callout: Callout

The Callout for this geo view. A Callout displays an Android View that contains text and/or other content. A geo view has only one Callout.

drawStatus

val drawStatus: StateFlow<DrawStatus>

The GeoView's current draw status.

graphicsOverlays

lateinit var graphicsOverlays: MutableList<GraphicsOverlay>

A collection containing the GraphicsOverlays.

interactionOptions

abstract val interactionOptions: InteractionOptions

isAttributionBarVisible

open var isAttributionBarVisible: Boolean

True if attribution bar is visible in the GeoView, false otherwise.

isInteracting

val isInteracting: StateFlow<Boolean>

Indicates whether the user is currently interacting with the GeoView.

isNavigating

val isNavigating: Boolean

Is the GeoView currently navigating.

isWrapAroundEnabled

val isWrapAroundEnabled: Boolean

True if the GeoView currently has wraparound turned on, false otherwise.

labeling

var labeling: ViewLabelProperties

The view label properties. The view label properties are an overall control for whether labels will be created and displayed for layers added to the view. Individual layers can also control whether labels should be displayed for their features. Labels need to be enabled both in the view and in the layer. By default the labeling for a view is enabled. The view label properties also control global aspects of the label appearance e.g. animation effects.

layerViewStateChanged

val layerViewStateChanged: SharedFlow<GeoView.GeoViewLayerViewStateChanged>

Sets a callback to be invoked when the layer view state changes for the view.

navigationChanged

val navigationChanged: SharedFlow<Boolean>

A SharedFlow which emits a boolean to indicate that the navigation status of a GeoView has changed.

onAttributionBarLayoutChanged

val onAttributionBarLayoutChanged: SharedFlow<AttributionBarLayoutChangeEvent>

Called when the attribution bar's position or size changes due to expanding, collapsing, or inset changes.

onDoubleTap

abstract val onDoubleTap: SharedFlow<DoubleTapEvent>

A SharedFlow which emits DoubleTapEvent when the user double taps on the screen.

onDown

abstract val onDown: SharedFlow<DownEvent>

A SharedFlow which emits a DownEvent when the user first presses on the screen.

onLongPress

abstract val onLongPress: SharedFlow<LongPressEvent>

A SharedFlow which emits LongPressEvent when a user holds a pointer on the screen.

onPan

abstract val onPan: SharedFlow<PanChangeEvent>

A SharedFlow which emits PanChangeEvent when a user drags a pointer or pointers across the screen.

onRotate

abstract val onRotate: SharedFlow<RotationChangeEvent>

A SharedFlow which emits RotationChangeEvent when a user performs a rotation gesture on the GeoView.

onScale

abstract val onScale: SharedFlow<ScaleChangeEvent>

A SharedFlow which emits ScaleChangeEvent when a user performs a pinch gesture on the GeoView.

onSingleTapConfirmed

abstract val onSingleTapConfirmed: SharedFlow<SingleTapConfirmedEvent>

A SharedFlow which emits SingleTapConfirmedEvents when the user taps once on the screen.

onTwoPointerTap

abstract val onTwoPointerTap: SharedFlow<TwoPointerTapEvent>

A SharedFlow which emits TwoPointerTapEvent when a user taps two pointers on the screen.

onUp

abstract val onUp: SharedFlow<UpEvent>

A SharedFlow which emits an UpEvent when the user removes all their pointers from the screen.

selectionProperties

var selectionProperties: SelectionProperties

The selection properties that is applied to the GeoView. This property allows configuration of new selection highlighting functionality such as selection promotion and switchable selection halo.

spatialReference

val spatialReference: StateFlow<SpatialReference?>

The SpatialReference is used to relate map coordinates to locations in the real world. This property is available when the view's map or scene has been loaded.

timeExtent

val timeExtent: StateFlow<TimeExtent?>

The current TimeExtent of the GeoView. The Time Extent of the GeoView defines how time-enabled data is displayed. Participating layers filter their data to only show data within the time extent set on the GeoView (see TimeAware for details). The range of the time extent includes the start and end values (a feature at 10/24/2016 would be included in a time extent defined as 10/24/2016 - 11/14/2016). Time filtering is not enabled until a non-null time extent is set on the GeoView. When the time extent is null on the GeoView, no time filtering is applied and all content is rendered.

viewpointChanged

val viewpointChanged: SharedFlow<Unit>

A SharedFlow which notifies when the viewpoint of the view has changed.