@trdrs/quickcharts 4.0.0 → 4.1.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { C as ChartDatafeed, F as FeedBar, S as SymbolRow, D as DatafeedSearchOptions, a as SearchPage, b as SearchClassNode } from './symbols-6V22WaRX.js';
 export { B as BarMark, c as BarsEvent, d as DatafeedConfig, e as FeedUnavailableError, H as HistoryPage, M as MarkColorRole, f as MarkPlacement, g as MarkShape, O as OlderPageVerdict, h as SubscribeHandlers, i as SymbolNames, T as TimescaleMark, o as olderPageVerdict, s as symbolNames } from './symbols-6V22WaRX.js';
-import { an as en, C as ChartMessageKey, G as GlyphSourcePort, M as MagnetMode, d as CursorMode, N as TextEditFrame, K as TextDraft, L as LineStyle, I as IDrawing, m as DrawingCounts, D as DrawingStyle, _ as VisibilityPreset, W as ToolPreset, X as ToolTemplate, S as SerializedDrawing, o as DrawingPreferences, l as DrawingAssetPort } from './assets-Gg-UquDA.js';
-import { R as ResourceRef, C as ChartSaveLoadAdapter, q as ChartMeta, t as ChartBody, f as DrawingResourceContext, i as ResourceStore, u as DrawingsMeta, h as DrawingsBody, j as TemplateMeta, T as TemplateBody, v as LayoutMeta, w as LayoutBody, c as DrawingContextKind } from './resources-Le6flcEn.js';
-export { a as ChartLocalDrawingContext, D as DRAWING_CONTEXT_VERSION, b as DRAWING_DOCUMENT_VERSION, d as DrawingEntry, e as DrawingGroup, g as DrawingTombstone, L as LayoutSharedDrawingContext, M as MemoryResourcesOptions, x as ResourceAbortError, S as SymbolGlobalDrawingContext, y as TemplateKind, W as WriteOutcome, k as drawingContextKey, l as emptyDrawingDocument, m as liveDrawingEntries, n as liveDrawingGroups, z as memorySaveLoadAdapter, o as mergeDrawingDocuments, p as parseDrawingDocument, r as reviseDrawingDocument, s as sameDrawingContext } from './resources-Le6flcEn.js';
+import { ao as en, C as ChartMessageKey, G as GlyphSourcePort, M as MagnetMode, d as CursorMode, Q as TextEditFrame, N as TextDraft, L as LineStyle, I as IDrawing, m as DrawingCounts, D as DrawingStyle, $ as VisibilityPreset, X as ToolPreset, Y as ToolTemplate, S as SerializedDrawing, o as DrawingPreferences, l as DrawingAssetPort } from './assets-BF-NDyHl.js';
+import { b as ResourceRef, C as ChartSaveLoadAdapter, q as ChartMeta, t as ChartBody, h as DrawingResourceContext, R as ResourceStore, u as DrawingsMeta, j as DrawingsBody, T as TemplateMeta, a as TemplateBody, v as LayoutMeta, w as LayoutBody, e as DrawingContextKind } from './resources-C0cYryO9.js';
+export { c as ChartLocalDrawingContext, D as DRAWING_CONTEXT_VERSION, d as DRAWING_DOCUMENT_VERSION, f as DrawingEntry, g as DrawingGroup, i as DrawingTombstone, L as LayoutSharedDrawingContext, M as MemoryResourcesOptions, x as ResourceAbortError, S as SymbolGlobalDrawingContext, y as TemplateKind, W as WriteOutcome, k as drawingContextKey, l as emptyDrawingDocument, m as liveDrawingEntries, n as liveDrawingGroups, z as memorySaveLoadAdapter, o as mergeDrawingDocuments, p as parseDrawingDocument, r as reviseDrawingDocument, s as sameDrawingContext } from './resources-C0cYryO9.js';
 import { LineData, UTCTimestamp, HistogramData, WhitespaceData, IChartApi, ISeriesApi, CreatePriceLineOptions, PriceLineOptions, ISeriesPrimitive, Time, PriceScaleMode, SeriesType, SeriesAttachedParameter, TickMarkType } from 'lightweight-charts';
 import { D as DataStatus, S as SymbolInfo, P as PriceFormat } from './symbology-D3SLclrU.js';
 export { a as Subsession, b as SubsessionId, T as TickBand, p as parseTickBands, t as tickBandFor } from './symbology-D3SLclrU.js';
