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.

Documentation Grafana documentation API Reference @grafana/data DateTimeOptionsWithFormat

DateTimeOptionsWithFormat interface

The type describing the options that can be passed to the dateTimeFormat helper function to control how the date and time value passed to the function is formatted.

Signature

typescript Copy

export interface DateTimeOptionsWithFormat extends DateTimeOptions 

Import

typescript Copy

import { DateTimeOptionsWithFormat } from '@grafana/data';

Properties

defaultWithMS property

Set this value to true if you want to include milliseconds when formatting date and time values in the default DEFAULT_DATE_TIME_FORMAT format.

Signature

typescript Copy

defaultWithMS?: boolean;

format property

Specify a momentjs format to use a custom formatting pattern of the date and time value. If no format is set, then DEFAULT_DATE_TIME_FORMAT is used.

Signature

typescript Copy

format?: string;