import type { ClonableMixin } from "../../core/Clonable.js";
import type { JSONSupport } from "../../core/JSONSupport.js";

/** @since 5.1 */
export interface TimeSeriesFieldTimeMappingProperties extends Partial<Pick<TimeSeriesFieldTimeMapping, "fieldName" | "timeValue">> {}

/**
 * The mapping between field names and time values for a time series configuration. This is
 * used to generate the time series [Arcade expression](https://developers.arcgis.com/javascript/latest/arcade/)
 * and for persisting user configurations when they open the UI for saved items.
 *
 * @since 5.1
 */
export default class TimeSeriesFieldTimeMapping extends TimeSeriesFieldTimeMappingSuperclass {
  constructor(properties?: TimeSeriesFieldTimeMappingProperties);
  /**
   * 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`).
   */
  accessor fieldName: 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](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeSeriesInfo/#timeValueUnits). The formatting of this
   * string must follow Arcade date formatting conventions as documented in the ArcGIS Arcade
   * [Text function](https://developers.arcgis.com/arcade/function-reference/text_functions/#text). For example:
   * if `fieldName` is `temperature_Jan2020` and `timeValueUnits` is `months`, `timeValue` would be `2020-01`.
   */
  accessor timeValue: string | null | undefined;
}
declare const TimeSeriesFieldTimeMappingSuperclass: typeof JSONSupport & typeof ClonableMixin