types

Types

import type { OriginName, ReadableOriginName, Types, Caster, InputPropertyMetadata } from "@arcgis/core/core/accessorSupport/types.js";

Type definitions

OriginName

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "defaults" | "service" | "portal-item" | "web-scene" | "web-map" | "link-chart" | "user"

ReadableOriginName

Type definition

Type: "service" | "portal-item" | "web-scene" | "web-map" | "link-chart"

Type definition

Type parameters: <T extends Base = any, Base = T>

Since: ArcGIS Maps SDK for JavaScript 5.0

key

Property

Type: string | ((obj: any) => string)

Since: ArcGIS Maps SDK for JavaScript 5.0

base

Property

Type: (abstract new (...args: any[]) => Base) | null

Since: ArcGIS Maps SDK for JavaScript 5.0

typeMap

Property

Type: Record<string, new (...params: any[]) => T>

Since: ArcGIS Maps SDK for JavaScript 5.0

Caster

Type definition

Type parameters: <T = any>

Since: ArcGIS Maps SDK for JavaScript 5.0

Casts a value from one type to another.

Parameters

Parameter	Type	Description	Required
value	any	the value.

Returns: T
the cast value.

InputPropertyMetadata

Type definition

Type parameters: <T extends Base = any, Base = T>

Since: ArcGIS Maps SDK for JavaScript 5.0

cast

Property

Type: Caster | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The function to use to autocast the property. Alternative to define the type. The function is called with the value set by the user and should return the cast value.

value

Property

Type: T | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The default value for the property.

dependsOn

deprecated Property

Type: string[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Property names of dependencies.

type

Property

Type: any | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The constructor used to autocast the property.

readOnly

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the property is read-only.

Default value: false

constructOnly

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the property can be set during construction but is otherwise read-only.

Default value: false

aliasOf

deprecated Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The property decorator that creates a two-way binding between the property it decorates and an inner property of one of its members.