FocusAreas | API Reference | ArcGIS Maps SDK for JavaScript 4.33

A collection of focus areas in a Map.

A focus area highlights a region of the map by de-emphasizing parts outside the area of interest. Two predefined styles, dark or bright are available, to choose a visualization with good contrast for scenes with different coloring. A focus area can have a colored outline, which is helpful to distinguish different focus areas in a map. Focus areas can be captured in slides and shared as part of a webscene.

Known Limitations

Focus areas are only supported in SceneView.

See also

Example

// Adding a focus area to map.
const focusAreaPolygon = new Polygon({
 spatialReference: { wkid: 102100 },
 rings: [[
  [1288603, 6130075],
  [1288415, 6130021],
  [1288459, 6130133],
  [1288603, 6130075],
 ]],
});

const focusArea = new FocusArea({
 outline: { color: [255, 128, 128, 0.55] },
 geometries: new Collection([focusAreaPolygon]),
});

map.focusAreas.areas.add(focusArea);
map.focusAreas.style = "dark";

Constructors

FocusAreas Constructor new FocusAreas(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Collection<FocusArea>	A collection containing all focus areas.	FocusAreas
String	The name of the class.	Accessor
String	The rendering style of the map, applied outside of all enabled focus areas.	FocusAreas

Property Details

areas Property areas Collection<FocusArea>autocast

A collection containing all focus areas.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

style Property style Stringautocast

The rendering style of the map, applied outside of all enabled focus areas.

This property can be either "bright" or "dark", with the default value set to "bright". When there is no enabled focus area on the map, the view renders normally.

Possible Values:"bright" |"dark"

Default Value:"bright"

Method Overview

Show inherited methods

Hide inherited methods

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.	FocusAreas
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	FocusAreas
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	FocusAreas

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.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

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

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.