Skip to content

Interface: LayoutYaxisRangebreak ​

One item of rangebreaks.

Template defaults for every item go in rangebreakdefaults.

Properties ​

PropertyTypeDefault valueDescription
bounds?readonly unknown[]undefinedLower and upper bound of the break. Without pattern: values in data units (['2024-01-06', '2024-01-08']). With pattern: 'day of week': day numbers 0–6 (Sunday = 0) or English day names (['sat', 'mon'] hides Saturday and Sunday). With pattern: 'hour': hours 0–24 ([17, 9] hides 17:00–09:00, wrapping past midnight). Patterns use UTC days and hours.
dvalue?number86400000Size of each break in values, in data units (milliseconds on date axes). Default: one day. Minimum: 0
enabled?booleantrueWhether this range break is applied.
name?stringundefinedName of this rangebreak, used to reference it from a template via templateitemname.
pattern?"" | "day of week" | "hour"undefinedHow bounds repeat: day of week or hour (date axes only), or '' for a single span. Defaults to day of week when bounds names days, else ''.
templateitemname?stringundefinedName of a template rangebreak to inherit from. If no template item matches, this rangebreak is hidden (visible: false).
values?readonly unknown[]undefinedIndividual values to hide when no bounds are given, each hiding [value, value + dvalue) (e.g. holidays on a date axis).
visible?booleantrueSet to false (by the template machinery) when templateitemname names no template break; hidden breaks are ignored like disabled ones.

Released under the MIT License.