SharedTemplateMetadata | References | ArcGIS Maps SDK for JavaScript

import SharedTemplateMetadata from "@arcgis/core/editing/sharedTemplates/SharedTemplateMetadata.js";

Inheritance:: SharedTemplateMetadata→Accessor

Subclasses:: SharedTemplate

Since: ArcGIS Maps SDK for JavaScript 4.32

The SharedTemplateMetadata class represents a minimal set of information about a shared template. This is the information from the the sharedTemplates/query endpoint of a feature service. By contrast, the SharedTemplate class represents full information about a shared template, which is a larger payload obtained from the sharedTemplates/templates endpoint. Use the SharedTemplateMetadata class when you need only minimal information about many shared templates, such as when populating a gallery or picker interface. Use the SharedTemplate class when you need full information about a specific template, such as when a particular template has been selected for use in a feature creation workflow.

See also

SharedTemplate

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`templateId`	`number`
`type`	`SharedTemplateType`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

templateId

Property

Type: number

The template ID of the shared template.

type

Property

Type: SharedTemplateType

The type of the shared template.

Default value: "feature"

Methods

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

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.