@tradecanvas/chart 1.51.0 → 1.52.0

package/dist/widget/WidgetSettings.d.ts

@@ -29,12 +29,15 @@ export declare class WidgetSettings {
     private returnFocus;
     private readonly uid;
     /**
-     * `barCountdown` / `logScale` false leave out the controls for features the
-     * chart has switched off.
+     * `barCountdown` / `logScale` / `legend` / `volume` false leave out the
+     * controls for features the chart has switched off: there they would do
+     * nothing.
      */
     constructor(callbacks: SettingsCallbacks, t: Translator, available?: {
         barCountdown?: boolean;
         logScale?: boolean;
+        legend?: boolean;
+        volume?: boolean;
         /** The exchange's time zone to offer (null while unknown), or undefined when there is none to offer. */
         exchangeZone?: () => string | null | undefined;
         /** false: the chart doesn't trade, so the orders' colours aren't offered. */
@@ -47,6 +50,11 @@ export declare class WidgetSettings {
     isOpen(): boolean;
     /** The settings as they are now (after an undo, a template), on the tab that's open; `chartType` when it changed. */
     refresh(settings: ChartSettingsState, chartType?: ChartType | null): void;
+    /** The place of the control in focus among the panel's, or null when focus is not in the panel. */
+    private focusedControl;
+    /** Focus the panel's control at `index`, or its last when it has fewer; the tab when it has none. */
+    private focusControl;
+    private panelControls;
     /** Close, keeping what was changed (as OK does). */
     close(): void;
     destroy(): void;
@@ -69,7 +77,7 @@ export declare class WidgetSettings {
     private renderTabContent;
     /** The chart type's own settings and colours, the main series, the last price, the volume, the high and low. */
     private renderSymbolTab;
-    /** The legend over the chart: shown or not, its colours. */
+    /** The legend over the chart: shown or not, its colours; the panes' titles. */
     private renderStatusLineTab;
     /** The price scale's mode and behaviour, its labels, the time zone, how numbers are written, the axes' colours. */
     private renderScalesTab;

package/dist/widget/WidgetSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WidgetSettings.d.ts","sourceRoot":"","sources":["../../src/widget/WidgetSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,SAAS,EAAyC,MAAM,sBAAsB,CAAC;AAC/G,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAsB,MAAM,YAAY,CAAC;AAY5F,OAAO,EAAyB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAEnE,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;AAmBnG;;;;;GAKG;AACH,qBAAa,cAAc;IAyBvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAQ1B,2FAA2F;IAC3F,OAAO,CAAC,QAAQ,CAAC,IAAI;IAjCvB,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,CAAC,CAAa;IACtB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,WAAW,CAAkC;IACrD,OAAO,CAAC,IAAI,CAAkC;IAC9C,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,eAAe,CAAmC;IAC1D,8DAA8D;IAC9D,OAAO,CAAC,SAAS,CAA0B;IAC3C,0HAA0H;IAC1H,OAAO,CAAC,QAAQ,CAA+C;IAC/D,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAoB;IAExC;;;OAGG;gBAED,SAAS,EAAE,iBAAiB,EAC5B,CAAC,EAAE,UAAU,EACI,SAAS,GAAE;QAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,wGAAwG;QACxG,YAAY,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAC/C,6EAA6E;QAC7E,OAAO,CAAC,EAAE,OAAO,CAAC;KACd;IACN,2FAA2F;IAC1E,IAAI,GAAE,MAAM,WAAiC;IAMhE,0FAA0F;IAC1F,IAAI,CAAC,eAAe,EAAE,kBAAkB,EAAE,SAAS,GAAE,SAAS,GAAG,IAAW,EAAE,GAAG,GAAE,WAAsB,GAAG,IAAI;IAUhH,MAAM,IAAI,OAAO;IAIjB,qHAAqH;IACrH,OAAO,CAAC,QAAQ,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI;IAOzE,oDAAoD;IACpD,KAAK,IAAI,IAAI;IAIb,OAAO,IAAI,IAAI;IAIf,uFAAuF;IACvF,OAAO,CAAC,MAAM;IASd,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,UAAU;IAoClB,OAAO,CAAC,WAAW;IAgBnB,uEAAuE;IACvE,OAAO,CAAC,SAAS;IAiCjB,wDAAwD;IACxD,OAAO,CAAC,WAAW;IAmBnB,OAAO,CAAC,YAAY;IAUpB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,SAAS;IAOjB,2GAA2G;IAC3G,OAAO,CAAC,QAAQ;IAYhB,oGAAoG;IACpG,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,gBAAgB;IAkBxB,gHAAgH;IAChH,OAAO,CAAC,eAAe;IAavB,4DAA4D;IAC5D,OAAO,CAAC,mBAAmB;IAO3B,mHAAmH;IACnH,OAAO,CAAC,eAAe;IAyBvB,0FAA0F;IAC1F,OAAO,CAAC,mBAAmB;IAY3B,kHAAkH;IAClH,OAAO,CAAC,eAAe;IA8BvB,OAAO,CAAC,UAAU;IAOlB,0EAA0E;IAC1E,OAAO,CAAC,iBAAiB;IAIzB,0GAA0G;IAC1G,OAAO,CAAC,OAAO;IAoDf,OAAO,CAAC,UAAU;IAQlB,iGAAiG;IACjG,OAAO,CAAC,sBAAsB;IA+C9B,OAAO,CAAC,KAAK;CAId"}
+{"version":3,"file":"WidgetSettings.d.ts","sourceRoot":"","sources":["../../src/widget/WidgetSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,SAAS,EAAyC,MAAM,sBAAsB,CAAC;AAC/G,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAsB,MAAM,YAAY,CAAC;AAY5F,OAAO,EAAyB,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AAEnE,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;AA4BnG;;;;;GAKG;AACH,qBAAa,cAAc;IA0BvB,OAAO,CAAC,QAAQ,CAAC,SAAS;IAU1B,2FAA2F;IAC3F,OAAO,CAAC,QAAQ,CAAC,IAAI;IApCvB,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,CAAC,CAAa;IACtB,OAAO,CAAC,QAAQ,CAA+B;IAC/C,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,WAAW,CAAkC;IACrD,OAAO,CAAC,IAAI,CAAkC;IAC9C,OAAO,CAAC,UAAU,CAAiB;IACnC,OAAO,CAAC,eAAe,CAAmC;IAC1D,8DAA8D;IAC9D,OAAO,CAAC,SAAS,CAA0B;IAC3C,0HAA0H;IAC1H,OAAO,CAAC,QAAQ,CAA+C;IAC/D,OAAO,CAAC,WAAW,CAA4B;IAC/C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAoB;IAExC;;;;OAIG;gBAED,SAAS,EAAE,iBAAiB,EAC5B,CAAC,EAAE,UAAU,EACI,SAAS,GAAE;QAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,wGAAwG;QACxG,YAAY,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;QAC/C,6EAA6E;QAC7E,OAAO,CAAC,EAAE,OAAO,CAAC;KACd;IACN,2FAA2F;IAC1E,IAAI,GAAE,MAAM,WAAiC;IAMhE,0FAA0F;IAC1F,IAAI,CAAC,eAAe,EAAE,kBAAkB,EAAE,SAAS,GAAE,SAAS,GAAG,IAAW,EAAE,GAAG,GAAE,WAAsB,GAAG,IAAI;IAUhH,MAAM,IAAI,OAAO;IAIjB,qHAAqH;IACrH,OAAO,CAAC,QAAQ,EAAE,kBAAkB,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,GAAG,IAAI;IAWzE,mGAAmG;IACnG,OAAO,CAAC,cAAc;IAOtB,qGAAqG;IACrG,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,aAAa;IAIrB,oDAAoD;IACpD,KAAK,IAAI,IAAI;IAIb,OAAO,IAAI,IAAI;IAIf,uFAAuF;IACvF,OAAO,CAAC,MAAM;IASd,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,UAAU;IAoClB,OAAO,CAAC,WAAW;IAgBnB,uEAAuE;IACvE,OAAO,CAAC,SAAS;IAiCjB,wDAAwD;IACxD,OAAO,CAAC,WAAW;IAmBnB,OAAO,CAAC,YAAY;IAUpB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,SAAS;IAOjB,2GAA2G;IAC3G,OAAO,CAAC,QAAQ;IAYhB,oGAAoG;IACpG,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,gBAAgB;IAkBxB,gHAAgH;IAChH,OAAO,CAAC,eAAe;IAevB,+EAA+E;IAC/E,OAAO,CAAC,mBAAmB;IAS3B,mHAAmH;IACnH,OAAO,CAAC,eAAe;IAyBvB,0FAA0F;IAC1F,OAAO,CAAC,mBAAmB;IAY3B,kHAAkH;IAClH,OAAO,CAAC,eAAe;IA8BvB,OAAO,CAAC,UAAU;IAOlB,0EAA0E;IAC1E,OAAO,CAAC,iBAAiB;IAIzB,0GAA0G;IAC1G,OAAO,CAAC,OAAO;IAoDf,OAAO,CAAC,UAAU;IAQlB,iGAAiG;IACjG,OAAO,CAAC,sBAAsB;IA+C9B,OAAO,CAAC,KAAK;CAId"}

package/dist/widget/chartSettingsStore.d.ts

@@ -0,0 +1,76 @@
+import { ChartTypeOptions } from '@tradecanvas/commons';
+import { KeyValueStorage } from './DrawingTemplateStore.js';
+import { ChartSettingsState } from './types.js';
+type SettingsKey = keyof ChartSettingsState;
+/** Where `persistSettings` keeps the settings unless it names a key. */
+export declare const DEFAULT_SETTINGS_KEY = "tcw:chart-settings";
+/** The viewer's own: a layout or a link from someone else leaves them as they are. */
+export declare const VIEWER_KEYS: ReadonlySet<SettingsKey>;
+/**
+ * What `persistSettings` leaves out: besides the flags never kept, a chart
+ * type's own settings, which are the chart's state (a layout loaded puts
+ * its own in their place).
+ */
+export declare const PERSIST_LEAVES: ReadonlySet<SettingsKey>;
+/**
+ * What a layout's `settings` leaves out: the viewer's own, the scale and its
+ * flip (fields of their own there), and a chart type's own settings (in the
+ * chart's state).
+ */
+export declare const LAYOUT_LEAVES: ReadonlySet<SettingsKey>;
+/**
+ * What a shared link's `settings` leaves out: the viewer's own and the scale
+ * (a field of its own there). The link has no other place for the flip or a
+ * chart type's own settings, so they go in it.
+ */
+export declare const SHARE_LEAVES: ReadonlySet<SettingsKey>;
+/** Nothing left out: every setting of the right kind. */
+export declare const ALL_SETTINGS: ReadonlySet<SettingsKey>;
+/** The chart types with settings of their own (Renko's box, Kagi's reversal…), each a key of `chartTypeOptions`. */
+export declare const TYPES_WITH_SETTINGS: readonly (keyof ChartTypeOptions)[];
+/** Whether a chart type has settings of its own. */
+export declare function hasTypeSettings(type: unknown): type is keyof ChartTypeOptions;
+/**
+ * Only the chart types given settings: one at its defaults (`{}`) is as one
+ * never set, though the chart lists every type it was given.
+ */
+export declare function typesWithSettings(options: ChartTypeOptions): ChartTypeOptions;
+/** Every chart type with settings of its own at its defaults: given to the chart, it resets them all. */
+export declare function typesAtDefaults(): ChartTypeOptions;
+/**
+ * Chart Settings read from anywhere (storage, a layout, a link, a host's
+ * call): only the known keys, each of its kind, numbers in the settings'
+ * ranges, a time zone and a number format this browser knows. `leave` names
+ * the keys not to take.
+ */
+export declare function readChartSettings(raw: unknown, leave?: ReadonlySet<SettingsKey>): Partial<ChartSettingsState>;
+/** Every setting but those in `leave`. */
+export declare function pickSettings(settings: ChartSettingsState, leave: ReadonlySet<SettingsKey>): Partial<ChartSettingsState>;
+/** The settings that differ from `base`, but those in `leave`. */
+export declare function settingsDelta(settings: ChartSettingsState, base: ChartSettingsState, leave: ReadonlySet<SettingsKey>): Partial<ChartSettingsState>;
+/**
+ * What a shared link carries: the settings that differ from `base`, but
+ * those in `SHARE_LEAVES`, with a chart type's own settings only for the
+ * types that have some (a link should stay short).
+ */
+export declare function shareDelta(settings: ChartSettingsState, base: ChartSettingsState): Partial<ChartSettingsState>;
+/** The key `persistSettings` names; null when it is off. */
+export declare function settingsStoreKey(option: boolean | {
+    key?: string;
+} | undefined): string | null;
+/**
+ * The Chart Settings a user changed, kept in this browser's storage under one
+ * key (`persistSettings`). What is read back is checked; what can't be read
+ * is left out.
+ */
+export declare class ChartSettingsStore {
+    private readonly key;
+    private readonly storage;
+    constructor(key: string, storage?: KeyValueStorage | null);
+    /** What was kept; nothing when nothing readable was. */
+    load(): Partial<ChartSettingsState>;
+    /** Keep what differs from `defaults` (the host's), so a default the host changes later still reaches a user who never touched it. */
+    save(settings: ChartSettingsState, defaults: ChartSettingsState): void;
+}
+export {};
+//# sourceMappingURL=chartSettingsStore.d.ts.map

package/dist/widget/chartSettingsStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chartSettingsStore.d.ts","sourceRoot":"","sources":["../../src/widget/chartSettingsStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAIrD,KAAK,WAAW,GAAG,MAAM,kBAAkB,CAAC;AAE5C,wEAAwE;AACxE,eAAO,MAAM,oBAAoB,uBAAuB,CAAC;AASzD,sFAAsF;AACtF,eAAO,MAAM,WAAW,EAAE,WAAW,CAAC,WAAW,CAAsD,CAAC;AACxG;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,WAAW,CAA6D,CAAC;AAClH;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,WAAW,CAAC,WAAW,CAEjD,CAAC;AACH;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,WAAW,CAAsE,CAAC;AACzH,yDAAyD;AACzD,eAAO,MAAM,YAAY,EAAE,WAAW,CAAC,WAAW,CAA0B,CAAC;AAE7E,oHAAoH;AACpH,eAAO,MAAM,mBAAmB,EAAE,SAAS,CAAC,MAAM,gBAAgB,CAAC,EAAkE,CAAC;AAEtI,oDAAoD;AACpD,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,MAAM,gBAAgB,CAE7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAG7E;AAED,yGAAyG;AACzG,wBAAgB,eAAe,IAAI,gBAAgB,CAElD;AAyDD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,GAAE,WAAW,CAAC,WAAW,CAAgB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAS3H;AAED,0CAA0C;AAC1C,wBAAgB,YAAY,CAAC,QAAQ,EAAE,kBAAkB,EAAE,KAAK,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAIvH;AAED,kEAAkE;AAClE,wBAAgB,aAAa,CAAC,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,WAAW,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAIlJ;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,kBAAkB,EAAE,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAE9G;AAED,4DAA4D;AAC5D,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,CAG9F;AAUD;;;;GAIG;AACH,qBAAa,kBAAkB;IAE3B,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,eAAe,GAAG,IAAuB;IAGrE,wDAAwD;IACxD,IAAI,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAWnC,qIAAqI;IACrI,IAAI,CAAC,QAAQ,EAAE,kBAAkB,EAAE,QAAQ,EAAE,kBAAkB,GAAG,IAAI;CAOvE"}

package/dist/widget/chartTemplates.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chartTemplates.d.ts","sourceRoot":"","sources":["../../src/widget/chartTemplates.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAIzE,+FAA+F;AAC/F,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtC,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAoBD,6DAA6D;AAC7D,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAY1E;AAiBD;;;GAGG;AACH,qBAAa,kBAAkB;IAE3B,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,GAAG,SAAwB,EAC3B,OAAO,GAAE,eAAe,GAAG,IAAuB;IAGrE,+BAA+B;IAC/B,IAAI,IAAI,aAAa,EAAE;IAgBvB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI;IAIvC,4FAA4F;IAC5F,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,KAAK,EAAE,kBAAkB,GAAG,OAAO;IAYpF,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAO3B"}
+{"version":3,"file":"chartTemplates.d.ts","sourceRoot":"","sources":["../../src/widget/chartTemplates.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAIzE,+FAA+F;AAC/F,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtC,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAaD,6DAA6D;AAC7D,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAE1E;AAiBD;;;GAGG;AACH,qBAAa,kBAAkB;IAE3B,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,GAAG,SAAwB,EAC3B,OAAO,GAAE,eAAe,GAAG,IAAuB;IAGrE,+BAA+B;IAC/B,IAAI,IAAI,aAAa,EAAE;IAgBvB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI;IAIvC,4FAA4F;IAC5F,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,KAAK,EAAE,kBAAkB,GAAG,OAAO;IAYpF,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAO3B"}

package/dist/widget/compareLegend.d.ts

@@ -0,0 +1,20 @@
+import { CompareValue } from '@tradecanvas/core';
+import { IndicatorLegendRow } from './WidgetIndicatorLegend.js';
+/**
+ * A compared symbol's price, in decimals of its own by its size (65,432.10,
+ * 0.1002): the chart's decimals are the main symbol's, which would write a
+ * 0.1002 coin as 0.10.
+ */
+export declare function formatComparePrice(price: number, locale?: string): string;
+/** A change in percent with its sign (+8.45%, -7.69%), none when it reads as nothing. */
+export declare function formatChangePercent(change: number, locale?: string): string;
+/**
+ * The legend's rows for the symbols compared in percent (`chart.getCompareValues`):
+ * each one marked in its line's colour, its price and its change since its
+ * first bar on screen, as the percent scale reads it, in the legend's text
+ * colour: no one colour reads as text on both the dark and the light theme. Where the chart draws
+ * no compare lines (`drawn` false: Renko, Kagi and the like), each row is
+ * dimmed, without values, as an indicator off its intervals is.
+ */
+export declare function compareLegendRows(values: readonly CompareValue[], locale?: string, drawn?: boolean): IndicatorLegendRow[];
+//# sourceMappingURL=compareLegend.d.ts.map

package/dist/widget/compareLegend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compareLegend.d.ts","sourceRoot":"","sources":["../../src/widget/compareLegend.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAQrE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,SAAU,GAAG,MAAM,CAE1E;AAED,yFAAyF;AACzF,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,SAAU,GAAG,MAAM,CAG5E;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,YAAY,EAAE,EAAE,MAAM,SAAU,EAAE,KAAK,UAAO,GAAG,kBAAkB,EAAE,CAUvH"}