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

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
CodedValue[]more details

An array of the coded values in the domain.

more detailsCodedValueDomain
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The domain name.

more detailsDomain
Stringmore details For CodedValueDomain the type is always "coded-value". more detailsCodedValueDomain

Property Details

codedValues CodedValue[]

An array of the coded values in the domain.

declaredClass Stringreadonly inherited
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

For CodedValueDomain the type is always "coded-value".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
*more details

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

more detailsDomain
Stringmore details

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

more detailsCodedValueDomain
Objectmore details

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

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 an ArcGIS product. 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:
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:
code String|Number

The code associated with the desired name, e.g. 1 could be a code used for a returned name of pavement.

Returns:
Type Description
String The name of the coded value as specified by the code.
toJSON(){Object}inherited

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Type Definitions

CodedValue Object

The coded value in a domain.

Properties:
name String

The name of the coded value.

code String|Number

The value of the code.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.