grafana/docs/sources/packages_api/data/datetimeoptionswhenparsing.md

41 lines
1.5 KiB
Markdown
Raw Normal View History

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "DateTimeOptionsWhenParsing"
keywords = ["grafana","documentation","sdk","@grafana/data"]
type = "docs"
+++
## DateTimeOptionsWhenParsing interface
The type that describes options that can be passed when parsing a date and time value.
<b>Signature</b>
```typescript
export interface DateTimeOptionsWhenParsing extends DateTimeOptions
```
<b>Import</b>
```typescript
import { DateTimeOptionsWhenParsing } from '@grafana/data';
```
<b>Properties</b>
| Property | Type | Description |
| --- | --- | --- |
| [roundUp](#roundup-property) | <code>boolean</code> | If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.<!-- -->Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00. |
### roundUp property
If the input is a Grafana quick date, e.g. now-6h, then you can specify this to control whether the last part of the date and time value is included or excluded.
Example: now-6h and the current time is 12:20:00 if roundUp is set to true the returned DateTime value will be 06:00:00.
<b>Signature</b>
```typescript
roundUp?: boolean;
```