ArcGISMap

class ArcGISMap : GeoModel, JsonSerializable

The map contains layers and additional properties and can be displayed in a MapView.

Constructors

Link copied to clipboard
fun ArcGISMap()

Creates a map.

Link copied to clipboard
fun ArcGISMap(basemap: Basemap)

Create a map with basemap.

Link copied to clipboard
fun ArcGISMap(basemapStyle: BasemapStyle)

Creates a map with a basemap style.

Link copied to clipboard
fun ArcGISMap(item: Item)

Creates a map with an item.

Link copied to clipboard
fun ArcGISMap(spatialReference: SpatialReference?)

Creates a map with spatial reference.

Link copied to clipboard
fun ArcGISMap(uri: String)

Creates a map based on the given URL to a web map. A PortalItem will be created to reference the web map and accessible through ArcGISMap.getItem(). The supported URL formats are:

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open override fun clone(): ArcGISMap

Clones the ArcGISMap.

Link copied to clipboard
fun equals(otherGeoModel: GeoModel): Boolean

Tests if this object is equal to a second GeoModel object.

Returns a list of all the UtilityNamedTraceConfiguration objects referenced by UtilityNetwork's Map. An empty array will be returned if the UtilityNetwork does not belong to the Map or if the Map does not contain any UtilityNamedTraceConfiguration objects.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

Link copied to clipboard
fun setBasemap(basemap: Basemap?)

Optional layers in a map or scene that show background information — roads, landmarks, and so on — to help orient the user of the map or scene. Typically image tile or vector tile layer types. Basemaps can be composed of different layers organized in Basemap.baseLayers (displayed beneath other layers) and {@link Basemap.referenceLayers (displayed on top of other layers). You can use ready-to-use basemaps, style your own with the ArcGIS Vector Tile Style Editor, or create and publish your own with ArcGIS Pro.

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.

Properties

Link copied to clipboard
var backgroundColor: Color?

The background color of the map. This value determines the color to be displayed behind the map. This color will be displayed in transparent areas of the map as well as areas where there is no basemap or operational data.

Link copied to clipboard
val basemap: StateFlow<Basemap?>

Optional layers in a map or scene that show background information—roads, landmarks, and so on—to help orient the user of the map or scene. Typically image tile or vector tile layer types. Basemaps can be composed of different layers organized in Basemap.baseLayers (displayed beneath other layers) and Basemap.referenceLayers (displayed on top of other layers). You can use ready-to-use basemaps, style your own with the ArcGIS Vector Tile Style Editor, or create and publish your own with ArcGIS Pro.

Link copied to clipboard
val bookmarks: MutableList<Bookmark>
Link copied to clipboard
var floorDefinition: GeoModelFloorDefinition?
Link copied to clipboard
val floorManager: FloorManager?
Link copied to clipboard
val geotriggersInfo: GeotriggersInfo
Link copied to clipboard
var initialViewpoint: Viewpoint?
Link copied to clipboard
var item: Item?
Link copied to clipboard
var loadSettings: LoadSettings
Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard
var maxExtent: Envelope?
Link copied to clipboard
var maxScale: Double

The maximum scale for the map. Will be zero if the map is not loaded or if there is no maximum scale and the user can zoom in indefinitely.

Link copied to clipboard
var minScale: Double

The minimum scale for the map. Will be zero if the map is not loaded or if there is no minimum scale and the user can zoom out indefinitely.

Link copied to clipboard
val offlineSettings: OfflineSettings?
Link copied to clipboard
val operationalLayers: MutableList<Layer>
Link copied to clipboard
var referenceScale: Double

The reference scale for the map. The reference scale of the map is the scale at which a client should view the map for the feature symbols and text to appear at their authored size. If the client changes the viewing scale, then feature symbols and text will grow or shrink to keep a consistent size on the map (not the screen). This only happens if the reference scale is greater than zero and for feature layers that have scaleSymbols set to true, otherwise the symbols and text stay at their authored size. The reference scale will be zero if the map is not loaded or if there is no reference scale and the symbols and text should appear at default size regardless of the viewing scale. This property is intended to be used for new Map objects, that will have layers attached that expect a reference scale. Subsequent updates to the map.referenceScale will cause a redraw of all layers that use the referenceScale, and possible knock-on redraw of other layers that depend on them (e.g. dynamic labels that need to re-position to avoid overlaps)

Link copied to clipboard
val spatialReference: SpatialReference?
Link copied to clipboard
val tables: MutableList<FeatureTable>
Link copied to clipboard

A collection of transportation network datasets defined for the map or scene. Map and Scene authors can use ArcGIS Pro to create mobile map or scene packages containing maps and scenes that include transportation networks. If so, this property will be populated with the collection of TransportationNetworkDataset objects.

Link copied to clipboard
open override val unknownJson: Map<String, Any>

Unknown data from the source JSON. Unknown JSON is a dictionary of values that was in the source JSON but was unparsed by this API.

Link copied to clipboard
open override val unsupportedJson: Map<String, Any>

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values that are supported by web maps, but not exposed through this API.

Link copied to clipboard
val uri: String?

The URI for the map.

Link copied to clipboard
val utilityNetworks: MutableList<UtilityNetwork>
Link copied to clipboard
val version: String

The version of the ArcGISMap or ArcGISScene when it is loaded. The version of a newly created ArcGISMap or ArcGISScene is empty. The version that the map or scene is saved to might differ from the version it was opened at. The version saved depends on the version of the API.