Skip to content

TimeSettingsBuilder🔗

Constructor🔗

func NewTimeSettingsBuilder() *TimeSettingsBuilder

Methods🔗

Build🔗

Builds the object.

func (builder *TimeSettingsBuilder) Build() (TimeSettingsSpec, error)

AutoRefresh🔗

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

v1: refresh

func (builder *TimeSettingsBuilder) AutoRefresh(autoRefresh string) *TimeSettingsBuilder

AutoRefreshIntervals🔗

Interval options available in the refresh picker dropdown.

v1: timepicker.refresh_intervals

func (builder *TimeSettingsBuilder) AutoRefreshIntervals(autoRefreshIntervals []string) *TimeSettingsBuilder

FiscalYearStartMonth🔗

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

func (builder *TimeSettingsBuilder) FiscalYearStartMonth(fiscalYearStartMonth int64) *TimeSettingsBuilder

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".

func (builder *TimeSettingsBuilder) From(from string) *TimeSettingsBuilder

HideTimepicker🔗

Whether timepicker is visible or not.

v1: timepicker.hidden

func (builder *TimeSettingsBuilder) HideTimepicker(hideTimepicker bool) *TimeSettingsBuilder

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

func (builder *TimeSettingsBuilder) NowDelay(nowDelay string) *TimeSettingsBuilder

QuickRanges🔗

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

v1: timepicker.quick_ranges , not exposed in the UI

func (builder *TimeSettingsBuilder) QuickRanges(quickRanges []cog.Builder[dashboardv2beta1.TimeRangeOption]) *TimeSettingsBuilder

Timezone🔗

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

func (builder *TimeSettingsBuilder) Timezone(timezone string) *TimeSettingsBuilder

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".

func (builder *TimeSettingsBuilder) To(to string) *TimeSettingsBuilder

WeekStart🔗

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

func (builder *TimeSettingsBuilder) WeekStart(weekStart dashboardv2beta1.TimeSettingsSpecWeekStart) *TimeSettingsBuilder

See also🔗