Package-level declarations

Types

Link copied to clipboard

AnalysisOverlay manages the display of one or more Analyses on a scene view. AnalysisOverlay allows you to group related analyses and control visibility for all members of the collection. A scene view can contain many AnalysisOverlays.

Link copied to clipboard
sealed class AnimationCurve

Control how the map view is moved between positions. Controls how the map view is animated. To play with the easing functions: https://easings.net/.

Link copied to clipboard
sealed class AtmosphereEffect

Visual effect options for a scene view's atmosphere.

Link copied to clipboard
data class AttributionBarLayoutChangeEvent(val view: View, val left: Int, val top: Int, val right: Int, val bottom: Int, val oldLeft: Int, val oldTop: Int, val oldRight: Int, val oldBottom: Int)

Represents information about a change to the attribution bar's position or size.

Link copied to clipboard

A background grid defines the default color and context grid for display behind a map or scene surface. The background grid determines what an empty MapView or scene Surface looks like. An instance of this class can be used to set a default backdrop that an ArcGISMap or ArcGISScene will display on top of.

Link copied to clipboard
class Callout

Draws a callout on a geo view. A callout displays an Android View that contains text and/or other content. It has a leader that points to the location that callout refers to. The body of the callout is a rectangular area with curved corners that contains the content view provided by the application. A thin border line is drawn around the entire callout.

Link copied to clipboard
class Camera

A camera represents an observer's location and their perspective of an ArcGISScene within a SceneView. A Camera object can be thought of as a camera that you look through to see a viewable area of a scene. What you see depends on how you orientate the camera and how far it is above the Surface. A camera has four main configurable properties:

Link copied to clipboard
sealed class CameraController

An base class for all camera controllers.

Link copied to clipboard
sealed class DeviceOrientation

Describes the rotation of the device. Used to match the field of view of the SceneView to the field of view of a camera lens using the lens characteristics and orientation.

Link copied to clipboard
data class DoubleTapEvent(val screenCoordinate: ScreenCoordinate, val mapPoint: Point?)

Represents a double-tap gesture.

Link copied to clipboard
data class DoubleXY(val x: Double, val y: Double)

Represents a two-dimensional point or vector of doubles

Link copied to clipboard
data class DownEvent(val screenCoordinate: ScreenCoordinate, val mapPoint: Point?)

Represents the beginning of a gesture.

Link copied to clipboard
sealed class DrawStatus

The status of drawing in the GeoView. Use this status to determine whether the content of a view is still drawing or drawing is completed. The drawing state of a GeoView can either be DrawStatus.InProgress or DrawStatus.Completed.

Link copied to clipboard

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.

Link copied to clipboard

Support Global Camera navigation. The Globe camera controller provides free roaming camera navigation around the globe.

Link copied to clipboard

A type of GeoElement that has a shape (geometry), symbol, and attributes and can be displayed in a map view or scene view. Graphics are used to represent temporary data that exists for the lifetime of the application. For example, you can:

Link copied to clipboard

Manages a collection of graphics that can be displayed in a map view or scene view. Graphics overlays displays a collection of graphics on top of all the layers (including reference layers) in a map view or scene view. Every map view or scene view can contain a collection of graphics overlays (GeoView.graphicsOverlays), and each graphics overlay can contain a collection of graphics (GraphicsOverlay.graphics). The graphics in the first GraphicsOverlay are drawn first, with subsequent GraphicsOverlay.graphics on top. The GraphicsOverlay.renderer defines the symbology of the GraphicsOverlay.graphics collection.

Link copied to clipboard

The different rendering modes for GraphicsOverlay.

Link copied to clipboard
sealed class Grid

Grid is a base class for MGRSGrid, USNGGrid, UTMGrid and LatitudeLongitudeGrid that represents the display of a coordinate system grid on the map view. It contains all of the common operations and properties that apply to displaying and working with the different grids currently supported. This includes toggling visibility and configuring layout and appearance preferences.

Link copied to clipboard
sealed class GridLabelPosition

A positioning scheme to use when labeling a Grid.

Link copied to clipboard

Identify result containing an overlay and the identified graphics of that overlay. You need to pass this object to identify result functions.

