timeSeriesUtils | References | ArcGIS Maps SDK for JavaScript

import { createTimeSeriesExpression, getArcadeTimeFormatString } from "@arcgis/core/layers/support/timeSeriesUtils.js";

const { createTimeSeriesExpression, getArcadeTimeFormatString } = await $arcgis.import("@arcgis/core/layers/support/timeSeriesUtils.js");

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

Functions

Function

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

Signature: createTimeSeriesExpression (dataSeriesInfo: TimeSeriesInfo): string

Parameter	Type	Description	Required
dataSeriesInfo	TimeSeriesInfo	The data series definition used to build the expression.

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

Parameter	Type	Description	Required
timeValueUnit	TimeSeriesInfo["timeValueUnits"]	The time value unit from a data series definition.