Class LayerTimeFormatter

constructor

• new LayerTimeFormatter(options?: ITimeOptions): LayerTimeFormatter

  Parameters

  • Optionaloptions: ITimeOptions

  Returns LayerTimeFormatter

OptionalmaxDefaultValue

maxValue

OptionalminDefaultValue

minValue

mode

resolution

formatDateString

• formatDateString(date: string | Date): string

  Receives a date string or date object, validates it against the specified time options, and generates a formatted query string for usage as URL query parameter.

  Parameters

  • date: string | Date

    The date-like string or date object to be parsed and converted.

  Returns string

  A formatted query string, or an empty string if the date is invalid.

formatTimeRange

• formatTimeRange(lowerLimit: string | Date, upperLimit: string | Date): string

  Generates a formatted query string from a provided date range for usage as URL query parameter. The provided dates are shortened to fit the defined resolution.

  Parameters

  • lowerLimit: string | Date

    The lower bound of the time range as a date-like string or date object.

  • upperLimit: string | Date

    The upper bound of the time range as a date-like string or date object.

  Returns string

  A formatted query string, or an empty string if the dates are invalid.

getFormattedDefault

• getFormattedDefault(): string | undefined

  Helper method to quickly generate a formated query string from the default time restriction provided by the time options.

  Returns string | undefined

  The formatted defaults as query string or undefined if no defaults are available.

parseDateString

• parseDateString(dateStr: string): Date | undefined

  Simple date transform method from a date-like string to a date object without validating it against the time options.

  Parameters

  • dateStr: string

    The date string to be parsed.

  Returns Date | undefined

  The resulting Date object if the input is valid, otherwise undefined.

toOpenLayersWfsFilter

• toOpenLayersWfsFilter(
      timeRestriction: string,
      timeAttribute: string,
  ): Filter | undefined

  Converts the WMS temporal query string into an OpenLayers WFS filter.

  Parameters

  • timeRestriction: string

    The time restriction query string used for the WMS request, e.g. '2020-02', '2012-11-04/2012-11-14'.

  • timeAttribute: string

    The name of the attribute that is used for temporal filtering.

  Returns Filter | undefined

  Returns a new OpenLayers WFS filter object, or undefined if no valid filter could be created.

StaticformatAsDate

• formatAsDate(date: Date): string

  Formats a given date into a date string of type 'YYYY-MM-DD'.

  Parameters

  • date: Date

  Returns string

StaticformatAsMonth

• formatAsMonth(date: Date): string

  Formats a given date into a date string of type 'YYYY-MM'.

  Parameters

  • date: Date

  Returns string

StaticformatAsWeekRange

• formatAsWeekRange(date: Date): string

  Formats a given date into a string, representing the week range from Monday to Sunday that the date falls into, e.g. 'YYYY-MM-DD/YYYY-MM-DD'

  Parameters

  • date: Date

  Returns string

StaticformatAsYear

• formatAsYear(date: Date): string

  Formats a given date into a year string of type 'YYYY'.

  Parameters

  • date: Date

  Returns string

StaticgetMondayOfWeek

• getMondayOfWeek(date: Date): Date

  Parameters

  • date: Date

  Returns Date

StaticgetSundayOfWeek

• getSundayOfWeek(date: Date): Date

  Parameters

  • date: Date

  Returns Date

StaticqueryStringFromDateRangeAnResolution

• queryStringFromDateRangeAnResolution(
      lowerLimit: Date,
      upperLimit: Date,
      resolution: TimeResolution,
  ): string

  Formats a date range as a string, separated by a forward slash and taking the resolution into account when defining the precision of the date strings.

  Parameters

  • lowerLimit: Date

    The starting date of the range.

  • upperLimit: Date

    The ending date of the range.

  • resolution: TimeResolution

    The resolution of the date range, can be 'day', 'week', 'month', or 'year'.

  Returns string

  A query string representing the date range formatted according to the specified resolution.

StaticqueryStringFromSingleValueAndResolution

• queryStringFromSingleValueAndResolution(
      date: Date,
      resolution: TimeResolution,
  ): string

  Constructs a query string based on a single date value and a specified time resolution.

  Parameters

  • date: Date

    The date value to be formatted.

  • resolution: TimeResolution

    The time resolution specifying the format (e.g. day, week, month, year).

  Returns string

  A formatted string representation of the date based on the provided resolution.