Link copied to clipboard

Identify result containing a layer and the identified elements of that layer. You need to pass this object to identify result functions.

Link copied to clipboard

A frame that, when added to an ImageOverlay, renders an image on top of a scene. An ImageFrame can contain images that do not have georeferencing information. In such cases, location data can be provided to geolocate the image.

Link copied to clipboard

An overlay that contains a frame with an image to display in the view. Currently, this feature is supported in a SceneView (3D) only. The overlay can contain exactly one image at any given time. Multiple overlays, however, can be added and rendered at the same time on the SceneView. An ImageOverlay can be used to quickly render frequently changing images. For example, rendering realtime sensor data, such as weather, where each static image represents a single frame from the radar. In this workflow, images are constantly updated via a new ImageFrame each time new data is available. This provides a fast-refreshing workflow where the underlying images are frequently updated as new data comes in.

Link copied to clipboard

A class containing the state of the GeoView interaction options.

Link copied to clipboard

A grid consisting of east-west lines of latitude and north-south lines of longitude. This class represents graticules--lines showing parallels of latitude and meridians of longitude for the earth.

Link copied to clipboard

The format to use when labeling a LatitudeLongitudeGrid.

Link copied to clipboard

provides access to scene specific properties. Scene properties can be retrieved from the GraphicsOverlay and used to set scene specific properties defining the behavior in 3D.

Link copied to clipboard

The state of a layer in a GeoView. This object allows you to know the current state of a layer in a view.

Link copied to clipboard
sealed class LayerViewStatus

The status of a layer in the GeoView. This status is used to determine whether a layer is displaying in a GeoView or whether it is still loading, not visible, out of scale, or has encountered an error or warning. Each layer can have multiple states at the same time. For example, a layer could be both LayerViewStatus.NotVisible and LayerViewStatus.OutOfScale, or it could be LayerViewStatus.NotVisible and LayerViewStatus.Loading. These multiple states are represented using a flag enumeration.

Link copied to clipboard
sealed class LightingMode

Ambient lighting options for a scene view.

Link copied to clipboard

Manages the display of a device's location in a MapView. Location display can retrieve the device's current location from a LocationDataSource and display it on top of an ArcGISMap. As the device moves, the map view can respond to new locations by updating the position of the location symbol on the display. It can also set the viewpoint when an updated location is received, or automatically pan and rotate the map when the current location, heading, or course changes.

Link copied to clipboard

A location to screen result object. The location to screen result contains a point and visibility.

Link copied to clipboard
data class LongPressEvent(val screenCoordinate: ScreenCoordinate, val mapPoint: Point?)

Represents a long press gesture.

Link copied to clipboard
class MapView(context: Context, attrs: AttributeSet?) : GeoView

A view to render and allow interaction with 2D geographic content from an ArcGISMap on a screen. In a Model View Controller (MVC) architecture, this class represents the View and the Map object represents the Model.

Link copied to clipboard
data class MapViewInteractionOptions(var isEnabled: Boolean = true, var zoomFactor: Double = 2.0, var isFlingEnabled: Boolean = true, var isPanEnabled: Boolean = true, var isZoomEnabled: Boolean = true, var isRotateEnabled: Boolean = true, var snapToNorthThreshold: Double = 7.5, var isMagnifierEnabled: Boolean = false, var allowMagnifierToPan: Boolean = true) : InteractionOptions

A class containing the state of the MapView interaction options.

Link copied to clipboard
class MgrsGrid : Grid

A class that represents the display of the Military Grid Reference System (MGRS) on the map view. The military grid reference system is the geocoordinate standard used by various militaries for locating points on the earth. The MGRS grid is derived from the Universal Transverse Mercator (UTM) grid system and the universal polar stereographic (UPS) grid system, but uses a different labeling convention. MGRS is used for the entire earth.

Link copied to clipboard
sealed class MgrsGridLabelUnit

The unit to use when labeling a MgrsGrid.

Link copied to clipboard
typealias Offset = DoubleXY

A typealias for DoubleXY to represent a difference in (x,y) coordinates.

Link copied to clipboard

