KMLSublayer

AMD: require(["esri/layers/support/KMLSublayer"], (KMLSublayer) => { /* code goes here */ });
ESM: import KMLSublayer from "@arcgis/core/layers/support/KMLSublayer.js";
Class: esri/layers/support/KMLSublayer
Inheritance: KMLSublayer Accessor
Since: ArcGIS Maps SDK for JavaScript 4.5

Represents a sublayer in a KMLLayer.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

Description for the KML sublayer.

KMLSublayer

The id for the KML sublayer.

KMLSublayer

The KMLLayer to which the sublayer belongs.

KMLSublayer

Network link info for the current layer.

KMLSublayer

The parent layer to which the sublayer belongs.

KMLSublayer

The raw KML data for this sublayer, in JSON format, as returned by the KML utility service.

KMLSublayer

A collection of KMLSublayers.

KMLSublayer

The title of the KML sublayer used to identify it in places such as the LayerList and Legend widgets.

KMLSublayer

Indicates if the sublayer is visible in the view.

KMLSublayer

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

description

Property
description String

Description for the KML sublayer.

id

Property
id Number

The id for the KML sublayer.

layer

Property
layer KMLLayer

The KMLLayer to which the sublayer belongs.

Property
networkLink Object

Network link info for the current layer. A link info object with properties that describe the network link.

parent

Property
parent KMLSublayer |KMLLayer
Since: ArcGIS Maps SDK for JavaScript 4.27 KMLSublayer since 4.5, parent added at 4.27.

The parent layer to which the sublayer belongs.

sourceJSON

Property
sourceJSON Object
Since: ArcGIS Maps SDK for JavaScript 4.14 KMLSublayer since 4.5, sourceJSON added at 4.14.

The raw KML data for this sublayer, in JSON format, as returned by the KML utility service.

sublayers

Property
sublayers Collection<KMLSublayer>

A collection of KMLSublayers.

title

Property
title String

The title of the KML sublayer used to identify it in places such as the LayerList and Legend widgets.

visible

Property
visible Boolean

Indicates if the sublayer is visible in the view.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

KMLSublayer

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

KMLSublayer

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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

Method
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.

Parameter
json Object

A 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.

Returns
Type Description
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.