KMLLayerView

Class: esri/views/layers/KMLLayerView
Inheritance: KMLLayerView LayerView Accessor
Since: ArcGIS Maps SDK for JavaScript 4.6

Represents the LayerView of a KMLLayer after it has been added to a Map in a MapView.

See also

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
Collection<MapImage>

A collection of all the MapImages from visible sublayers.

more details
KMLLayerView
Collection<Point>

A collection of all the points from visible sublayers.

more details
KMLLayerView
Collection<Polygon>

A collection of all the polygons from visible sublayers.

more details
KMLLayerView
Collection<Polyline>

A collection of all the polylines from visible sublayers.

more details
KMLLayerView
String

The name of the class.

more details
Accessor
Layer

The layer being viewed.

more details
LayerView
Boolean

Indicates if the spatialReference of the MapView is supported by the layer view.

more details
LayerView
Boolean

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

more details
LayerView
Boolean

Value is true when the layer is updating; for example, if it is in the process of fetching data.

more details
LayerView
Boolean

When true, the layer is visible in the view.

more details
LayerView

Property Details

allVisibleMapImages Collection<MapImage>readonly

A collection of all the MapImages from visible sublayers.

allVisiblePoints Collection<Point>readonly

A collection of all the points from visible sublayers.

allVisiblePolygons Collection<Polygon>readonly

A collection of all the polygons from visible sublayers.

allVisiblePolylines Collection<Polyline>readonly

A collection of all the polylines from visible sublayers.

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

layer Layerreadonly inherited

The layer being viewed.

spatialReferenceSupported Booleanreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.23

Indicates if the spatialReference of the MapView is supported by the layer view. When false layer view will be suspended.

See also
suspended Booleanreadonly inherited

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

See also
updating Booleanreadonly inherited

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false
visible Boolean inherited

When true, the layer is visible in the view. Value of this property is inherited from the layer.visible unless the developer overrides it. The layerView.visible will take precedence over layer.visible if both properties are set.

Default Value:true

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.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
LayerView
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
LayerView
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
LayerView

Removes a group of handles owned by the object.

more details
Accessor
Promise

when() may be leveraged once an instance of the class is created.

more details
LayerView

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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");
}
isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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");
when(callback, errback){Promise}inherited

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

MapImage Object

MapImage represents an image overlay draped onto the terrain.

Properties
id Number

Map image id.

href String

URL to the map image.

Extent Extent

The Extent of the map image.

rotation Number

Rotation of the map image about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction.

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