import { createTimeSeriesExpression, getArcadeTimeFormatString } from "@arcgis/core/layers/support/timeSeriesUtils.js";
Since
ArcGIS Maps SDK for JavaScript 5.1

This module provides utility functions for resolving and evaluating time series field mappings used across renderers, labels, and popups.

Type definitions

CreateTimeSeriesExpressionOptions

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.2

Options for creating a time series Arcade expression.

calculationMethodType

Property
Type
TimeSeriesCalculationMethodType | undefined

The calculation method used to derive a time series data value.

Functions

createTimeSeriesExpression

Function

Creates an Arcade expression that resolves values from a time series data series using the current Map element time.

Signature
createTimeSeriesExpression (dataSeriesInfo: TimeSeriesInfo, options?: CreateTimeSeriesExpressionOptions): string

Parameters

ParameterTypeDescriptionRequired
dataSeriesInfo

The data series definition used to build the expression.

options

Options used to create the expression.

Returns
string

An Arcade expression string.

Example
import TimeSeriesInfo from "@arcgis/core/layers/support/TimeSeriesInfo.js";
import { createTimeSeriesExpression } from "@arcgis/core/layers/support/timeSeriesUtils.js";
const info = new TimeSeriesInfo({
name: "visitationNumbers",
fieldTimeMappings: [
{ fieldName: "visitationNumbers_2020", timeValue: "2020" },
{ fieldName: "visitationNumbers_2021", timeValue: "2021" },
],
timeValueUnits: "years",
});
const expression = createTimeSeriesExpression(info, { calculationMethodType: "change-from-previous" });

getArcadeTimeFormatString

Function

Maps a data series time value unit to the corresponding Arcade string that dictates time formatting.

See also
Signature
getArcadeTimeFormatString (timeValueUnit: TimeSeriesInfo["timeValueUnits"]): string

Parameters

ParameterTypeDescriptionRequired
timeValueUnit
TimeSeriesInfo["timeValueUnits"]

The time value unit from a data series definition.

Returns
string

The Arcade string dictating time formatting.