@@ -871,9 +871,16 @@ interface DictionaryLoader<Source extends Catalog, Code extends string = ChartLo
     has(code: Code): boolean;
 }
 
+declare const KEYS_ADDED_IN_MAJOR: readonly ["drawing.distance", "drawing.drawingMenu", "drawing.hintRemove"];
+type KeyAddedInMajor = (typeof KEYS_ADDED_IN_MAJOR)[number];
+
 type ChartTranslate = Translate<typeof en>;
-/** The widget's catalog in one language: every key of the English source, in the same shape. */
-type ChartDictionary = Translation<typeof en>;
+/** The widget's catalog in one language, as a dictionary of your own supplies it: the keys of the
+ *  English source in the same shape, a string for a string and a plural for a plural. Every key of
+ *  the major's first release is required. A key the catalog gains within the major is optional:
+ *  until your dictionary carries it, the chart reads it in English and reports it to `onMissing`,
+ *  and the next major makes it required. Each built-in language carries every key. */
+type ChartDictionary = Omit<Translation<typeof en>, KeyAddedInMajor> & Partial<Pick<Translation<typeof en>, KeyAddedInMajor>>;
 /** A locale a host adds beyond the built-in inventory: its stable code, canonical BCP 47 tag,
  *  reading direction, endonym, and the dictionary chunk to fetch the first time it is chosen. */
 interface ChartCustomLocale extends LocaleDefinition {
@@ -885,8 +892,9 @@ interface ChartI18nOptions {
     /** Locales registered beside the built-in inventory. A code or tag the inventory already holds
      *  is refused: the built-in dictionaries are not overridden through this door. */
     locales?: readonly ChartCustomLocale[];
-    /** Hears every key a loaded dictionary is missing; the text falls back to English. The typed
-     *  catalogs cannot miss a key, so this only ever reports a dictionary loaded from data. */
+    /** Hears every key a loaded dictionary is missing; the text falls back to English. A built-in
+     *  language carries every key, so this reports a dictionary of your own: one loaded from data,
+     *  or one without a key the catalog gained within the major. */
     onMissing?: (key: ChartMessageKey, locale: string) => void;
 }
 interface ChartI18n {
@@ -1207,6 +1215,8 @@ declare const chartDictionaries: DictionaryLoader<{
     readonly 'drawing.modifierCommand': "Cmd";
     readonly 'drawing.hintClone': "{modifier} + Drag";
     readonly 'drawing.hintCopy': "{modifier} + C";
+    readonly 'drawing.hintRemove': "Del";
+    readonly 'drawing.drawingMenu': "Drawing menu";
     readonly 'drawing.hintPaste': "{modifier} + V";
     readonly 'drawing.deleteWithKey': "Delete (Del)";
     readonly 'drawing.statusDrawingsHidden': "Drawings hidden";
@@ -1297,6 +1307,7 @@ declare const chartDictionaries: DictionaryLoader<{
     readonly 'drawing.sectionInfo': "Info";
     readonly 'drawing.priceRange': "Price range";
     readonly 'drawing.barsRange': "Bars range";
+    readonly 'drawing.distance': "Distance";
     readonly 'drawing.angle': "Angle";
     readonly 'drawing.statsPosition': "Stats position";
     readonly 'drawing.statsHidden': "Hidden";
@@ -2870,6 +2881,12 @@ interface ChartExtensionMenuContext {
     /** Viewport coordinates of the press. */
     clientX: number;
     clientY: number;
+    /** The table the press landed on, and whether a cell of it is being typed in; absent where it
+     *  landed on none. A press on a drawing raises that drawing's own menu, which carries the rows a
+     *  host contributes here in the places the chart's menu gives them. */
+    table?: {
+        cell: boolean;
+    };
 }
 /** One filled or stroked shape of a contributed glyph, on the menu's own 28-unit grid. Path data
  *  and a closed set of paint values are the whole vocabulary: a contribution carries no markup, no
@@ -4066,6 +4083,76 @@ interface ChartReplayApi {
 /** Off, waiting to be told where to start, or running. */
 type ReplayPhase = 'off' | 'arming' | 'on';
 
+/** Every action the menu can offer. A host handles the ids it supports and passes `has` flags for
+ *  the rest — an unsupported action simply never becomes a row. */
+type ChartMenuAction = 'table-add-column' | 'table-add-row' | 'table-remove-row' | 'table-remove-column' | 'reset-view' | 'copy-price' | 'paste' | 'remove-indicators' | 'remove-drawings' | 'settings';
+/** The glyph a row wears, named rather than drawn — the host owns the artwork. */
+type ChartMenuIcon = 'reset' | 'settings' | 'check' | 'table-add-column' | 'table-add-row' | 'delete';
+type ChartMenuRow = {
+    kind: 'separator';
+} | {
+    kind: 'item';
+    id: ChartMenuAction;
+    label: string;
+    shortcut?: string;
+    icon?: ChartMenuIcon;
+    /** A CHECKABLE row: state is marked with a checkmark in the icon cell and never by
+     *  rewording the label, so "Lock vertical cursor line by time" reads the same either way. */
+    checked?: boolean;
+};
+interface ChartMenuContext {
+    /** The level the pointer landed on, already formatted in the pane's own precision. */
+    priceText: string;
+    /** The pane's display symbol — a contributed row that acts on the market names it. */
+    symbol: string;
+    /** Counts drive both the wording and whether the row appears at all. */
+    indicatorCount: number;
+    drawingCount: number;
+    /** A drawing clipboard exists. Default true: Paste is offered whether or not anything
+     *  is copied, and pasting nothing is a no-op — but a host with no clipboard at all omits it. */
+    canPaste?: boolean;
+    /** A settings surface exists to open. Default true; a host without one omits the row. */
+    canSettings?: boolean;
+    /** The level lies on a table. Its rows add a column right of the cell being typed in and a row
+     *  below it, or at the table's ends where no cell is, and with a cell, remove its row and its
+     *  column. Omitted where the level lies on none. */
+    table?: {
+        cell: boolean;
+    };
+    /** The widget's language for the row labels. Omitted ⇒ English. */
+    t?: ChartTranslate;
+}
+/** The menu a level offers, in one fixed order. */
+declare function chartContextMenu(c: ChartMenuContext): ChartMenuRow[];
+
+/** A row the HOST contributed for this raise (through the chart's extension seam). It carries its
+ *  own action, so the painter routes nothing and a contributed row can never collide with a
+ *  built-in id. Structural on purpose: the menu has no dependency on who contributed or why. */
+interface ContextMenuExtraRow {
+    label: string;
+    shortcut?: string;
+    checked?: boolean;
+    /** An inert vector glyph for the shared gutter. */
+    icon?: ChartExtensionIcon;
+    /** `level` rows (the default) group under Copy price and Paste; `view` rows under the removes. */
+    group?: 'level' | 'view';
+    run(): void;
+}
+interface ContextMenuHandle {
+    /** Raise the menu at a viewport point, for the level the caller resolved. `extra` places the
+     *  contributed rows by their group between the built-ins; an empty list adds no separator. */
+    open(at: {
+        clientX: number;
+        clientY: number;
+    }, ctx: ChartMenuContext, extra?: readonly ContextMenuExtraRow[]): void;
+    close(): void;
+    destroy(): void;
+}
+/** `strings` is the chart's language: the rows are built through it every time the menu is raised,
+ *  and an open menu re-labels in place if the language changes under it. `icons` are the host's
+ *  drawings for the menu's own glyphs, as a chart takes them. */
+declare function mountContextMenu(container: HTMLElement, run: (id: ChartMenuAction) => void, strings?: ChartI18n, icons?: ChartIcons): ContextMenuHandle;
+
 /** The drawing surface a host drives: the layer's handle minus what the chart owns (symbol,
  *  timeframe, tick, price format, teardown) and minus the session verbs only the package's own
  *  surfaces use (the live `IDrawing`, the preview and edit session, the inline text session, the
@@ -5355,76 +5442,6 @@ declare function planPaneOp(state: PaneState, op: PaneOp): PanePlan;
  *  not collapsed anything. */
 declare function isCollapsed(height: number | undefined): boolean;
 
-/** Every action the menu can offer. A host handles the ids it supports and passes `has` flags for
- *  the rest — an unsupported action simply never becomes a row. */
-type ChartMenuAction = 'table-add-column' | 'table-add-row' | 'table-remove-row' | 'table-remove-column' | 'reset-view' | 'copy-price' | 'paste' | 'remove-indicators' | 'remove-drawings' | 'settings';
-/** The glyph a row wears, named rather than drawn — the host owns the artwork. */
-type ChartMenuIcon = 'reset' | 'settings' | 'check' | 'table-add-column' | 'table-add-row' | 'delete';
-type ChartMenuRow = {
-    kind: 'separator';
-} | {
-    kind: 'item';
-    id: ChartMenuAction;
-    label: string;
-    shortcut?: string;
-    icon?: ChartMenuIcon;
-    /** A CHECKABLE row: state is marked with a checkmark in the icon cell and never by
-     *  rewording the label, so "Lock vertical cursor line by time" reads the same either way. */
-    checked?: boolean;
-};
-interface ChartMenuContext {
-    /** The level the pointer landed on, already formatted in the pane's own precision. */
-    priceText: string;
-    /** The pane's display symbol — a contributed row that acts on the market names it. */
-    symbol: string;
-    /** Counts drive both the wording and whether the row appears at all. */
-    indicatorCount: number;
-    drawingCount: number;
-    /** A drawing clipboard exists. Default true: Paste is offered whether or not anything
-     *  is copied, and pasting nothing is a no-op — but a host with no clipboard at all omits it. */
-    canPaste?: boolean;
-    /** A settings surface exists to open. Default true; a host without one omits the row. */
-    canSettings?: boolean;
-    /** The level lies on a table. Its rows add a column right of the cell being typed in and a row
-     *  below it, or at the table's ends where no cell is, and with a cell, remove its row and its
-     *  column. Omitted where the level lies on none. */
-    table?: {
-        cell: boolean;
-    };
-    /** The widget's language for the row labels. Omitted ⇒ English. */
-    t?: ChartTranslate;
-}
-/** The menu a level offers, in one fixed order. */
-declare function chartContextMenu(c: ChartMenuContext): ChartMenuRow[];
-
-/** A row the HOST contributed for this raise (through the chart's extension seam). It carries its
- *  own action, so the painter routes nothing and a contributed row can never collide with a
- *  built-in id. Structural on purpose: the menu has no dependency on who contributed or why. */
-interface ContextMenuExtraRow {
-    label: string;
-    shortcut?: string;
-    checked?: boolean;
-    /** An inert vector glyph for the shared gutter. */
-    icon?: ChartExtensionIcon;
-    /** `level` rows (the default) group under Copy price and Paste; `view` rows under the removes. */
-    group?: 'level' | 'view';
-    run(): void;
-}
-interface ContextMenuHandle {
-    /** Raise the menu at a viewport point, for the level the caller resolved. `extra` places the
-     *  contributed rows by their group between the built-ins; an empty list adds no separator. */
-    open(at: {
-        clientX: number;
-        clientY: number;
-    }, ctx: ChartMenuContext, extra?: readonly ContextMenuExtraRow[]): void;
-    close(): void;
-    destroy(): void;
-}
-/** `strings` is the chart's language: the rows are built through it every time the menu is raised,
- *  and an open menu re-labels in place if the language changes under it. `icons` are the host's
- *  drawings for the menu's own glyphs, as a chart takes them. */
-declare function mountContextMenu(container: HTMLElement, run: (id: ChartMenuAction) => void, strings?: ChartI18n, icons?: ChartIcons): ContextMenuHandle;
-
 /** The session's name in English — what a host renders when it shows status text of its own. The
  *  widget's catalog carries the same five under `session.<state>`, keyed by these very names, so a
  *  host reading the catalog and a host reading this table always say the same thing. */