@barchart/chart-lib 2.394.4 → 2.395.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- chart-lib/barchart.chart.d.ts +2 -1
- chart-lib/barchart.chart.js +13 -13
- chart-lib/package.json +1 -1
- chart-lib/schemas/chart.schema.json +13 -2
chart-lib/barchart.chart.d.ts
CHANGED
|
@@ -852,7 +852,7 @@ declare module "@barchart/chart-lib" {
|
|
|
852
852
|
};
|
|
853
853
|
|
|
854
854
|
export type DisplayModel = {
|
|
855
|
-
/** An initial time period the data is confined to on the time scale.
|
|
855
|
+
/** An initial time period the data is confined to on the time scale. Use an ISO 8601 duration or `"YTD"`, which dynamically spans from January 1 through the latest data point. */
|
|
856
856
|
period?: string;
|
|
857
857
|
/** A number of **bars** the data is confined to on the time scale. The historical data is always right-aligned, meaning the latest (newest, most recent in time) data is to the right of the chart, then `density` number of bars is subtracted to arrive at the timestamp of the leftmost bar. */
|
|
858
858
|
density?: number;
|
|
@@ -1589,6 +1589,7 @@ declare module "@barchart/chart-lib" {
|
|
|
1589
1589
|
|
|
1590
1590
|
export interface PeriodAccessor {
|
|
1591
1591
|
id: string;
|
|
1592
|
+
/** `period` accepts an ISO 8601 duration or the dynamic `"YTD"` token. */
|
|
1592
1593
|
context: { period: string } | { range: { from?: number; to?: number } } | { density: number };
|
|
1593
1594
|
}
|
|
1594
1595
|
|