Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Enterprise Open source

dateMath namespace

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

dateMath namespace

Import

typescript
import { dateMath } from '@grafana/data';

Functions

FunctionDescription
isMathString(text)
isValid(text)Checks if text is a valid date which in this context means that it is either a Moment instance or it can be parsed by parse function. See parse function to see what is considered acceptable.
parse(text, roundUp, timezone, fiscalYearStartMonth)Parses different types input to a moment instance. There is a specific formatting language that can be used if text arg is string. See unit tests for examples.
parseDateMath(mathString, time, roundUp, fiscalYearStartMonth)Parses math part of the time string and shifts supplied time according to that math. See unit tests for examples.
roundToFiscal(fyStartMonth, dateTime, unit, roundUp)