Support Orbital Camera navigation around a stationary or moving point GeoElement object. Orbit camera controller provides orbital navigation around a point object.

Link copied to clipboard

A camera controller that supports orbital camera navigation around a stationary point in a SceneView. An orbit camera controller locks navigation around a target point. The camera can orbit around the target point but always focuses directly on the point. To activate the controller, set the controller on the SceneView.cameraController property. Once applied, the target point cannot be changed and setting the viewpoint on the SceneView is disabled. In this mode, the user can rotate around and zoom in and out from the target point.

Link copied to clipboard
data class PanChangeEvent

Represents part of a pan gesture.

Link copied to clipboard

Represents part of a rotation gesture.

Link copied to clipboard
data class ScaleChangeEvent

Represents part of a scale gesture.

Link copied to clipboard
sealed class SceneLayerDataType

Identifies data type contained within a scene layer.

Link copied to clipboard

Various modes of visibility that can be applied to a location_to_screen_result.

Link copied to clipboard
class SceneView(context: Context, attrs: AttributeSet?) : GeoView

A scene view object. The scene view is how a scene is displayed on a screen. The scene view will be updated when the scene changes.

Link copied to clipboard
data class SceneViewInteractionOptions(var isEnabled: Boolean = true, var zoomFactor: Double = 2.0, var isFlingEnabled: Boolean = true, var isPanEnabled: Boolean = true, var isZoomEnabled: Boolean = true, var isRotateEnabled: Boolean = true) : InteractionOptions

A class containing the state of the SceneView interaction options.

Link copied to clipboard

The options for setting the Scene tiling scheme.

Link copied to clipboard

A typealias for DoubleXY to represent (x,y) coordinates on the screen.

Link copied to clipboard

A selection properties.

Link copied to clipboard
data class SingleTapConfirmedEvent(val screenCoordinate: ScreenCoordinate, val mapPoint: Point?)

Represents a single tap gesture.

Link copied to clipboard
sealed class SpaceEffect

Determines whether outer space is black with stars or transparent.

Link copied to clipboard
sealed class SurfacePlacement

The options for handling altitude values.

Link copied to clipboard

A class for holding a translation and quaternion array. This is used for camera movement while preventing gimbal lock.

Link copied to clipboard

Support camera navigation by using TransformationMatrix. Transformation Matrix camera controller provides navigation by using TransformationMatrix to control the camera's location and rotation. You need to pass this object to all TransformationMatrixCameraController functions. This can be used with transformation matrices produced by AR APIs like ARKit and ARCore.

Link copied to clipboard
data class TwoPointerTapEvent(val screenMidpoint: ScreenCoordinate, val mapMidpoint: Point?)

Represents a two-pointer tap gesture.

Link copied to clipboard
data class UpEvent(val screenCoordinate: ScreenCoordinate, val mapPoint: Point?)

Represents the end of a gesture.

Link copied to clipboard
class UsngGrid : Grid

A class that represents the display of the United States National Grid (USNG) on the map view. The United States National Grid (USNG) is a point reference system of grid references commonly used in the United States. It provides a nationally consistent language of location in a user friendly format. It is similar in design to the national grid reference systems used throughout other nations. The USNG was developed by the Federal Geographic Data Committee.

Link copied to clipboard
sealed class UsngGridLabelUnit

The unit to use when labeling an UsngGrid.

Link copied to clipboard
class UtmGrid : Grid

A class that represents the display of the Universal Transverse Mercator (UTM) coordinate system grid on the map view. The Universal Transverse Mercator (UTM) conformal projection uses a 2-dimensional Cartesian coordinate system to give locations on the surface of the Earth. Like the traditional method of latitude and longitude, it is a horizontal position representation, i.e. it is used to identify locations on the Earth independently of vertical position. However, it differs from that method in several respects.

Link copied to clipboard

A typealias for DoubleXY to represent (x,y) velocity.

Link copied to clipboard

A view label properties object. This is used to change labels for a view.

Link copied to clipboard
sealed class WrapAroundMode

Should wrap around be used or not. Allows you to change the wrap around mode.

Properties

Link copied to clipboard

The zero vector.