### Started Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/index.html Utility Network Trace tool is in add starting points mode. ```APIDOC data object Started : AddStartingPointMode Utility Network Trace tool is in add starting points mode. ``` -------------------------------- ### Started Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/-started/index.html The `Started` object is a data object that implements the `AddStartingPointMode` interface. It signifies that the trace tool is actively in a mode where starting points can be added. ```APIDOC ## Started data object Started : AddStartingPointMode Utility Network Trace tool is in add starting points mode. #### Since 200.6.0 ``` -------------------------------- ### Stopped Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/index.html Utility Network Trace tool is not adding starting points. ```APIDOC data object Stopped : AddStartingPointMode Utility Network Trace tool is not adding starting points. ``` -------------------------------- ### addStartingPoint (fun) Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/index.html Add a starting point for a utility network trace. ```APIDOC fun addStartingPoint(arcGISFeature: ArcGISFeature, mapPoint: Point? = null) ``` -------------------------------- ### Add Starting Point by Feature and Map Point Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/add-starting-point.html Add a starting point for a utility network trace by specifying a feature and its map point. ```APIDOC ## addStartingPoint(arcGISFeature: ArcGISFeature, mapPoint: Point? = null) ### Description Add a starting point for a utility network trace. ### Parameters #### Path Parameters - **arcGISFeature** (ArcGISFeature) - Required - the feature to use as the starting point - **mapPoint** (Point) - Optional - the map point to indicate the location of the starting point ``` -------------------------------- ### None Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/-none/index.html Utility Network Trace is neither started nor stopped. ```APIDOC ## None ### Description Utility Network Trace is neither started nor stopped. ### Since 200.6.0 ``` -------------------------------- ### Initialize and Handle Floor Filter State Changes Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-floor-filter-state/index.html Demonstrates how to initialize the FloorFilterState and handle selection changes for floors, facilities, and sites. This example shows how to update the map's viewpoint when a floor site is selected. ```kotlin val floorFilterState: FloorFilterState = FloorFilterState(this.map.value, viewModelScope, uiProperties) { floorFilterSelection -> when (floorFilterSelection.type) { is FloorFilterSelection.Type.FloorSite -> { val floorFilterSelectionType = floorFilterSelection.type as FloorFilterSelection.Type.FloorSite floorFilterSelectionType.site.geometry?.let { this.setViewpoint(Viewpoint(getEnvelopeWithBuffer(it))) } } is FloorFilterSelection.Type.FloorFacility -> { .... } } ``` -------------------------------- ### None Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/index.html Utility Network Trace is neither started nor stopped. This is the default state. ```APIDOC data object None : AddStartingPointMode Utility Network Trace is neither started nor stopped. ``` -------------------------------- ### Add Starting Point by Map Tap Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/add-starting-point.html A single tap handler to identify starting points on the map. Call this method from `com.arcgismaps.toolkit.geoviewcompose.MapView` onSingleTapConfirmed lambda. ```APIDOC ## addStartingPoint(mapPoint: Point) ### Description A single tap handler to identify starting points on the map. Call this method from `com.arcgismaps.toolkit.geoviewcompose.MapView` onSingleTapConfirmed lambda. ### Parameters #### Path Parameters - **mapPoint** (Point) - Required - the point on the map user tapped on to identify starting points ``` -------------------------------- ### Initializing State Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-flyover-scene-view-status/-initializing/index.html The `Initializing` data object signifies that the `FlyoverSceneView` is currently in its setup phase. During this time, it verifies AR compatibility and obtains required permissions. The view is not yet functional. ```APIDOC data object Initializing : FlyoverSceneViewStatus The FlyoverSceneView is initializing. The FlyoverSceneView is not ready to be used yet. During this stage, the FlyoverSceneView will ensure that the device supports AR and that the necessary permissions are granted. #### Since 200.8.0 ``` -------------------------------- ### AddStartingPointMode Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/index.html The AddStartingPointMode sealed class defines the different states for adding starting points to a Utility Network Trace. ```APIDOC sealed class AddStartingPointMode Represents the mode when adding starting points. #### Since 200.6.0 ``` -------------------------------- ### Available Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-vps-availability/index.html VPS is available at the requested location. ```APIDOC data object Available : WorldScaleVpsAvailability VPS is available at the requested location. ``` -------------------------------- ### Stopped Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-add-starting-point-mode/-stopped/index.html The `Stopped` object signifies that the Utility Network Trace tool is configured not to add any starting points. This is the default behavior when no specific starting point mode is set. ```APIDOC ## Stopped data object Stopped : AddStartingPointMode Utility Network Trace tool is not adding starting points. #### Since 200.6.0 ``` -------------------------------- ### Initializing Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-status/index.html The TableTopSceneView is initializing. The TableTopSceneView is not ready to be used yet. During this stage, the TableTopSceneView will ensure that the device supports AR and that the necessary permissions are granted. ```APIDOC data object Initializing : TableTopSceneViewStatus The TableTopSceneView is initializing. The TableTopSceneView is not ready to be used yet. During this stage, the TableTopSceneView will ensure that the device supports AR and that the necessary permissions are granted. ``` -------------------------------- ### activeFeatureForm Property Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.featureforms/-feature-form-state/index.html Gets the currently active FeatureForm. ```APIDOC ## activeFeatureForm Property ### Description Represents the currently active `FeatureForm`. This property is updated automatically when navigating between different forms, such as when viewing associations for an `UtilityAssociationFormElement`. ### Type FeatureForm ``` -------------------------------- ### WorldScaleSceneViewProxy Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-proxy/index.html Initializes a new instance of the WorldScaleSceneViewProxy class. ```APIDOC ## WorldScaleSceneViewProxy() ### Description Initializes a new instance of the WorldScaleSceneViewProxy class. ### Constructor WorldScaleSceneViewProxy() ``` -------------------------------- ### fieldOfView Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-proxy/index.html Gets the horizontal field of view of the WorldScaleSceneView in degrees. ```APIDOC ## fieldOfView ### Description The horizontal field of view of the WorldScaleSceneView in degrees. ### Property `val fieldOfView: Double?` ``` -------------------------------- ### Launch Custom Tabs for Authentication Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/-authentication-activity/index.html Use the `launchCustomTabs` extension function within the `onPendingBrowserAuthenticationChallenge` lambda of an `Authenticator` to initiate the browser-based authentication flow. ```kotlin DialogAuthenticator( authenticatorState = authenticatorState, onPendingBrowserAuthenticationChallenge = { pendingBrowserAuthenticationChallenge -> launchCustomTabs(pendingBrowserAuthenticationChallenge) } ) ``` -------------------------------- ### fieldOfView Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-flyover-scene-view-proxy/index.html Gets the horizontal field of view of the FlyoverSceneView in degrees. ```APIDOC ## fieldOfView ### Description Gets the horizontal field of view of the FlyoverSceneView in degrees. ### Returns - **Double?** The horizontal field of view in degrees, or null if undetermined. ``` -------------------------------- ### Initialized Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-status/index.html The TableTopSceneView is initialized successfully. The TableTopSceneView is ready to be used. The scene will be rendered after the user taps on a plane to place the scene. ```APIDOC data object Initialized : TableTopSceneViewStatus The TableTopSceneView is initialized successfully. The TableTopSceneView is ready to be used. The scene will be rendered after the user taps on a plane to place the scene. ``` -------------------------------- ### TableTopSceneViewProxy Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-proxy/index.html Initializes a new instance of the TableTopSceneViewProxy class. ```APIDOC ## TableTopSceneViewProxy() ### Description Initializes a new instance of the TableTopSceneViewProxy class. ### Constructor `TableTopSceneViewProxy()` ``` -------------------------------- ### Initializing Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-status/index.html The WorldScaleSceneView is initializing. It is not ready to be used yet. During this stage, the WorldScaleSceneView will ensure that the device supports AR and that the necessary permissions are granted. ```APIDOC data object Initializing : WorldScaleSceneViewStatus The WorldScaleSceneView is initializing. The WorldScaleSceneView is not ready to be used yet. During this stage, the WorldScaleSceneView will ensure that the device supports AR and that the necessary permissions are granted. ``` -------------------------------- ### fieldOfView Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-scene-view-proxy/index.html Gets the horizontal field of view of the scene view in degrees. ```APIDOC ## fieldOfView ### Description Retrieves the horizontal field of view of the scene view, measured in degrees. This property provides insight into the camera's perspective. ### Property `val fieldOfView: Double?` ``` -------------------------------- ### Initialized Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-status/index.html The WorldScaleSceneView is initialized successfully. It is ready to be used and the scene will be rendered. ```APIDOC data object Initialized : WorldScaleSceneViewStatus The WorldScaleSceneView is initialized successfully. The WorldScaleSceneView is ready to be used and the scene will be rendered. ``` -------------------------------- ### fieldOfView Property Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-proxy/index.html Gets the horizontal field of view of the TableTopSceneView in degrees. ```APIDOC ## fieldOfView ### Description The horizontal field of view of the TableTopSceneView in degrees. ### Property `val fieldOfView: Double?` ``` -------------------------------- ### LocalSceneViewProxy() Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-local-scene-view-proxy/index.html Creates a new instance of LocalSceneViewProxy. ```APIDOC ## LocalSceneViewProxy() ### Description Constructor for LocalSceneViewProxy. ### Parameters None ``` -------------------------------- ### launchCustomTabs Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/index.html Launches the custom tabs activity for handling browser-based authentication challenges. ```APIDOC ## launchCustomTabs ### Description Launches the custom tabs activity with the provided browser authentication challenge. ### Signature ```kotlin fun Activity.launchCustomTabs(pendingBrowserAuthenticationChallenge: BrowserAuthenticationChallenge) ``` ### Parameters - `pendingBrowserAuthenticationChallenge`: The browser authentication challenge to launch. ``` -------------------------------- ### fieldOfViewDistortionRatio Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-flyover-scene-view-proxy/index.html Gets the ratio indicating how much the vertical field of view is distorted. ```APIDOC ## fieldOfViewDistortionRatio ### Description Gets the ratio indicating how much the vertical field of view is distorted. ### Returns - **Double?** The distortion ratio, or null if undetermined. ``` -------------------------------- ### UIProperties Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-u-i-properties/-u-i-properties.html Initializes a new instance of the UIProperties class with customizable UI properties for indoor maps. ```APIDOC ## UIProperties Constructor ### Description Constructs a `UIProperties` object with default or specified values for various UI elements. ### Parameters - **selectedBackgroundColor** (Color) - Optional - The background color for selected items. Defaults to `Color(0xFFE2F1FB)`. - **selectedForegroundColor** (Color) - Optional - The foreground color for selected items. Defaults to `Color(0xFF005E95)`. - **searchBackgroundColor** (Color) - Optional - The background color for search results. Defaults to `Color(0xFFEEEEEE)`. - **textColor** (Color) - Optional - The default text color. Defaults to `Color.DarkGray`. - **backgroundColor** (Color) - Optional - The default background color. Defaults to `Color.White`. - **maxDisplayLevels** (Int) - Optional - The maximum number of levels to display. Defaults to -1 (all levels). - **siteFacilityButtonVisibility** (Int) - Optional - Visibility of the site/facility button. Defaults to `View.VISIBLE`. - **closeButtonVisibility** (Int) - Optional - Visibility of the close button. Defaults to `View.VISIBLE`. - **closeButtonPosition** (ButtonPosition) - Optional - The position of the close button. Defaults to `ButtonPosition.Top`. - **buttonSize** (Size) - Optional - The size of buttons. Defaults to `Size(60.dp.value, 40.dp.value)`. - **typography** (Typography) - Optional - The typography settings for text elements. Defaults to `Typography()`. ``` -------------------------------- ### Geospatial.name Property Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-tracking-mode/-geospatial/index.html Gets the name of the Geospatial tracking mode. This property returns the identifier for the mode. ```APIDOC ## Properties ### name Link copied to clipboard ```kotlin val name: String ``` ### Description Gets the name of the Geospatial tracking mode. This property returns the identifier for the mode. ``` -------------------------------- ### isWrapAroundEnabled Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-flyover-scene-view-proxy/index.html Gets a boolean indicating if continuous panning across the international date line is enabled. ```APIDOC ## isWrapAroundEnabled ### Description Gets a boolean indicating if continuous panning across the international date line is enabled in the FlyoverSceneView. ### Returns - **Boolean?** True if wrap-around is enabled, false otherwise. A null value represents that it is currently undetermined. ``` -------------------------------- ### ServerTrustChallenge Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/-server-trust-challenge/-server-trust-challenge.html Initializes a new ServerTrustChallenge with a network authentication challenge and a callback for user responses. ```APIDOC ## ServerTrustChallenge constructor ### Description Initializes a new instance of the `ServerTrustChallenge` class. ### Parameters #### `challenge` (NetworkAuthenticationChallenge) - Required - The network authentication challenge that needs to be handled. #### `onUserResponseReceived` ((Boolean) -> Unit) - Required - A callback function that will be invoked with the user's response (true for accept, false for deny) once it is received. ``` -------------------------------- ### addStartingPointMode Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/add-starting-point-mode.html Governs taps on the map. When the mode is AddStartingPointMode.Started taps will identify starting points and pass underlying Features to this object. ```APIDOC ## addStartingPointMode ### Description Governs taps on the map. When the mode is AddStartingPointMode.Started taps will identify starting points and pass underlying Features to this object. ### Property `val addStartingPointMode: State` ### Since 200.6.0 ### See also [AddStartingPointMode] ``` -------------------------------- ### Accessing fieldOfViewDistortionRatio Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-scene-view-proxy/field-of-view-distortion-ratio.html Get the current vertical field of view distortion ratio. A null value means it's undetermined. ```kotlin val distortionRatio: Double? = sceneViewProxy.fieldOfViewDistortionRatio ``` -------------------------------- ### FailedToInitialize Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-initialization-status/index.html The state object failed to initialize. ```APIDOC data class FailedToInitialize(val error: Throwable) : InitializationStatus ``` -------------------------------- ### addStartingPoint (suspend fun) Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/index.html A single tap handler to identify starting points on the map. Call this method from com.arcgismaps.toolkit.geoviewcompose.MapView onSingleTapConfirmed lambda. ```APIDOC suspend fun addStartingPoint(mapPoint: Point) ``` -------------------------------- ### FailedToInitialize Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-status/index.html The TableTopSceneView failed to initialize. The error property contains the error that caused the failure. ```APIDOC data class FailedToInitialize : TableTopSceneViewStatus The TableTopSceneView failed to initialize. The error property contains the error that caused the failure. ``` -------------------------------- ### Accessing Offline Map Information Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.offline/-offline-repository/offline-map-infos.html Retrieve a list of `OfflineMapInfo` objects to get details about web maps with downloaded map areas. ```APIDOC ## offlineMapInfos ### Description The portal item information for web maps that have downloaded map areas. ### Property `val offlineMapInfos: List` ### Since 200.8.0 ``` -------------------------------- ### Get Analysis View Status Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-proxy/get-analysis-view-status.html Retrieves the status of a given analysis within the TableTopSceneView. Returns null if the view does not contain the analysis or if the proxy's TableTopSceneView is not part of the composition. ```APIDOC ## getAnalysisViewStatus ### Description Retrieves the analysis' status in the view. ### Parameters #### Parameters - **analysis** (Analysis) - Description: An analysis object to get the view status for. ### Return AnalysisViewStatus? - a valid AnalysisViewStatus or null if the view doesn't contain the given analysis or this proxy's TableTopSceneView is not part of the composition. ### Since 300.0.0 ``` -------------------------------- ### ServerTrustChallenge Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/-server-trust-challenge/index.html Initializes a new instance of the ServerTrustChallenge class. ```APIDOC ## ServerTrustChallenge Constructor ### Description Initializes a new instance of the ServerTrustChallenge class. ### Parameters * `challenge` (NetworkAuthenticationChallenge) - The NetworkAuthenticationChallenge that initiated this challenge. * `onUserResponseReceived` (Function1) - A callback function that is invoked when the user's response is received. ``` -------------------------------- ### Displaying a Scalebar with a MapView Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.scalebar/-scalebar.html Shows how to integrate a Scalebar composable within a MapView. It demonstrates obtaining necessary map properties like viewpoint, units per dip, and spatial reference from MapView callbacks to configure the Scalebar. ```kotlin var viewpoint: Viewpoint? by remember { mutableStateOf(null) } var unitsPerDip by remember { mutableDoubleStateOf(Double.NaN) } var spatialReference: SpatialReference? by remember { mutableStateOf(null) } // show composable MapView with a Scalebar Box( modifier = modifier.fillMaxSize() ) { MapView( modifier = Modifier.fillMaxSize(), arcGISMap = arcGISMap, onSpatialReferenceChanged = { spatialReference = it }, onUnitsPerDipChanged = { unitsPerDip = it }, onViewpointChangedForCenterAndScale = { viewpoint = it } ) Scalebar( modifier = Modifier .padding(25.dp) .align(Alignment.BottomStart), maxWidth = 175.dp, unitsPerDip = unitsPerDip, viewpoint = viewpoint, spatialReference = spatialReference, ) } ``` -------------------------------- ### Get Layer View State Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-proxy/get-layer-view-state.html Retrieve the layer's LayerViewState. Returns the LayerViewState of the provided layer, or null if the view doesn't contain the given layer or this proxy's TableTopSceneView is not part of the composition. ```APIDOC ## getLayerViewState ### Description Retrieve the layer's LayerViewState. ### Parameters #### Path Parameters * **layer** (Layer) - Description: the layer to retrieve the view state from ### Return the LayerViewState of the provided layer, or null if the view doesn't contain the given layer or this proxy's TableTopSceneView is not part of the composition ### Since 200.6.0 ``` -------------------------------- ### launchCustomTabs Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/launch-custom-tabs.html Launches the custom tabs activity with the provided browser authentication challenge. This method determines the appropriate URL and whether to use a private web browser session based on the type of BrowserAuthenticationChallenge provided. It supports OAuth user sign-in, IAP sign-in, and IAP sign-out challenges. Additionally, if the device does not have a default browser that supports Custom Tabs, it cancels the authentication challenge with a CustomTabsNotFoundException. ```APIDOC ## launchCustomTabs ### Description Launches the custom tabs activity with the provided browser authentication challenge. ### Signature fun Activity.launchCustomTabs(pendingBrowserAuthenticationChallenge: BrowserAuthenticationChallenge) ### Receiver an Activity used to launch the CustomTabsIntent. ### Parameters - **pendingBrowserAuthenticationChallenge** (BrowserAuthenticationChallenge) - The BrowserAuthenticationChallenge containing the necessary information to complete the authentication process. ### Throws - CustomTabsNotFoundException: If the device does not have a default browser that supports Custom Tabs. ``` -------------------------------- ### SceneViewProxy Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-scene-view-proxy/index.html Initializes a new instance of the SceneViewProxy class. A one-to-one relationship should be maintained between a SceneViewProxy and a composable SceneView. ```APIDOC ## SceneViewProxy() ### Description Initializes a new instance of the SceneViewProxy class. This proxy is used to perform operations on a composable SceneView. It's crucial that there's a one-to-one relationship between a SceneViewProxy and its associated composable SceneView, and operations should only be attempted when the SceneView is part of the composition. ### Constructor `SceneViewProxy()` ``` -------------------------------- ### Initializing Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-initialization-status/index.html Indicates that the state object is currently in the process of being initialized. ```APIDOC data object Initializing : InitializationStatus The state object is initializing. ``` -------------------------------- ### fieldOfViewDistortionRatio Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-proxy/field-of-view-distortion-ratio.html Gets or sets the ratio indicating vertical field of view distortion. A value less than 1.0 stretches visuals taller, while a value greater than 1.0 shrinks them shorter. The default is 1.0, and null means it's undetermined. ```APIDOC ## fieldOfViewDistortionRatio ### Description The ratio indicates how much the vertical field of view is distorted. A distortion factor less than 1.0 causes the visuals to be stretched taller in comparison to their width. A distortion factor greater than 1.0 causes the visuals to be shrunk shorter in comparison to their width. The default value is 1.0. A null value represents that it is currently undetermined. ### Property - **fieldOfViewDistortionRatio** (Double?): The distortion ratio of the vertical field of view. ``` -------------------------------- ### Display SceneView with Elevation and Viewpoint Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-scene-view.html Use this snippet to display a SceneView with a configured elevation surface and an initial camera viewpoint. Ensure all necessary imports are included. ```kotlin import androidx.compose.foundation.layout.fillMaxSize import androidx.compose.runtime.Composable import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.ui.Modifier import com.arcgismaps.Color import com.arcgismaps.data.ServiceFeatureTable import com.arcgismaps.geometry.Point import com.arcgismaps.geometry.SpatialReference import com.arcgismaps.mapping.ArcGISMap import com.arcgismaps.mapping.ArcGISScene import com.arcgismaps.mapping.ArcGISTiledElevationSource import com.arcgismaps.mapping.BasemapStyle import com.arcgismaps.mapping.Surface import com.arcgismaps.mapping.Viewpoint import com.arcgismaps.mapping.layers.FeatureLayer import com.arcgismaps.mapping.symbology.SimpleLineSymbol import com.arcgismaps.mapping.symbology.SimpleLineSymbolStyle import com.arcgismaps.mapping.symbology.SimpleRenderer import com.arcgismaps.mapping.view.Camera import com.arcgismaps.toolkit.geoviewcompose.MapView import com.arcgismaps.toolkit.geoviewcompose.SceneView fun main() { //sampleStart // Display a SceneView with an elevation surface and an initial viewpoint // add base surface for elevation data val elevationSource = ArcGISTiledElevationSource( uri = "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer" ) val surface = Surface().apply { elevationSources.add(elevationSource) // add an exaggeration factor to increase the 3D effect of the elevation. elevationExaggeration = 2.5f } val cameraLocation = Point( x = -118.794, y = 33.909, z = 5330.0, spatialReference = SpatialReference.wgs84() ) val camera = Camera( locationPoint = cameraLocation, heading = 355.0, pitch = 72.0, roll = 0.0 ) // create a scene to display the elevation source val scene by remember { mutableStateOf(ArcGISScene(BasemapStyle.ArcGISImagery).apply { baseSurface = surface initialViewpoint = Viewpoint(cameraLocation, camera) }) } // display the Composable SceneView SceneView( scene, modifier = Modifier.fillMaxSize(), ) //sampleEnd } ``` -------------------------------- ### FloorSite Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-floor-filter-selection/-type/-floor-site/index.html Constructs a new FloorSite instance. ```APIDOC ## FloorSite Constructor ### Description Constructs a new FloorSite instance. ### Signature ```kotlin constructor(site: FloorSite) ``` ### Parameters * **site** (FloorSite) - The FloorSite object to initialize with. ``` -------------------------------- ### MapViewProxy Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-map-view-proxy/index.html Creates a new instance of MapViewProxy. This should be done before the associated composable MapView enters the composition. ```APIDOC ## MapViewProxy() ### Description Constructs a new MapViewProxy. ### Constructor MapViewProxy() ``` -------------------------------- ### FailedToInitialize Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-status/index.html The WorldScaleSceneView failed to initialize. The error property contains the error that caused the failure. ```APIDOC data class FailedToInitialize : WorldScaleSceneViewStatus The WorldScaleSceneView failed to initialize. The error property contains the error that caused the failure. ``` -------------------------------- ### ByCenterAndScale Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-viewpoint-persistence/-by-center-and-scale/index.html Initializes a new instance of the ByCenterAndScale class. ```APIDOC ## ByCenterAndScale() ### Description Initializes a new instance of the ByCenterAndScale class. ### Constructor `constructor()` ``` -------------------------------- ### ClientCertificateChallenge Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/-client-certificate-challenge/index.html Constructs a new ClientCertificateChallenge. ```APIDOC constructor(keyChainAliasCallback: KeyChainAliasCallback, onCancel: () -> Unit) ``` -------------------------------- ### Initialized Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-initialization-status/index.html Indicates that the state object has been successfully initialized and is ready for use. ```APIDOC data object Initialized : InitializationStatus The state object is initialized and ready to use. ``` -------------------------------- ### initializationStatus Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.offline/-offline-map-state/initialization-status.html The status of the initialization of the state object. Available since version 200.8.0. ```APIDOC ## initializationStatus ### Description The status of the initialization of the state object. ### Property `val initializationStatus: State` ### Since 200.8.0 ``` -------------------------------- ### rememberFlyoverSceneViewProxy Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/remember-flyover-scene-view-proxy.html Creates and remembers a `FlyoverSceneViewProxy` with the specified initial location and heading. ```APIDOC ## rememberFlyoverSceneViewProxy ### Description Creates and remembers a `FlyoverSceneViewProxy`. ### Signature ```kotlin @Composable fun rememberFlyoverSceneViewProxy(location: Point, heading: Double): FlyoverSceneViewProxy ``` ### Parameters #### `location` - **Type**: `Point` - **Description**: The camera's origin location. #### `heading` - **Type**: `Double` - **Description**: The camera heading. ### Returns - **Type**: `FlyoverSceneViewProxy` - **Description**: An instance of `FlyoverSceneViewProxy`. ``` -------------------------------- ### ByBoundingGeometry Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-viewpoint-persistence/-by-bounding-geometry/index.html Initializes a new instance of the ByBoundingGeometry class. ```APIDOC ## ByBoundingGeometry() ### Description Initializes a new instance of the ByBoundingGeometry class. ### Constructor ByBoundingGeometry() ``` -------------------------------- ### FlyoverSceneViewProxy Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-flyover-scene-view-proxy/-flyover-scene-view-proxy.html Initializes a new FlyoverSceneViewProxy. When instantiating this class from a composable, use rememberFlyoverSceneViewProxy to automatically remember the proxy. ```APIDOC ## FlyoverSceneViewProxy constructor(location: Point, heading: Double) ### Description Initializes a new FlyoverSceneViewProxy with the specified camera origin location and heading. ### Parameters #### Path Parameters - **location** (Point) - Required - The camera's origin location. - **heading** (Double) - Required - The camera heading. ### Since 200.8.0 ``` -------------------------------- ### TraceState Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/index.html Initializes a new instance of the TraceState class. ```APIDOC constructor( arcGISMap: ArcGISMap, graphicsOverlay: GraphicsOverlay, mapViewProxy: MapViewProxy) ``` -------------------------------- ### FailedToInitialize Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-initialization-status/index.html Indicates that the state object failed to initialize, providing the error that occurred. ```APIDOC data class FailedToInitialize(val error: Throwable) : InitializationStatus The state object failed to initialize. ``` -------------------------------- ### FailedToInitialize Properties Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-initialization-status/-failed-to-initialize/index.html Provides access to the error that caused the initialization to fail. ```APIDOC ## Properties ### error Link copied to clipboard ```kotlin val error: Throwable ``` ### Description The `Throwable` object representing the error encountered during initialization. This can be used for debugging or handling the failure. ``` -------------------------------- ### Unavailable Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-vps-availability/index.html VPS is not available at the requested location. ```APIDOC data object Unavailable : WorldScaleVpsAvailability VPS is not available at the requested location. ``` -------------------------------- ### BasemapGalleryItem(basemapStyleInfo: BasemapStyleInfo) Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.basemapgallery/-basemap-gallery-item/-basemap-gallery-item.html Constructs a BasemapGalleryItem using BasemapStyleInfo. If the provided BasemapStyleInfo has a thumbnail, it will be used; otherwise, a default thumbnail will be applied. ```APIDOC ## BasemapGalleryItem(basemapStyleInfo: BasemapStyleInfo) ### Description Construct a BasemapGalleryItem with a BasemapStyleInfo. If the BasemapStyleInfo has a thumbnail, this is used for the thumbnail otherwise a default thumbnail is used. ### Parameters - **basemapStyleInfo** (BasemapStyleInfo) - The BasemapStyleInfo to use for constructing the item. ``` -------------------------------- ### Initializing State Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-table-top-scene-view-status/-initializing/index.html Represents the state where the TableTopSceneView is initializing. During this phase, AR capabilities are checked, and permissions are verified before the view becomes ready for interaction. ```APIDOC ## Initializing data object Initializing : TableTopSceneViewStatus The TableTopSceneView is initializing. The TableTopSceneView is not ready to be used yet. During this stage, the TableTopSceneView will ensure that the device supports AR and that the necessary permissions are granted. #### Since 200.6.0 ``` -------------------------------- ### Initializing State Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-initialization-status/-initializing/index.html The `Initializing` data object is part of the `InitializationStatus` sealed class, representing the state where the Indoor Location component is actively initializing. ```APIDOC ## Initializing data object Initializing : InitializationStatus ### Description The state object is initializing. ### Since 200.6.0 ``` -------------------------------- ### Initializing State Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-status/-initializing/index.html This state indicates that the WorldScaleSceneView is in the process of initializing. It is not yet ready for interaction. This phase includes checks for AR support and necessary permission grants. ```APIDOC data object Initializing : WorldScaleSceneViewStatus The WorldScaleSceneView is initializing. The WorldScaleSceneView is not ready to be used yet. During this stage, the WorldScaleSceneView will ensure that the device supports AR and that the necessary permissions are granted. #### Since 200.7.0 ``` -------------------------------- ### UsernamePasswordChallenge Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/-username-password-challenge/index.html Initializes a new instance of the UsernamePasswordChallenge class. ```APIDOC ## UsernamePasswordChallenge constructor ### Description Initializes a new instance of the `UsernamePasswordChallenge` class. ### Parameters - **url** (String) - The URL for authentication. - **onUsernamePasswordReceived** (Function) - A callback function that receives the username and password. - **cause** (Throwable?) - Optional. The exception that caused this challenge. - **onCancel** (Function) - A callback function to be invoked when the challenge is cancelled. ``` -------------------------------- ### UsernamePasswordChallenge.continueWithCredentials() Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication/-username-password-challenge/index.html Completes the authentication challenge with the provided username and password. ```APIDOC ## continueWithCredentials(username: String, password: String) ### Description Completes the challenge with the credentials. Note that either `continueWithCredentials` or `cancel` can only be called once on a given `UsernamePasswordChallenge` object; further calls will have no effect. ### Parameters - **username** (String) - The username for authentication. - **password** (String) - The password for authentication. ### Returns `Unit` ``` -------------------------------- ### None Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-viewpoint-persistence/index.html The viewpoint is not persisted. ```APIDOC object None : ViewpointPersistence The viewpoint is not persisted. ``` -------------------------------- ### FloorFacility Constructor Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.indoors/-floor-filter-selection/-type/-floor-facility/index.html Constructs a new FloorFacility instance. ```APIDOC ## Constructors ### FloorFacility Link copied to clipboard constructor(facility: FloorFacility) ``` -------------------------------- ### Initializing State Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.offline/-initialization-status/-initializing/index.html The `Initializing` data object is part of the `InitializationStatus` sealed class and signifies that the SDK is currently undergoing its initialization process. ```APIDOC ## Initializing data object Initializing : InitializationStatus ### Description The state object is initializing. ### Since 200.8.0 ``` -------------------------------- ### LocalSceneView Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.geoviewcompose/-local-scene-view.html Displays a local SceneView with customizable parameters and callbacks. ```APIDOC ## LocalSceneView Displays a local SceneView with customizable parameters and callbacks. ### Parameters - **scene** (ArcGISScene) - The ArcGISScene to be rendered by this composable LocalSceneView. - **modifier** (Modifier) - Modifier to be applied to the composable LocalSceneView. - **localSceneViewProxy** (LocalSceneViewProxy) - The LocalSceneViewProxy to associate with the composable LocalSceneView. - **onViewpointChangedForCenterAndScale** (Function1) - Lambda invoked when the viewpoint changes, passing a viewpoint type of ViewpointType.CenterAndScale. - **onViewpointChangedForBoundingGeometry** (Function1) - Lambda invoked when the viewpoint changes, passing a viewpoint type of ViewpointType.BoundingGeometry. - **interactionOptions** (LocalSceneViewInteractionOptions) - The LocalSceneViewInteractionOptions used by this composable LocalSceneView. - **selectionProperties** (SelectionProperties) - The SelectionProperties used by the composable LocalSceneView. - **isAttributionBarVisible** (Boolean) - True if attribution bar is visible in the composable LocalSceneView, false otherwise. - **onAttributionTextChanged** (Function1) - Lambda invoked when the attribution text of the composable LocalSceneView has changed. - **onAttributionBarLayoutChanged** (Function1) - Lambda invoked when the attribution bar's position or size changes. - **onNavigationChanged** (Function1) - Lambda invoked when the navigation status of the composable LocalSceneView has changed. - **onSpatialReferenceChanged** (Function1) - Lambda invoked when the spatial reference of the composable LocalSceneView has changed. - **onLayerViewStateChanged** (Function1) - Lambda invoked when the composable LocalSceneView's layer view state is changed. - **onInteractingChanged** (Function1) - Lambda invoked when the user starts and ends interacting with the composable LocalSceneView. - **onCurrentViewpointCameraChanged** (Function1) - Lambda invoked when the viewpoint camera of the composable LocalSceneView has changed. - **onRotate** (Function1) - Lambda invoked when a user performs a rotation gesture on the composable LocalSceneView. - **onScale** (Function1) - Lambda invoked when a user performs a pinch gesture on the composable LocalSceneView. - **onUp** (Function1) - Lambda invoked when the user removes all their pointers from the composable LocalSceneView. - **onDown** (Function1) - Lambda invoked when the user first presses on the composable LocalSceneView. - **onSingleTapConfirmed** (Function1) - Lambda invoked when the user taps once on the composable LocalSceneView. - **onDoubleTap** (Function1) - Lambda invoked the user double taps on the composable LocalSceneView. - **onLongPress** (Function1) - Lambda invoked when a user holds a pointer on the composable LocalSceneView. - **onTwoPointerTap** (Function1) - Lambda invoked when a user taps two pointers on the composable LocalSceneView. - **onPan** (Function1) - Lambda invoked when a user drags a pointer or pointers across composable LocalSceneView. - **onInteractiveZooming** (Function1) - Lambda invoked when a user performs a pinch or double-tap-drag gesture on the composable LocalSceneView. - **onDrawStatusChanged** (Function1) - Lambda invoked when the draw status of the composable LocalSceneView changes. - **canFocus** (Boolean) - Pass true if the LocalSceneView should receive focus. Note that specifying a modifier property `Modifier.focusProperties { canFocus = true/false }` on the LocalSceneView composable has no effect. - **onGeoModelErrorChanged** (Function1) - Lambda invoked when the GeoModel error state of the composable LocalSceneView changes. - **onCriticalErrorChanged** (Function1) - Lambda invoked when the critical error state of the composable LocalSceneView has changed. - **onWarningsChanged** (Function1) - Lambda invoked when the warning status of the composable LocalSceneView is changed. - **content** (Function0) - The content of the composable LocalSceneView. ``` -------------------------------- ### checkVpsAvailability (specific location) Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.ar/-world-scale-scene-view-proxy/index.html Queries the availability of VPS at a provided latitude and longitude to improve tracking accuracy. ```APIDOC ## checkVpsAvailability(latitude, longitude) ### Description Query the availability of VPS at the provided location. Where VPS is available, the accuracy of WorldScaleTrackingMode.Geospatial will be improved. ### Parameters #### Path Parameters - **latitude** (Double) - The latitude of the location. - **longitude** (Double) - The longitude of the location. ### Function Signature suspend fun checkVpsAvailability( latitude: Double, longitude: Double): Result ``` -------------------------------- ### initializationStatus Source: https://developers.arcgis.com/kotlin/toolkit-api-reference/arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.utilitynetworks/-trace-state/initialization-status.html The status of the initialization of the state object. Indicates whether the trace state has been successfully initialized, is currently initializing, or has failed to initialize. ```APIDOC ## initializationStatus ### Description The status of the initialization of the state object. ### Property `val initializationStatus: State` ### Since 200.6.0 ```