TimeSeriesFieldTimeMapping | References | ArcGIS Maps SDK for JavaScript

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

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

Inheritance: TimeSeriesFieldTimeMapping→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.1

The mapping between field names and time values for a time series configuration. This is used to generate the time series Arcade expression and for persisting user configurations when they open the UI for saved items.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	TimeSeriesFieldTimeMappingProperties

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
declaredClass readonly inherited	string	Accessor
fieldName	string \| null \| undefined
timeValue	string \| null \| undefined

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.

fieldName

Property

Type: string | null | undefined

The name of the field that contains a data value of an attribute at the date or time value specified in timeValue (e.g. temperature_Jan2020).

timeValue

Property

Type: string | null | undefined

A formatted string representing the date or time value associated with the field specified by fieldName. The time unit for this value is specified by TimeSeriesInfo.timeValueUnits. The formatting of this string must follow Arcade date formatting conventions as documented in the ArcGIS Arcade Text function. For example: if fieldName is temperature_Jan2020 and timeValueUnits is months, timeValue would be 2020-01.

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.