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.
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
export interface DateTimeOptionsWithFormat extends DateTimeOptions
Import
import { DateTimeOptionsWithFormat } from '@grafana/data';
Properties
Property | Type | Description |
---|---|---|
defaultWithMS | boolean | 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. |
format | string | 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. |
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
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
format?: string;