Subtype | References | ArcGIS Maps SDK for JavaScript

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

const Subtype = await $arcgis.import("@arcgis/core/layers/support/Subtype.js");

Inheritance: Subtype→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.28

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

Introduction to subtypes

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	SubtypeProperties

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
code	number
declaredClass readonly inherited	string	Accessor
defaultValues	{ [key: string]: string \| number \| null; }
domains	Domains \| null \| undefined
name	string

code

Property

Type: number

The subtype unique identifier number.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

defaultValues

Property

Type: { [key: string]: string | number | null; }

Name-value pairs of fields and their default field values associated with the subtype.

domains

Property

Type: Domains | null | undefined

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

Property

Type: string

The subtype name.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone inherited	clone(): this	ClonableMixin
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.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

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.

Type definitions

Domains

Type definition

Type: Record<string, DomainUnion> | null