TimeSettings🔗

Constructor🔗

TimeSettings()

Builds the object.

def build() -> dashboardv2beta1.TimeSettingsSpec

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

v1: refresh

def auto_refresh(auto_refresh: str) -> typing.Self

Interval options available in the refresh picker dropdown.

v1: timepicker.refresh_intervals

def auto_refresh_intervals(auto_refresh_intervals: list[str]) -> typing.Self

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

def fiscal_year_start_month(fiscal_year_start_month: int) -> typing.Self

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

def from_val(from_val: str) -> typing.Self

Whether timepicker is visible or not.

v1: timepicker.hidden

def hide_timepicker(hide_timepicker: bool) -> typing.Self

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

def now_delay(now_delay: str) -> typing.Self

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

v1: timepicker.quick_ranges , not exposed in the UI

def quick_ranges(quick_ranges: list[cogbuilder.Builder[dashboardv2beta1.TimeRangeOption]]) -> typing.Self

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

def timezone(timezone: str) -> typing.Self

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

def to(to: str) -> typing.Self

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

def week_start(week_start: typing.Literal["saturday", "monday", "sunday"]) -> typing.Self