arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose

Package-level declarations

Types

Link copied to clipboard
@Stable
sealed class GeoViewProxy

Used to perform operations on a composable MapView, SceneView, or LocalSceneView.

Link copied to clipboard
sealed class GeoViewScope

The receiver class of the MapView/SceneView/LocalSceneView content lambda.

Link copied to clipboard
sealed class LeaderPosition

Indicates the side or corner of a callout on which the leader is drawn.

Link copied to clipboard
@Stable
class LocalSceneViewProxy : GeoViewProxy

Used to perform operations on a composable LocalSceneView.

Link copied to clipboard
class LocalSceneViewScope : GeoViewScope

The receiver class of the LocalSceneView content lambda.

Link copied to clipboard
object MapViewDefaults

Contains default values for the composable MapView.

Link copied to clipboard
@Stable
class MapViewProxy : GeoViewProxy

Used to perform operations on a composable MapView.

Link copied to clipboard
class MapViewScope : GeoViewScope

The receiver class of the MapView content lambda.

Link copied to clipboard
object SceneViewDefaults

Contains default values for the SceneView.

Link copied to clipboard
@Stable
class SceneViewProxy : GeoViewProxy

Used to perform operations on a composable SceneView.

Link copied to clipboard
class SceneViewScope : GeoViewScope

The receiver class of the SceneView content lambda.

Link copied to clipboard
sealed class ViewpointPersistence : Parcelable

Enum class representing the different types of viewpoint persistence on a composable MapView.

Functions

Link copied to clipboard
@Composable
fun LocalSceneView(scene: ArcGISScene, modifier: Modifier = Modifier, localSceneViewProxy: LocalSceneViewProxy? = null, onViewpointChangedForCenterAndScale: (Viewpoint) -> Unit? = null, onViewpointChangedForBoundingGeometry: (Viewpoint) -> Unit? = null, interactionOptions: LocalSceneViewInteractionOptions = remember { LocalSceneViewInteractionOptions() }, selectionProperties: SelectionProperties = remember { SelectionProperties() }, isAttributionBarVisible: Boolean = true, onAttributionTextChanged: (String) -> Unit? = null, onAttributionBarLayoutChanged: (AttributionBarLayoutChangeEvent) -> Unit? = null, onNavigationChanged: (isNavigating: Boolean) -> Unit? = null, onSpatialReferenceChanged: (spatialReference: SpatialReference?) -> Unit? = null, onLayerViewStateChanged: (GeoView.GeoViewLayerViewStateChanged) -> Unit? = null, onInteractingChanged: (isInteracting: Boolean) -> Unit? = null, onCurrentViewpointCameraChanged: (camera: Camera) -> Unit? = null, onRotate: (RotationChangeEvent) -> Unit? = null, onScale: (ScaleChangeEvent) -> Unit? = null, onUp: (UpEvent) -> Unit? = null, onDown: (DownEvent) -> Unit? = null, onSingleTapConfirmed: (SingleTapConfirmedEvent) -> Unit? = null, onDoubleTap: (DoubleTapEvent) -> Unit? = null, onLongPress: (LongPressEvent) -> Unit? = null, onTwoPointerTap: (TwoPointerTapEvent) -> Unit? = null, onPan: (PanChangeEvent) -> Unit? = null, onInteractiveZooming: (InteractiveZoomingChangeEvent) -> Unit? = null, onDrawStatusChanged: (DrawStatus) -> Unit? = null, canFocus: Boolean = true, onGeoModelErrorChanged: (Throwable?) -> Unit? = null, onCriticalErrorChanged: (Throwable?) -> Unit? = null, onWarningsChanged: (List<Throwable>) -> Unit? = null, content: @Composable LocalSceneViewScope.() -> Unit? = null)

A user interface control that displays geographic content defined by a local ArcGISScene. A local scene view is a user interface that displays layers and graphics. It controls the area of the local scene that is visible and supports user interactions such as pan and zoom. The local scene view also provides access to the underlying layer data in a local scene.

