IPeriod

Type interface

Sources

IPeriod is an interface: it describes a shape of data and is not imported on its own.

Properties

#count

Type undefined | number

Number of timeUnits in the period.

#end

Type Date

End of a "custom" period; the end of the data if not set.

#name

Type undefined | string

Label of the period's button.

#start

Type Date

Start of a "custom" period; the start of the data if not set.

#timeUnit

Type TimeUnit | "ytd" | "max" | "custom"

Time unit of the period, or "ytd" (year to date), "max" (all data) or "custom" (from start to end).