CodedValueDomain

Class: esri/layers/support/CodedValueDomain
Inheritance: CodedValueDomain Domain Accessor
Since: ArcGIS API for JavaScript 4.0

Information about the coded values belonging to the domain. Coded value domains specify a set of valid values for an attribute.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Object[]

An array of the coded values in the domain.

more details
more detailsCodedValueDomain
String

The name of the class.

more details
more detailsAccessor
String

The domain name.

more details
more detailsDomain
String

The domain type.

more details
more detailsCodedValueDomain

Property Details

codedValuesObject[]

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.

code String | Number

The value of the code.

declaredClassStringreadonly inherited

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

The domain name.

typeString

The domain type. This value is always coded-value.

Method Overview

NameReturn TypeSummaryClass
*

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 detailsDomain
String

Returns the name of the coded-value associated with the specified code.

more details
more detailsCodedValueDomain
Object

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

more details
more detailsDomain

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

getName(code){String}

Returns the name of the coded-value associated with the specified code.

Parameter:

The code associated with the desired name.

Returns:
TypeDescription
StringThe name of the coded value as specified in code.

toJSON(){Object}inherited

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

There were no match results from your search criteria.