Time Series Ranges

Current-X

In general:

Start of range (inclusive): The first day of the X containing the anchor.
End of range (inclusive): The last day of the X containing the anchor.
Name component: "X"
Default label component: "X"

current-day

Predicate expression: ts_current_day(<date>, <anchor>)
Start of range (inclusive): The anchor.
End of range (inclusive): The anchor.
Name component: "D"
Default label component: "D"

current-week

Predicate expression: ts_current_week(<date>, <anchor>)
Start of range (inclusive): The first day of the week containing the anchor.
End of range (inclusive): The last day of the week containing the anchor.
Name component: "W"
Default label component: "W"

current-month

Predicate expression: ts_current_month(<date>, <anchor>)
Start of range (inclusive): The first day of the month containing the anchor.
End of range (inclusive): The last day of the month containing the anchor.
Name component: "M"
Default label component: "M"

current-quarter

Predicate expression: ts_current_quarter(<date>, <anchor>)
Start of range (inclusive): The first day of the quarter containing the anchor.
End of range (inclusive): The last day of the quarter containing the anchor.
Name component: "Q"
Default label component: "Q"

current-tertile

Predicate expression: ts_current_tertile(<date>, <anchor>)
Start of range (inclusive): The first day of the tertile containing the anchor.
End of range (inclusive): The last day of the tertile containing the anchor.
Name component: "T"
Default label component: "T"

current-half

Predicate expression: ts_current_half(<date>, <anchor>)
Start of range (inclusive): The first day of the half containing the anchor.
End of range (inclusive): The last day of the half containing the anchor.
Name component: "H"
Default label component: "H"

current-year

Predicate expression: ts_current_year(<date>, <anchor>) (equivalent to year(<date>) = year(<anchor>))
Start of range (inclusive): The first day of the year containing the anchor.
End of range (inclusive): The last day of the year containing the anchor.
Name component: "Y"
Default label component: "Y"

X-to-date

In general:

Start of range (inclusive): The first day of the X containing the anchor.
End of range (inclusive): The anchor.
Name component: "XTD"
Default label component: "XTD"

week-to-date

Predicate expression: ts_week_to_date(<date>, <anchor>)
Start of range (inclusive): The first day of the week containing the anchor.
End of range (inclusive): The anchor.
Name component: "WTD"
Default label component: "WTD"

month-to-date

Predicate expression: mtd(<date>, <anchor>)
Start of range (inclusive): The first day of the month containing the anchor.
End of range (inclusive): The anchor.
Name component: "MTD"
Default label component: "MTD"

quarter-to-date

Predicate expression: ts_quarter_to_date(<date>, <anchor>)
Start of range (inclusive): The first day of the quarter containing the anchor.
End of range (inclusive): The anchor.
Name component: "QTD"
Default label component: "QTD"

tertile-to-date

Predicate expression: ts_tertile_to_date(<date>, <anchor>)
Start of range (inclusive): The first day of the tertile containing the anchor.
End of range (inclusive): The anchor.
Name component: "TTD"
Default label component: "TTD"

half-to-date

Predicate expression: ts_half_to_date(<date>, <anchor>)
Start of range (inclusive): The first day of the half containing the anchor.
End of range (inclusive): The anchor.
Name component: "HTD"
Default label component: "HTD"

year-to-date

Predicate expression: ytd(<date>, <anchor>)
Start of range (inclusive): The first day of the year containing the anchor.
End of range (inclusive): The anchor.
Name component: "YTD"
Default label component: "YTD"

All-X

This range specification produces one calc per summary per X in a year. The specification produces more calcs when using variations.

In general (N from 1 to <number of Xs per year> inclusive):

Start of range (inclusive): The first day of the Nth X in the year containing the anchor.
End of range (inclusive): The last day of the Nth X in the year containing the anchor.
Name component: "X#" or "X##"
Default label component: "X#" or "X##" or "MMM"

all-months

This produces 12 calcs per summary.
Predicate expression: ts_month(<month number>, <date>, <anchor>)
Start of range (inclusive): The first day of month <month number> in the year containing the anchor.
End of range (inclusive): The last day of month <month number> in the year containing the anchor.
Name component: "M##" (such as "M01")
Default label component: "MMM" (such as "Jan")

