ThresholdOptions | API Reference | ArcGIS Maps SDK for JavaScript 4.33

Configuration for the threshold visualization of the Shadow Cast widget and component.

See also

Constructors

ThresholdOptions Constructor new ThresholdOptions(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
Color	Color of the shadow visualization.	ThresholdOptions
Boolean	Whether to enable additional context showing discrete shadows at the same time as displaying the threshold.	ThresholdOptions
DiscreteOptions	The configuration used when showing additional context by setting contextEnabled to true.	ThresholdOptions
String	The name of the class.	Accessor
Number	The maximum time period (in milliseconds) selectable in the UI for the threshold value.	ThresholdOptions
Number	The minimum time period (in milliseconds) selectable in the UI for the threshold value.	ThresholdOptions
Number	Time period in milliseconds.	ThresholdOptions

Property Details

color Property color Colorautocast

Color of the shadow visualization. The areas with cumulative shadow time longer than the threshold value are displayed with this color.

Default Value:[255, 0 , 0, 0.7]

contextEnabled Property contextEnabled Boolean

Whether to enable additional context showing discrete shadows at the same time as displaying the threshold. The contextOptions property is used to configure the visualization of the discrete shadows when context is enabled.

Default Value:false

See also

contextOptions

contextOptions Property contextOptions DiscreteOptionsautocast

The configuration used when showing additional context by setting contextEnabled to true. The default configuration will show the shadows at 1 hour intervals as context for the threshold visualization.

See also

contextEnabled

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

maxValue Property maxValue Number

The maximum time period (in milliseconds) selectable in the UI for the threshold value. The values in the widget slider are displayed in hours.

Default Value:8 * 3600 * 1000

minValue Property minValue Number

The minimum time period (in milliseconds) selectable in the UI for the threshold value. The values in the widget slider are displayed in hours.

Default Value:0 * 3600 * 1000

value Property value Number

Time period in milliseconds. Only shadows cast for more time than this value are displayed.

Default Value:4 * 3600 * 1000

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

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