Skip to content

TimeSettingsBuilder🔗

Constructor🔗

new TimeSettingsBuilder()

Methods🔗

build🔗

Builds the object.

build()

autoRefresh🔗

Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".

v1: refresh

autoRefresh(string $autoRefresh)

autoRefreshIntervals🔗

Interval options available in the refresh picker dropdown.

v1: timepicker.refresh_intervals

@param array $autoRefreshIntervals

autoRefreshIntervals(array $autoRefreshIntervals)

fiscalYearStartMonth🔗

The month that the fiscal year starts on. 0 = January, 11 = December

fiscalYearStartMonth(int $fiscalYearStartMonth)

from🔗

Start time range for dashboard.

Accepted values are relative time strings like "now-6h" or absolute time strings like "2020-07-10T08:00:00.000Z".

from(string $from)

hideTimepicker🔗

Whether timepicker is visible or not.

v1: timepicker.hidden

hideTimepicker(bool $hideTimepicker)

nowDelay🔗

Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values.

v1: timepicker.nowDelay

nowDelay(string $nowDelay)

quickRanges🔗

Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.

v1: timepicker.quick_ranges , not exposed in the UI

@param array<\Grafana\Foundation\Cog\Builder<\Grafana\Foundation\Dashboardv2beta1\TimeRangeOption>> $quickRanges

quickRanges(array $quickRanges)

timezone🔗

Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc".

timezone(string $timezone)

to🔗

End time range for dashboard.

Accepted values are relative time strings like "now-6h" or absolute time strings like "2020-07-10T08:00:00.000Z".

to(string $to)

weekStart🔗

Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday".

weekStart(\Grafana\Foundation\Dashboardv2beta1\TimeSettingsSpecWeekStart $weekStart)

See also🔗