charton API / @chart-on/core / index / Seasonality
Interface: Seasonality
Defined in: packages/core/src/seasonality/view.ts:38
A seasonality view on a chart, from createSeasonality.
Properties
averageSeries
readonlyaverageSeries:LineSeries|null
Defined in: packages/core/src/seasonality/view.ts:48
The average path's line series, or null without average.
data
readonlydata:SeasonalData|null
Defined in: packages/core/src/seasonality/view.ts:42
The computed paths, or null before any bars arrived.
ready
readonlyready:Promise<void>
Defined in: packages/core/src/seasonality/view.ts:40
Settles once the first load finishes; rejects with the ChartError when it fails.
years
readonlyyears: readonlynumber[]
Defined in: packages/core/src/seasonality/view.ts:44
The years shown, oldest first.
Methods
applyOptions()
applyOptions(
options):void
Defined in: packages/core/src/seasonality/view.ts:55
Change options and recompute every path.
Parameters
options
Partial<SeasonalOptions> & Pick<SeasonalityOptions, "range" | "colors" | "averageColor">
Returns
void
dispose()
dispose():
void
Defined in: packages/core/src/seasonality/view.ts:57
Remove the view's series and restore the chart's time labels.
Returns
void
isYearVisible()
isYearVisible(
year):boolean
Defined in: packages/core/src/seasonality/view.ts:51
Parameters
year
number
Returns
boolean
setBars()
setBars(
bars):void
Defined in: packages/core/src/seasonality/view.ts:53
Replace the daily bars (for views made with bars).
Parameters
bars
readonly Bar[]
Returns
void
setYearVisible()
setYearVisible(
year,visible):void
Defined in: packages/core/src/seasonality/view.ts:50
Show or hide one year. Only that line changes: the others and the average stay as they are.
Parameters
year
number
visible
boolean
Returns
void
yearSeries()
yearSeries(
year):LineSeries|null
Defined in: packages/core/src/seasonality/view.ts:46
The line series of year, or null when it is not shown.
Parameters
year
number
Returns
LineSeries | null