all-quarters

This produces 4 calcs per summary.
Predicate expression: ts_quarter(<quarter number>, <date>, <anchor>)
Start of range (inclusive): The first day of quarter <quarter number> in the year containing the anchor.
End of range (inclusive): The last day of quarter <quarter number> in the year containing the anchor .
Name component: "Q#" (such as "Q1")
Default label component: "Q#" (such as "Q1")

all-tertiles

This produces 3 calcs per summary.
Predicate expression: ts_tertile(<tertile number>, <date>, <anchor>)
Start of range (inclusive): The first day of tertile <tertile number> in the year containing the anchor.
End of range (inclusive): The last day of tertile <tertile number> in the year containing the anchor.
Name component: "T#" (such as "T1")
Default label component: "T#" (such as "T1")

all-halves

This produces 2 calcs per summary.
Predicate expression: ts_half(<half number>, <date>, <anchor>)
Start of range (inclusive): The first day of half <half number> in the year containing the anchor.
End of range (inclusive): The last day of half <half number> in the year containing the anchor.
Name component: "H#" (such as "H1")
Default label component: "H#" (such as "H1")

Rolling-X <count>

In general:

Start of range (inclusive): The first day of the X <count>-1 Xs before the X containing the anchor.
End of range (inclusive): The last day of the X containing the anchor.
Name component: "RX#"
Default label component: "RX#"
When <count> is negative or the forward=true attribute is specified, the periods go forward in time and RX# becomes FRX#.

rolling-days <count>

Predicate expression: ts_rolling_days(<count>, <date>, <anchor>)
Start of range (inclusive): <count>-1 days before the anchor.
End of range (inclusive): The anchor.
Name component: "RD#" (such as "RD60")
Default label component: "RD#" (such as "RD60")
For a negative <count>: "FRD#" (such as "FRD60")

rolling-weeks <count>