Link copied to clipboard
@Composable
fun MapView(arcGISMap: ArcGISMap, modifier: Modifier = Modifier, onViewpointChangedForCenterAndScale: (Viewpoint) -> Unit? = null, onViewpointChangedForBoundingGeometry: (Viewpoint) -> Unit? = null, onVisibleAreaChanged: (Polygon) -> Unit? = null, viewpointPersistence: ViewpointPersistence = MapViewDefaults.DefaultViewpointPersistence, graphicsOverlays: List<GraphicsOverlay> = remember { emptyList() }, imageOverlays: List<ImageOverlay> = remember { emptyList() }, analysisOverlays: List<AnalysisOverlay> = remember { emptyList() }, locationDisplay: LocationDisplay = rememberLocationDisplay(), geometryEditor: GeometryEditor? = null, mapViewProxy: MapViewProxy? = null, mapViewInteractionOptions: MapViewInteractionOptions = remember { MapViewInteractionOptions() }, viewLabelProperties: ViewLabelProperties = remember { ViewLabelProperties() }, selectionProperties: SelectionProperties = remember { SelectionProperties() }, insets: PaddingValues = MapViewDefaults.DefaultInsets, grid: Grid? = null, backgroundGrid: BackgroundGrid = remember { BackgroundGrid() }, wrapAroundMode: WrapAroundMode = WrapAroundMode.EnabledWhenSupported, isAttributionBarVisible: Boolean = true, onAttributionTextChanged: (String) -> Unit? = null, onAttributionBarLayoutChanged: (AttributionBarLayoutChangeEvent) -> Unit? = null, timeExtent: TimeExtent? = null, onTimeExtentChanged: (TimeExtent?) -> Unit? = null, onNavigationChanged: (isNavigating: Boolean) -> Unit? = null, onMapRotationChanged: (Double) -> Unit? = null, onMapScaleChanged: (Double) -> Unit? = null, onUnitsPerDipChanged: (Double) -> Unit? = null, onSpatialReferenceChanged: (spatialReference: SpatialReference?) -> Unit? = null, onLayerViewStateChanged: (GeoView.GeoViewLayerViewStateChanged) -> Unit? = null, onAnalysisViewStatusChanged: (GeoView.GeoViewAnalysisViewStatusChanged) -> Unit? = null, onInteractingChanged: (isInteracting: Boolean) -> Unit? = null, onRotate: (RotationChangeEvent) -> Unit? = null, onScale: (ScaleChangeEvent) -> Unit? = null, onUp: (UpEvent) -> Unit? = null, onDown: (DownEvent) -> Unit? = null, onSingleTapConfirmed: (SingleTapConfirmedEvent) -> Unit? = null, onDoubleTap: (DoubleTapEvent) -> Unit? = null, onLongPress: (LongPressEvent) -> Unit? = null, onTwoPointerTap: (TwoPointerTapEvent) -> Unit? = null, onPan: (PanChangeEvent) -> Unit? = null, onInteractiveZooming: (InteractiveZoomingChangeEvent) -> Unit? = null, onDrawStatusChanged: (DrawStatus) -> Unit? = null, canFocus: Boolean = true, onGeoModelErrorChanged: (Throwable?) -> Unit? = null, content: @Composable MapViewScope.() -> Unit? = null)

A compose equivalent of the view-based MapView.

Link copied to clipboard
@Composable
fun OverviewMap(viewpoint: Viewpoint?, modifier: Modifier = Modifier, symbol: Symbol = remember { SimpleMarkerSymbol( style = SimpleMarkerSymbolStyle.Cross, color = Color.red, size = 20.0f ) }, scaleFactor: Double = 25.0, arcGISMap: ArcGISMap = remember { ArcGISMap(BasemapStyle.ArcGISTopographic) })
@Composable
fun OverviewMap(viewpoint: Viewpoint?, visibleArea: Polygon?, modifier: Modifier = Modifier, symbol: Symbol = remember { SimpleFillSymbol( outline = SimpleLineSymbol(color = Color.red), color = Color.transparent ) }, scaleFactor: Double = 25.0, arcGISMap: ArcGISMap = remember { ArcGISMap(BasemapStyle.ArcGISTopographic) })

