require(["esri/layers/support/Subtype"], (Subtype) => { /* code goes here */ });
import Subtype from "@arcgis/core/layers/support/Subtype.js";
esri/layers/support/Subtype
Subtypes categorize a subset of features in a layer that share the same attributes. These subset of features are categorized based off the attribute value of the layer.subtypeField. Subtypes can have default values and domains assigned to their respective fields. This class has no constructor.
- See also
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Number | The subtype unique identifier number. | Subtype | |
| String | The name of the class. | Accessor | |
| Object | Name-value pairs of fields and their default field values associated with the subtype. | Subtype | |
| HashMap<(CodedValueDomain|RangeDomain|InheritedDomain)> | Domains associated with the subtype. | Subtype | |
| String | The subtype name. | Subtype |
Property Details
-
code
Propertycode Number -
The subtype unique identifier number.
-
defaultValues
PropertydefaultValues Object -
Name-value pairs of fields and their default field values associated with the subtype.
-
domains
Propertydomains HashMap<(CodedValueDomain|RangeDomain|InheritedDomain)> -
Domains associated with the subtype. It is an object where the name of each property corresponds with the name of a field containing a domain. If a field's domain is an instance of InheritedDomain, the application will use the domain defined for the field from the layer. If the domain is an instance of CodedValueDomain or RangeDomain then the domain is defined specifically for the given feature type.
-
name
Propertyname String -
The subtype name.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Subtype | |
| 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. | Subtype |
Method Details
-
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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.