Predicate expression: ts_rolling_weeks(<count>, <date>, <anchor>)
Start of range (inclusive): The first date in the week <count>-1 weeks before the week containing the anchor.
End of range (inclusive): The last day of the week containing the anchor.
Name component: "RW#" (such as "RW8")
Default label component: "RW#" (such as "RW8")
For a negative <count>: "FRW#" (such as "FRW8)

rolling-months <count>

Predicate expression: ts_rolling_months(<count>, <date>, <anchor>)
Start of range (inclusive): The first date in the month <count>-1 months before the month containing the anchor.
End of range (inclusive): The last day of the month containing the anchor.
Name component: "R#" (such as "R6")
Default label component: "R#" (such as "R6")
For a negative <count>: "FR#" (such as "FR6")

rolling-quarters <count>

Predicate expression: ts_rolling_quarters(<count>, <date>, <anchor>)
Start of range (inclusive): The first date in the quarter <count>-1 quarters before the quarter containing the anchor.
End of range (inclusive): The last day of the quarter containing the anchor.
Name component: "RQ#" (such as "RQ3")
Default label component: "RQ#" (such as "RQ3")
For a negative <count>: "FRQ#" (such as "FRQ3")

rolling-tertiles <count>

Predicate expression: ts_rolling_tertiles(<count>, <date>, <anchor>)
Start of range (inclusive): The first date in the tertile <count>-1 tertiles before the tertile containing the anchor.
End of range (inclusive): The last date in the tertile containing the anchor.
Name component: "RT#" (such as "RT2")
Default label component: "RT#" (such as "RT2")
For a negative <count>: "FRT#" (such as "FRT2")

rolling-halves <count>

Predicate expression: ts_rolling_halves(<count>, <date>, <anchor>)
Start of range (inclusive): The first date in the half <count>-1 halves before the half containing the anchor.
End of range (inclusive): The last day in the half containing the anchor.
Name component: "RH#" (such as "RH3")
Default label component: "RH#" (such as "RH3")
For a negative <count>: "FRH#" (such as "FRH3")

rolling-years <count>

Predicate expression: ts_rolling_years(<count>, <date>, <anchor>)
Start of range (inclusive): The first date in the year <count>-1 years before the year containing the anchor.
End of range (inclusive): The last day in the year containing the anchor.
Name component: "RY#" (such as "RY3")
Default label component: "RY#" (such as "RY3")
For a negative <count>: "FRY#" (such as "FRY3")

Recent-X <count>

This option creates <count> calcs, one for each offset between 0 and <count> - 1.

In general (N from 0 to <count>-1 inclusive):

Start of range (inclusive): The first day of the X N Xs before the X containing the anchor.
End of range (inclusive): The last day of the X N Xs before the X containing the anchor.
Name component: "X-#"
Default label component: "X-#"
When <count> is negative or forward=true attribute is specified, the periods go forward in time and X-# become X+#.

recent-days <count>

Predicate expression: ts_recent_day(<count>, <date>, <anchor>)
Start of range (inclusive): <count> days before the anchor.
End of range (inclusive): same as start of range.
Name component: "D-#" (such as "D-60")
Default label component: "D-#" (such as "D-60")
For a negative <count>: "D+#" (such as "D+60)

recent-weeks <count>

Predicate expression: ts_recent_week(<count>, <date>, <anchor>)
Start of range (inclusive): The first day of the week <count> weeks before the week containing the anchor.
End of range (inclusive): The last day of the week <count> weeks before the week containing the anchor.
Name component: "W-#" (such as "W-8")
Default label component: "W-#" (such as "W-8")
For a negative <count>: "W+#" (such as "W+8)

recent-months <count>

Predicate expression: ts_recent_month(<count>, <date>, <anchor>)
Start of range (inclusive): The first day of the month <count> months before the month containing the anchor.
End of range (inclusive): The last day of the month <count> months before the month containing the anchor.
Name component: "M-#" (such as "M-6")
Default label component: "M-#" (such as "M-6")
For a negative <count>: "M+#" (such as "M+6)

recent-quarters <count>

Predicate expression: ts_recent_quarter(<count>, <date>, <anchor>)
Start of range (inclusive): The first day of the quarter <count> quarters before the quarter containing the anchor.
End of range (inclusive): The last day of the quarter <count> quarters before the quarter containing the anchor.
Name component: "Q-#" (such as "Q-3")
Default label component: "Q-#" (such as "Q-3")
For a negative <count>: "Q+#" (such as "Q+3)

recent-tertiles <count>

Predicate expression: ts_recent_tertile(<count>, <date>, <anchor>)
Start of range (inclusive): The first day of the tertile <count> tertiles before the tertile containing the anchor.
End of range (inclusive): The last day of the tertile <count> tertiles before the tertile containing the anchor.
Name component: "T-#" (such as "T-2")
Default label component: "T-#" (such as "T-#2")
For a negative <count>: "T+#" (such as "T+2)

recent-halves <count>

Predicate expression: ts_recent_half(<count>, <date>, <anchor>)
Start of range (inclusive): The first day of the half <count> halves before the half containing the anchor.
End of range (inclusive): The last day of the half <count> halves before the half containing the anchor.
Name component: "H-#" (such as "H-2")
Default label component: "H-#" (such as "H-2")
For a negative <count>: "H+#" (such as "H+2)

recent-years <count>

Predicate expression: ts_recent_year(<count>, <date>, <anchor>)
Start of range (inclusive): The first day of the year <count> years before the year containing the anchor.
End of range (inclusive): The last day of the year <count> years before the year containing the anchor.
Name component: "Y-#" (such as "Y-3")
Default label component: "Y-#" (such as "Y-3")
For a negative <count>: "Y+#" (such as "Y+3)

Custom <name>

custom <name> start=<expression> end=<expression>

Predicate function: <date> >= <start-date> and <date> <= <end-date>
Start of range (inclusive): As specified.
End of range (inclusive): As specified.
Name component: Must be specified
Default label component: Same as the name component

Variations

default

This variation is implied, but it can be specified explicitly to change the label component (such as to "Current Year").

Name component: ""
Default label component: ""

previous-year

Formula: Compute the range with the anchor pushed back 1 year.
Name component: "LY"
Default label component: "LY"

Subvariation: previous-year difference

Formula: (TY - LY)
Name component: "TY Diff"
Default label component: "TY Diff"

Subvariation: previous-year percent-difference

Formula: pct_var(TY, LY)
Name component: "TY % Diff"
Default label component: "TY % Diff"
Default format: "#,##0.0\\%" (overrides the summary, range, variation format, but can be overridden in the variation)

previous-years <count>

This produces <count> additional columns per range per summary.

Formula: Compute the range with the anchor pushed back <index> years.
Name component: "Y-#" (such as "Y-1")
Default label component: "Y-#" (such as "Y-1")

Subvariation: previous-years <count> difference

Formula: (Y-<index>) - (Y-<index+1>)

Name component: "Y-# Diff" (such as "Y-1 Diff")

Default label component: "Y-# Diff" (such as "Y-1 Diff")

Subvariation: previous-years <count> percent-difference

Formula: pct_var((Y-<index+1>), (Y-<index>))
Name component: "Y-# % Diff" (such as "Y-1 % Diff")
Default label component: "Y-# % Diff" (such as "Y-1 % Diff") Default format: "#,##0.0\\%" (overrides summary, range, variation format, but can be overridden in the subvariation)

previous-range

Formula: Compute the range with the anchor pushed back based on the range. For example, previous-range for year-to-date is pushed back one year, previous-range for month-to-date is pushed back one month, previous-range for rolling 3 is pushed back three months.
Name component: "LR"for rolling-X; "LY" for year-to-date; "LW" for current week; and similarly for other ranges
Default label component: "LR" for rolling-X; "LY" for year-to-date; "LW" for current week; and similarly for other ranges

Subvariation: previous-range difference

Formula: (TR - LR)
Name component: "TR Diff" for rolling-X; "TY Diff" for year-to-date; "TW Diff" for current-week; and similarly for other ranges
Default label component: "TR Diff"for rolling-X; "TY Diff" for year-to-date; "TW Diff" for current-week; and similarly for other ranges

Subvariation: previous-range percent-difference

Formula: pct_var(TR, LR)
Name component: "TR % Diff" for rolling-X; "TY % Diff" for year-to-date; "TW % Diff" for current-week; and similarly for other ranges
Default label component: "TR % Diff" for rolling-X; "TY % Diff" for year-to-date; "TW % Diff" for current-week; and similarly for other ranges
Default format: "#,##0.0\\%" (overrides summary, range, variation format, but can be overridden in the variation)

previous-ranges <count>

This produces <count> additional columns per range per summary for a rolling-X, current-X, or X-to-date time period.

Formula: Compute the range with the anchor pushed back based on the range. For example, previous-ranges for year-to-date is pushed back X years, previous-ranges for month-to-date is pushed back X months, previous-ranges for rolling Y is pushed back X*Y months.
Name component: "R-#" (such as "R-1") for rolling-X; "Y-#" for year-to-date; "W-#" for week-to-date; and similarly for other ranges.
Default label component: "R-#" (such as "R-1") for rolling-X; "Y-#" for year-to-date; "W-#" for week-to-date; and similarly for other ranges

Subvariation: previous-ranges <count> difference

Formula: (R-<index>) - (R-<index+1>)
Name component: "R-# Diff" (such as "R-0 Diff", "R-1 Diff") for rolling-X; "Y-# Diff" for year-to-date; "W-# Diff" for current-week; and similarly for other ranges
Default label component: "R-# Diff" (such as "R-0 Diff", "R-1 Diff") for rolling-X; "Y-# Diff" for year-to-date; "W-# Diff" for current-week; and similarly for other ranges

Subvariation: previous-ranges <count> percent-difference

Formula: pct_var((R-<index+1>), (R-<index>))
Name component: "R-# % Diff" (such as"R-0 % Diff", "R-1 % Diff")for rolling-X; "Y-# %Diff" for year-to-date; "W-# %Diff" for current-week; and similarly for other ranges
Default label component: "R-# % Diff" (such as "R-0 % Diff", "R-1 % Diff") for rolling-X; "Y-# %Diff" for year-to-date; "W-# %Diff" for current-week; and similarly for other ranges
Default format: "#,##0.0\\%" (overrides summary, range, variation format, but can be overridden in the subvariation)