Package-level declarations

Types

Link copied to clipboard

A map is a container for layers. Use a map together with a MapView to display layers of geographic data in 2D. ArcGISMap contains layers of mapping data and information such as basemaps, popups, renderers, and labels which define the map's capabilities. You can access ArcGISMap content directly or visualize the map in a MapView.

Link copied to clipboard

A scene is a container for layers. You use a scene together with a SceneView to display layers of geographic data in 3D. ArcGISScene contains layers of mapping data and information such as elevation data, renderers, and labels which define the scene's capabilities. You can access ArcGISScene content directly or, more commonly, visualize the scene in a SceneView.

Link copied to clipboard

An elevation source based on a tiled ArcGIS image service containing elevation data. An ArcGIS tiled elevation source helps visualize maps and layers in 3D by providing a surface that layers may be draped or offset from.

Link copied to clipboard

A basemap is a non-editable layer that provides background, or reference information, in your map or scene. A basemap provides a background of geographical context for the content you display in a map or scene. It provides a visual reference to help orient users and a framework on which you can overlay operational layers, perform analysis, and visualize geographic information. The content of a basemap is typically static and does not change frequently.

Link copied to clipboard
sealed class BasemapStyle

The list of basemap styles. This is used to determine which basemap to use. These basemaps are secured and require either an APIKey or named user to access them.

Link copied to clipboard

Information about a given BasemapStyle available from the https://developers.arcgis.com/rest/basemap-styles/, including human-readable name, thumbnail url and customization options. The Basemap Style Service[https://developers.arcgis.com/rest/basemap-styles/] can be queried to access information about a given BasemapStyle. The service provides information about each style, including the human-readable name of the style, the url for the style's preview image (a.k.a thumbnail), and different customization options available with each BasemapStyle This read-only class collates the information available for each BasemapStyle into a common data structure and makes the information easily accessible to API users.

Link copied to clipboard

Information about a language that can be used to customize labels on a basemap. To request that labels on a Basemap are displayed in a given language, set the value of the BasemapStyleLanguageInfo.languageCode property to BasemapStyleParameters.specificLanguage.

Link copied to clipboard

Options for setting the language on a Basemap created from a BasemapStyle.

Link copied to clipboard

Provides parameters for creating a Basemap from a BasemapStyle. BasemapStyleParameters allows you to set preferences, such as the language to use for basemap labels, when creating a Basemap that suits your application.

Link copied to clipboard

Esri's https://developers.arcgis.com/rest/basemap-styles/.

Link copied to clipboard

Represents the service metadata for the https://developers.arcgis.com/rest/basemap-styles/. The BasemapStylesServiceInfo can be obtained from a loaded BasemapStylesService. The service info provides information for browsing the contents of the service.

Link copied to clipboard
class Bookmark

A geographic or time location for quick navigate.

Link copied to clipboard

Represents an image of a chart.

Link copied to clipboard

Represents the options used to generate a ChartImage.

Link copied to clipboard
sealed class ChartImageStyle

Constants indicating the style used to generate a ChartImage. The background of the generated chart being transparent, the chart image style controls only the text color and the line colors.

Link copied to clipboard
sealed class ElevationSource : Loadable

Elevation sources provide a surface on which data can be draped or offset from. This is the base class for elevation sources, such as ArcGISTiledElevationSource and RasterElevationSource. To utilize an elevation source in a scene's surface, create the elevation source and add it to the scene's Surface.elevationSources collection. The combination of elevation sources within the Surface generates a rendering surface on which data can be draped or offset from.

Link copied to clipboard

Expiration details, that indicate whether a given package is out of date. Expiration details can indicate that the package in question:

Link copied to clipboard
sealed class ExpirationType

Enumerates the possible types of expiration.

Link copied to clipboard
interface GeoElement

An abstract representation of geographic entities in a map, scene, map view or scene view. Each geographic entity can possess geometry, to describe the location and shape of the entity, and a set of attributes to provide information about the real-world entity it represents. For example, a feature in a feature layer, a graphic in a graphics overlay, and a raster cell in a raster layer are represented by the Feature, Graphic, and RasterCell classes. Each class inherits from GeoElement.

Link copied to clipboard
sealed class GeoModel : Loadable

A base class for ArcGISMap and ArcGISScene that contains layers and properties and can be displayed in a GeoView. This base class represents the model in a model-view-controller (MVC) architecture, while the GeoView represents the view. To display a map or scene to the user, pass GeoModel to its appropriate GeoView, as follows:

Link copied to clipboard
sealed class HttpOperation

The list of available HTTP operations. This is used to determine a request's HTTP operation.

Link copied to clipboard
sealed class Item

An object that represents an item.

Link copied to clipboard

This class allows you to specify how the map/scene should treat feature layers. Represents load settings.

Link copied to clipboard
class LocalItem : Item

An object that represents a local item.

Link copied to clipboard
sealed class LocalItemType

An enumeration of various types of local items.

Link copied to clipboard

A mobile map package. Mobile map packages allow you to work with maps on a mobile device. A mobile map package contains all of the files necessary to work with your maps and is stored on a device as either:

Link copied to clipboard

A mobile scene package. Mobile scene packages allow you to work with 3D scenes on a mobile device. A mobile scene package contains all of the files necessary to work with your scenes and is stored on a device as either:

Link copied to clipboard

The list of options for constraining navigation based on the surface elevation. Used to constrain all forms of camera navigation to the elevation surface.

Link copied to clipboard

Represents settings in an online web map which the author has configured for offline use. Offline settings can be configured by a web map author to provide default values which are appropriate for taking a map offline. Applications which take the map offline can choose to ignore these offline settings when setting parameters for an OfflineMapTask.

Link copied to clipboard
@Serializable(with = PortalItemSerializer::class)
class PortalItem : Item, JsonSerializable, Loadable

An item (unit of content) stored in an ArcGIS portal, such as a layer, web map, package file, or map service. ArcGIS portals support various types of portal items, including:

Link copied to clipboard

An object that identifies the supported formats in which query results can be returned from a feature service.

Link copied to clipboard

An elevation source based on raster elevation files. A raster elevation source helps visualize maps and layers in 3D by providing a surface that layers may be draped or offset from. You can create a raster elevation source from a collection of raster elevation files, such as Digital Terrain Elevation Data (DTED) format files. See Raster To DTED[https://pro.arcgis.com/en/pro-app/latest/tool-reference/data-management/raster-to-dted.htm] for more information about creating raster elevation files based on the DTED tiling scheme.

Link copied to clipboard

The surface contains elevation sources and defines a surface upon which layers and overlays can be draped. The surface is used to represent the ground in a scene. It is comprised of a collection of elevation sources (ElevationSource) which are combined in the scene to generate the surface.

Link copied to clipboard

Represents a span of time between a start time and end time. To create a time extent which represents an instant in time set the start time and end time to the same time value. The TimeExtent is returned in the meta-data for time-aware services and layers. It is often used to create a time slider ranging from a start time to an end time.

Link copied to clipboard
class TimeValue

Defines a time offset or interval for any time related classes.

Link copied to clipboard

Defines the visible area of a GeoModel that is displayed in a GeoView on a user's screen. In a MapView, the bounding extent of a geometry or the map's center point and scale can define the map view's two-dimensional Viewpoint.

Link copied to clipboard
sealed class ViewpointType

Different types of Viewpoint.

Link copied to clipboard
class Worldview

Defines a valid representation of a disputed boundary (a.k.a worldview) on a BasemapStyleParameters object. For more information see the boundary disputes section[https://developers.arcgis.com/rest/basemap-styles/#boundary-disputes] of the basemap styles service API reference.