ArcGISMapServiceSublayerInfo

The metadata of an ArcGIS map service sublayer. ArcGISMapServiceSublayerInfo provides basic information about an individual map image sublayer (or map service sublayer), such as the description, geometry type, drawing information, fields, extent, capabilities, and layer type. You can obtain a collection of map image sublayers from ArcGISMapImageLayer.mapImageSublayers and obtain the ArcGISMapServiceSublayerInfo using the ArcGISSublayer.mapServiceSublayerInfo.

The ArcGISMapServiceSublayerInfo.sublayerType specifies if the map image sublayer is a feature layer, table, raster layer, or group layer. If the sublayer type is ArcGISMapServiceSublayerType.GroupLayer, it will have its own collection of sublayers that you can access using ArcGISSublayer.sublayers. If one of these sublayers is a group layer it will also contain a collection of sublayers, and so on.

Since

200.1.0

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The sublayer's attribution.

Link copied to clipboard

A flag indicating whether the sublayer supports modifying its renderer and/or its data source. False if an error occurs.

Link copied to clipboard

A flag indicating whether the text and symbols on the sublayer will change as the map scale varies. False if an error occurs.

Link copied to clipboard

The sublayer's capabilities.

Link copied to clipboard

The sublayer's default subtype code.

Link copied to clipboard

True if the sublayer is visible by default. False if an error occurs.

Link copied to clipboard

The sublayer's definition expression. The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. For more information, see the ArcGIS Blog article https://www.esri.com/arcgis-blog/products/api-rest/data-management/querying-feature-services-date-time-queries/.

Link copied to clipboard

The sublayer's description.

Link copied to clipboard

The sublayer's display field name.

Link copied to clipboard

The sublayer's drawing info.

Link copied to clipboard

The sublayer's effective max scale.

Link copied to clipboard

The sublayer's effective min scale.

Link copied to clipboard

The sublayer's extent.

Link copied to clipboard

The sublayer's feature subtypes.

Link copied to clipboard

The sublayer's feature types.

Link copied to clipboard

The sublayer's field definitions.

Link copied to clipboard

The sublayer's geometry type.

Link copied to clipboard

True if the sublayer has attachments. False if an error occurs.

Link copied to clipboard

True if the sublayer has labels defined on it. False if an error occurs.

Link copied to clipboard

True if the sublayer has m-values. False if an error occurs.

Link copied to clipboard

True if the sublayer has z-values. False if an error occurs.

Link copied to clipboard

True if the sublayer has versioned data. False if an error occurs.

Link copied to clipboard

The sublayer's max record count.

Link copied to clipboard

The sublayer's max scale.

Link copied to clipboard

The sublayer's min scale.

Link copied to clipboard

The sublayer's ownership based access control.

Link copied to clipboard

The parent layer info. An IdInfo containing the sublayer parent id and name. Will return null if an error occurs or if the sublayer has no parent.

Link copied to clipboard

The sublayer's relationship infos.

Link copied to clipboard

The sublayer's ID.

Link copied to clipboard

The sublayer's name.

Link copied to clipboard

The sublayer info.

Link copied to clipboard

The type of sublayer in the ArcGIS map service. ArcGISMapServiceSublayerType.Unknown if an error occurs.

Link copied to clipboard

The sublayer's subtype field.

Link copied to clipboard

True if the sublayer supports advanced queries such as order by fields. False if an error occurs.

Link copied to clipboard

True if the sublayer supports statistical functions in query operations. False if an error occurs.

Link copied to clipboard

The sublayer's time info.

Link copied to clipboard

The sublayer's type id field name.

Link copied to clipboard
val url: String?

The sublayer's URL.

Link copied to clipboard

A flag indicating whether the sublayer requires the use of standardized queries. Returns true indicates the sublayer requires the use of standardized queries, a value of false indicates otherwise. False if an error occurs.

Link copied to clipboard

The sublayer's version.

Functions

Link copied to clipboard
fun getField(fieldName: String): Field?

Returns the field definition of the given field name.

Inherited functions

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

Convert an object to JSON string.