FocusArea | References | ArcGIS Maps SDK for JavaScript

import FocusArea from "@arcgis/core/effects/FocusArea.js";

Inheritance:: FocusArea→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.33

Represents a single focus area.

A focus area highlights a region of the map by de-emphasizing parts outside the area of interest. Focus areas can have an optional outline with a configurable color. Focus areas are added to Map.focusAreas.

A focus area is defined by its geometries, which are a collection of polygons.

See also

FocusAreas

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`FocusAreaProperties`

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

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`enabled`	`boolean`
`geometries`	`Collection<Polygon>`
`id`	`string`
`outline`	`FocusAreaOutline \| null \| undefined`
`title`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

enabled

Property

Type: boolean

A boolean indicating whether the focus area is enabled and displayed.

Default value: true

geometries

autocast Property

Type: Collection<Polygon>

The geometries defining the focused area.

The focus area geometries are defining the 2D map areas which are in focus, Z values are ignored.

Known Limitations

Polygon is the only supported geometry type.

id

Property

Type: string

The unique ID assigned to the focus area.

It is automatically generated when the focus area is created, and can be overwritten by the developer.

outline

autocast Property

Type: FocusAreaOutline | null | undefined

An object describing the style of the focus area outline.

This property can be an instance of FocusAreaOutline, or nil if no outline is desired.

title

Property

Type: string | null | undefined

The title of the focus area.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.