grafana/docs/sources/packages_api/data/datetimeoptionswithformat.md
Marcus Andersson 6a0abf895e
Docs: generated a 7.0 version of the packages reference docs. (#24708)
* fixes so we match the transformer based on name properly.

* changed the signature on the FieldMatcher.

* introduced a names option so you can filter in name specificly.

* changed so the matcher UI uses the new options format.

* moved the exported functions together.

* changing editors a bit.

* made the filter by name work with both regex and name filtering.

* fixed failing tests and make sure we always parse regex the same way.

* removed unused code.

* simplified to make the existing field overrides still working.

* fixed issue reported by hugo.

* added tests for the name matcher.

* added tests for filter by name.

* added more tests.

* generated new version of the packages docs.

* fixed spelling error.

* regenerated the docs.
2020-05-14 21:34:59 +02:00

2.0 KiB

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "DateTimeOptionsWithFormat" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

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;