Represents a sublayer in a KMLLayer.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | Description for the KML sublayer. more details | KMLSublayer | |
Number | The id for the KML sublayer. more details | KMLSublayer | |
KMLLayer | The KMLLayer to which the sublayer belongs. more details | KMLSublayer | |
Object | Network link info for the current layer. more details | KMLSublayer | |
KMLSublayer|KMLLayer | The parent layer to which the sublayer belongs. more details | KMLSublayer | |
Object | The raw KML data for this sublayer, in JSON format, as returned by the KML utility service. more details | KMLSublayer | |
Collection<KMLSublayer> | A collection of KMLSublayers. more details | KMLSublayer | |
String | The title of the KML sublayer used to identify it in places such as the LayerList and Legend widgets. more details | KMLSublayer | |
Boolean | Indicates if the sublayer is visible in the view. more details | KMLSublayer |
Property Details
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description String
-
Description for the KML sublayer.
-
id Number
-
The id for the KML sublayer.
-
networkLink Object
-
Network link info for the current layer. A link info object with properties that describe the network link.
-
Since: ArcGIS Maps SDK for JavaScript 4.27
-
The parent layer to which the sublayer belongs.
-
sourceJSON ObjectSince: ArcGIS Maps SDK for JavaScript 4.14
-
The raw KML data for this sublayer, in JSON format, as returned by the KML utility service.
-
sublayers Collection<KMLSublayer>
-
A collection of KMLSublayers.
-
title String
-
The title of the KML sublayer used to identify it in places such as the LayerList and Legend widgets.
-
visible Boolean
-
Indicates if the sublayer is visible in the view.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | KMLSublayer | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | KMLSublayer |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
json
parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.Parameterjson ObjectA JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.