TimeSettingsBuilder🔗

Constructor🔗

new TimeSettingsBuilder()

Builds the object.

build()

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

v1: refresh

autoRefresh(autoRefresh: string)

Interval options available in the refresh picker dropdown.

v1: timepicker.refresh_intervals

autoRefreshIntervals(autoRefreshIntervals: string[])

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

fiscalYearStartMonth(fiscalYearStartMonth: number)

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(from: string)

Whether timepicker is visible or not.

v1: timepicker.hidden

hideTimepicker(hideTimepicker: boolean)

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(nowDelay: string)

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

v1: timepicker.quick_ranges , not exposed in the UI

quickRanges(quickRanges: cog.Builder<dashboardv2beta1.TimeRangeOption>[])

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

timezone(timezone: string)

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(to: string)

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

weekStart(weekStart: "saturday" | "monday" | "sunday")