Skip To ContentArcGIS for DevelopersSign In Dashboard
require(["esri/renderers/visualVariables/support/OpacityStop"], function(OpacityStop) { /* code goes here */ });
Class: esri/renderers/visualVariables/support/OpacityStop
Inheritance: OpacityStop Accessor
Since: ArcGIS API for JavaScript 4.10

Defines an opacity stop used for creating a continuous opacity visualization in a opacity visual variable.

See also:

Constructors

new OpacityStop(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 Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

A string value used to label the stop in the Legend.

more details
more detailsOpacityStop
Number

The opacity value (between 0.0 and 1.0) used to render features with the given value.

more details
more detailsOpacityStop
Number

Specifies the data value to map to the given opacity value.

more details
more detailsOpacityStop

Property Details

declaredClass Stringreadonly inherited

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

label String

A string value used to label the stop in the Legend.

Autocasts from Number[]|String|Object

The opacity value (between 0.0 and 1.0) used to render features with the given value.

value Number

Specifies the data value to map to the given opacity value.

Method Overview

NameReturn TypeSummaryClass
OpacityStop

Creates a deep clone of the OpacityStop.

more details
more detailsOpacityStop
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsOpacityStop
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsOpacityStop

Method Details

clone(){OpacityStop}

Creates a deep clone of the OpacityStop.

Returns:
TypeDescription
OpacityStopA deep clone of the opacity stop that invoked this method.
Example:
// Creates a deep clone of the visual variable
const stops = renderer.visualVariables[0].stops.map(function(stop){
  return stop.clone();
});
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...