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

TimeRangePickerProps interface

Signature

typescript
export interface TimeRangePickerProps extends Themeable 

Import

typescript
import { TimeRangePickerProps } from '@grafana/ui';

Properties

PropertyTypeDescription
fiscalYearStartMonthnumber
hideQuickRangesboolean
hideTextboolean
historyTimeRange[]
isSyncedboolean
onChange(timeRange: TimeRange) => void
onChangeFiscalYearStartMonth(month: number) => void
onChangeTimeZone(timeZone: TimeZone) => void
onMoveBackward() => void
onMoveForward() => void
onZoom() => void
timeSyncButtonJSX.Element
timeZoneTimeZone
valueTimeRange

fiscalYearStartMonth property

Signature

typescript
fiscalYearStartMonth?: number;

hideQuickRanges property

Signature

typescript
hideQuickRanges?: boolean;

hideText property

Signature

typescript
hideText?: boolean;

history property

Signature

typescript
history?: TimeRange[];

isSynced property

Signature

typescript
isSynced?: boolean;

onChange property

Signature

typescript
onChange: (timeRange: TimeRange) => void;

onChangeFiscalYearStartMonth property

Signature

typescript
onChangeFiscalYearStartMonth?: (month: number) => void;

onChangeTimeZone property

Signature

typescript
onChangeTimeZone: (timeZone: TimeZone) => void;

onMoveBackward property

Signature

typescript
onMoveBackward: () => void;

onMoveForward property

Signature

typescript
onMoveForward: () => void;

onZoom property

Signature

typescript
onZoom: () => void;

timeSyncButton property

Signature

typescript
timeSyncButton?: JSX.Element;

timeZone property

Signature

typescript
timeZone?: TimeZone;

value property

Signature

typescript
value: TimeRange;