OverviewMap is a small, secondary MapView which shows a representation of the main GeoView's current Viewpoint.

Link copied to clipboard
@Composable
inline fun rememberLocationDisplay(key: Any? = null, crossinline init: LocationDisplay.() -> Unit = {}): LocationDisplay

Create and remember a LocationDisplay. Checks that ArcGISEnvironment.applicationContext is set and if not, sets one. init will be called when the LocationDisplay is first created to configure its initial state.

Link copied to clipboard
@Composable
fun SceneView(arcGISScene: ArcGISScene, modifier: Modifier = Modifier, onViewpointChangedForCenterAndScale: (Viewpoint) -> Unit? = null, onViewpointChangedForBoundingGeometry: (Viewpoint) -> Unit? = null, graphicsOverlays: List<GraphicsOverlay> = remember { emptyList() }, sceneViewProxy: SceneViewProxy? = null, sceneViewInteractionOptions: SceneViewInteractionOptions = remember { SceneViewInteractionOptions() }, viewLabelProperties: ViewLabelProperties = remember { ViewLabelProperties() }, selectionProperties: SelectionProperties = remember { SelectionProperties() }, grid: Grid? = null, isAttributionBarVisible: Boolean = true, onAttributionTextChanged: (String) -> Unit? = null, onAttributionBarLayoutChanged: (AttributionBarLayoutChangeEvent) -> Unit? = null, cameraController: CameraController = remember { GlobeCameraController() }, analysisOverlays: List<AnalysisOverlay> = remember { emptyList() }, imageOverlays: List<ImageOverlay> = remember { emptyList() }, atmosphereEffect: AtmosphereEffect = AtmosphereEffect.HorizonOnly, timeExtent: TimeExtent? = null, onTimeExtentChanged: (TimeExtent?) -> Unit? = null, spaceEffect: SpaceEffect = SpaceEffect.Stars, sunTime: Instant = SceneViewDefaults.DefaultSunTime, sunLighting: LightingMode = LightingMode.NoLight, ambientLightColor: Color = SceneViewDefaults.DefaultAmbientLightColor, onNavigationChanged: (isNavigating: Boolean) -> Unit? = null, onSpatialReferenceChanged: (spatialReference: SpatialReference?) -> Unit? = null, onLayerViewStateChanged: (GeoView.GeoViewLayerViewStateChanged) -> Unit? = null, onAnalysisViewStatusChanged: (GeoView.GeoViewAnalysisViewStatusChanged) -> Unit? = null, onInteractingChanged: (isInteracting: Boolean) -> Unit? = null, onCurrentViewpointCameraChanged: (camera: Camera) -> Unit? = null, onRotate: (RotationChangeEvent) -> Unit? = null, onScale: (ScaleChangeEvent) -> Unit? = null, onUp: (UpEvent) -> Unit? = null, onDown: (DownEvent) -> Unit? = null, onSingleTapConfirmed: (SingleTapConfirmedEvent) -> Unit? = null, onDoubleTap: (DoubleTapEvent) -> Unit? = null, onLongPress: (LongPressEvent) -> Unit? = null, onTwoPointerTap: (TwoPointerTapEvent) -> Unit? = null, onPan: (PanChangeEvent) -> Unit? = null, onInteractiveZooming: (InteractiveZoomingChangeEvent) -> Unit? = null, onDrawStatusChanged: (DrawStatus) -> Unit? = null, canFocus: Boolean = true, onGeoModelErrorChanged: (Throwable?) -> Unit? = null, content: @Composable SceneViewScope.() -> Unit? = null)

A composable UI element that displays three-dimensional (3D) geographic content defined by an ArcGISScene.