CodedValueDomain
esri/layers/support/CodedValueDomainInformation about the coded values belonging to the domain. Coded value domains specify a valid set of values for a field. Each valid value is assigned a unique name. For example, in a layer for water mains, water main features may be buried under different types of surfaces as signified by a GroundSurfaceType field: pavement, gravel, sand, or none (for exposed water mains). The coded value domain includes both the actual value that is stored in the database (for example, 1 for pavement) and a more user-friendly description of what that value actually means.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Object[] | An array of the coded values in the domain. more details | more details | CodedValueDomain | |
| String | The name of the class. more details | more details | Accessor | |
| String | The domain name. more details | more details | Domain | |
| String | The domain type. more details | more details | CodedValueDomain |
Property Details
An array of the coded values in the domain. See the object specification table below for the properties each item in the array should contain.
- Properties:
- name String
The name of the coded value.
The value of the code.
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
The domain name.
- type Stringreadonly
The domain type. This value is always
coded-value.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | 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 details | Domain | |
| String | Returns the name of the coded-value associated with the specified code. more details | more details | CodedValueDomain | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Domain |
Method Details
- 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
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.Parameter:json 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.
Returns:Type Description * Returns a new instance of this class.
- getName(code){String}
Returns the name of the coded-value associated with the specified code.
Parameter:The code associated with the desired name.
Returns:Type Description String The name of the coded value as specified in code.
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.