CodedValueDomain | References | ArcGIS Maps SDK for JavaScript

import CodedValueDomain from "@arcgis/core/layers/support/CodedValueDomain.js";

Inheritance:: CodedValueDomain→Domain→Accessor

Since: ArcGIS Maps SDK 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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`CodedValueDomainProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`codedValues`	`CodedValue[]`
`declaredClass` readonly inherited	`string`	Accessor
`name` inherited	`string`	Domain
`type` readonly	`"coded-value"`

codedValues

autocast Property

Type: CodedValue[]

An array of the coded values in the domain.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

name

inherited Property

Type: string

Inherited from: Domain

The domain name.

type

readonly Property

Type: "coded-value"

The domain type.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`getName`	`getName(code: string \| number): string \| null \| undefined`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

getName

Method

Signature: getName (code: string | number): string | null | undefined

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

Parameters

Parameter	Type	Description	Required
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: string | null | undefined
The name of the coded value as specified by the code.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.