CameraLayout

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

The camera layout defines the position of the current view in a distributed larger view.

The layout selects the sub-region of the camera defined by the row and column in the large view of size [rows, columns]. One application is to represent a display in a larger tile display wall.

See also

Constructors

CameraLayout

Constructor
new CameraLayout()

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 active column a display client renders to in a tiled display setup.

CameraLayout

The number of columns to decompose the camera in a tiled display setup.

CameraLayout

The name of the class.

Accessor

The active row a display client renders to in a tiled display setup.

CameraLayout

The number of rows to decompose the camera in a tiled display setup.

CameraLayout

Property Details

column

Property
column Number

The active column a display client renders to in a tiled display setup.

The camera is subdivided in rows and columns, and this client will render the given column.

Default Value:0

columns

Property
columns Number

The number of columns to decompose the camera in a tiled display setup.

Default Value:1

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

row

Property
row Number

The active row a display client renders to in a tiled display setup.

The camera is subdivided in rows and columns, and this client will render the given row.

Default Value:0

rows

Property
rows Number

The number of rows to decompose the camera in a tiled display setup.

Default Value:1

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
this

Creates a deep clone of this object.

CameraLayout

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

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.

clone

Method
clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns
Type Description
this A deep clone of the class instance that invoked this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

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

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");

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