@fintatech/fintachart 3.1.3 → 3.1.5

package/d.ts/FintaChart.d.ts

@@ -2047,6 +2047,20 @@ declare module FintaChart {
          */
         formatRealtime(data: any): ITick;
     }
+    /**
+     * Configuration shape accepted by the generic `Datafeed` wrapper.
+     */
+    interface IGenericDatafeedConfig {
+        /**
+         * Base URI of the REST data source.
+         */
+        url: string;
+        /**
+         * Polling interval for realtime updates, in milliseconds.
+         * Defaults to 5000 ms when omitted.
+         */
+        realtimeUpdateInterval?: number;
+    }
     /**
      * Provides rest data feed
      *
@@ -2095,6 +2109,21 @@ declare module FintaChart {
         private onSubscribe;
         private onUnsubscribe;
     }
+    /**
+     * Generic options-object datafeed used by the quick-start examples:
+     *
+     * ```javascript
+     * new FintaChart.Datafeed({ url: '/api/bars' });
+     * ```
+     *
+     * Thin wrapper over `RestDatafeed` that accepts a configuration
+     * object rather than positional arguments. The two-string positional
+     * form (`new Datafeed('/api', 5000)`) is also supported for parity
+     * with `RestDatafeed`.
+     */
+    class Datafeed extends RestDatafeed {
+        constructor(config: IGenericDatafeedConfig | string, realtimeUpdateInterval?: number);
+    }
 }
 declare module FintaChart {
     /**
@@ -2199,12 +2228,10 @@ declare module FintaChart {
     }
 }
 declare module FintaChart {
-    /**
-     * Represents extension event
-     */
     abstract class Eventable {
         private _preventPropagation;
         private _chart;
+        private _targetSubscriptions;
         /**
          * Chart
          */
@@ -2224,6 +2251,25 @@ declare module FintaChart {
          * @return
          */
         preventPropagation(preventEvents?: boolean): boolean;
+        /**
+         * Subscribes to events fired with this object as their target.
+         *
+         * Routes through the chart's event emitter and filters to events
+         * whose `target === this`, so multiple instances of the same class
+         * (e.g. several shapes) each receive only their own events.
+         *
+         * @param events Space-delimited event name(s).
+         * @param handler Listener invoked with the matching event.
+         * @return This instance for chaining.
+         */
+        on(events: string, handler: IEventHandler): Eventable;
+        /**
+         * Unsubscribes from events previously registered via `on`.
+         *
+         * Omitting `handler` removes every listener for `events`; omitting
+         * both removes every listener registered through this `Eventable`.
+         */
+        off(events?: string, handler?: IEventHandler): Eventable;
     }
 }
 declare module FintaChart {
@@ -3082,6 +3128,42 @@ declare module FintaChart {
         readonly purple: any;
         readonly sky: any;
         readonly teal: any;
+        /**
+         * Look up a built-in theme by string name (case-insensitive).
+         * Returns `null` if the name is unknown.
+         */
+        byName(name: string): any;
+        /**
+         * Sets the default theme applied to subsequent `new Chart(...)`
+         * instances that don't pass an explicit `theme` option. Accepts
+         * either a string name (`'Dark'`, `'Light'`, …) or a theme object.
+         */
+        use(theme: any): void;
+        /**
+         * @internal Returns the theme previously selected via `use()`,
+         * or `null` if no global override is set.
+         */
+        readonly currentDefault: any;
+    };
+    /**
+     * Capitalised alias surface — `FintaChart.Theme.Dark`,
+     * `FintaChart.Theme.Light`, `FintaChart.Theme.use('Dark')`.
+     * Resolves to the same theme objects as `FintaChart.Themes`.
+     */
+    const Theme: {
+        readonly Default: any;
+        readonly Light: any;
+        readonly Dark: any;
+        readonly FintatechDark: any;
+        readonly Beet: any;
+        readonly Gray: any;
+        readonly Olive: any;
+        readonly Orange: any;
+        readonly Purple: any;
+        readonly Sky: any;
+        readonly Teal: any;
+        byName(name: string): any;
+        use(theme: any): void;
     };
     /**
      * Represents stroke theme
@@ -3346,6 +3428,12 @@ declare module FintaChart {
         private onFullScreenChange;
         private onFullWindowChange;
     }
+    /**
+     * Alias for `ChartContainer`. Both names appear in the public guides
+     * (`FintaChart.ChartContainer` and `FintaChart.ChartsContainer`); both
+     * resolve to the same class on the runtime.
+     */
+    const ChartsContainer: typeof ChartContainer;
 }
 declare module FintaChart {
 }
@@ -4655,7 +4743,9 @@ declare module FintaChart {
          */
         get renderer(): IRenderer;
         /**
-         * The size of the canvas.
+         * The size of the canvas in CSS pixels (matches the legacy jQuery `.width()`/`.height()`
+         * behavior — distinct from the canvas element's `width`/`height` attributes which carry
+         * the device-pixel backing-store size on HiDPI displays).
          */
         get size(): ISize;
         set size(value: ISize);
@@ -5177,6 +5267,10 @@ declare module FintaChart {
      */
     class ColorPicker {
         private _picker;
+        private _initialized;
+        private _pendingConfig?;
+        private _pendingColor?;
+        private _observer?;
         /**
          * Retrieves Control Color Picker's color
          *
@@ -5196,6 +5290,9 @@ declare module FintaChart {
         static hide(control: HTMLElement): void;
         static enable(control: HTMLElement, enable: boolean): void;
         enable(value?: boolean): void;
+        private static isElementReady;
+        private initSpectrum;
+        private waitForAttach;
         private static initParams;
         private static palette;
         private static adopt;
@@ -5620,6 +5717,7 @@ declare module FintaChart {
         private _jumpToBtn;
         private _playPauseBtn;
         private _replayChartText;
+        private _startRecordPromptEl;
         private _speedInput;
         private _speedItemContainer;
         private _speedSelectDropdown;
@@ -5684,6 +5782,12 @@ declare module FintaChart {
          * Jumps to
          */
         jumpTo(): void;
+        /**
+         * Surfaces the start-record prompt and arms jumpTo so the next pane click
+         * sets the replay start point. Called when a user clicks play/forward/toRealTime
+         * before any start record has been chosen.
+         */
+        promptForStartRecord(): void;
         /**
          * Plays
          */
@@ -5717,8 +5821,11 @@ declare module FintaChart {
          * Returns last bar from original series
          */
         getLastOriginBar(): IBar;
+        private bindControlClicks;
         private subscribe;
         private createReplayChartText;
+        private showStartRecordPrompt;
+        private hideStartRecordPrompt;
         private disabledButton;
         private enabledButton;
         private generateSpeedItems;
@@ -9062,6 +9169,21 @@ declare module FintaChart {
          * get pane height ratio
          */
         get paneHeightRatio(): number;
+        /**
+         * Pins the indicator to an explicit pane before it is attached to
+         * a chart via `chart.addIndicators(...)`.
+         *
+         * Suppresses the default routing (which uses `isOverlay` to decide
+         * between the primary pane and a freshly-created pane) and aligns
+         * `isOverlay` with the chosen pane so subsequent layout / merge
+         * behaviour remains consistent.
+         *
+         * Used internally by `Pane.addIndicator(...)` and
+         * `Chart.addIndicatorInNewPane(...)`; rarely needed directly.
+         *
+         * @param pane The pane this indicator should live on.
+         */
+        placeOnPane(pane: Pane): void;
         /**
          * Get indicator parameters
          */
@@ -9148,6 +9270,12 @@ declare module FintaChart {
          * @param belowColor
          */
         addPlotArea(name: string, name2: string, aboveColor: string, belowColor: string): void;
+        /**
+         * Bind indicator to a vertical scale
+         *
+         * @param verticalScale
+         */
+        bindToVerticalScale(verticalScale: VerticalScale): this;
         dispose(): void;
         /**
          * Paint indicator
@@ -9369,11 +9497,19 @@ declare module FintaChart {
         /**
          * Creates new indicator instance of specified type name.
          *
+         * The second argument is overloaded: pass a `Chart` to attach the
+         * indicator to it immediately, or pass a plain object to seed
+         * parameter values (`{ period: 20, source: 'close' }`). Both forms
+         * may be combined via the three-argument variant.
+         *
          * @param typeName The type name of indicator.
-         * @param chart The chart to add indicator to.
+         * @param chartOrParameters Either the chart instance, or a
+         * parameters object applied via `updateParameters` after construction.
+         * @param parameters Optional parameters when the second argument
+         * already specifies a chart.
          * @return Indicator instance of given type.
          */
-        static create(typeName: string, chart: Chart): Indicator;
+        static create(typeName: string, chartOrParameters?: Chart | Record<string, unknown>, parameters?: Record<string, unknown>): Indicator;
         /**
          * Restores chart type from a previously saved state.
          *
@@ -13081,6 +13217,7 @@ declare module FintaChart {
         private _settings;
         private _titleNeedsUpdate;
         private _toggleIndicatorTitles;
+        private _targetSubscriptions;
         private _optimizeRefresh;
         private _watermark;
         private chartContextMenu;
@@ -13246,6 +13383,26 @@ declare module FintaChart {
          * @param objects
          */
         addObjects(objects: IPaneObject | IPaneObject[]): any;
+        /**
+         * Attaches an indicator to this specific pane.
+         *
+         * Pins the indicator's pane before `chart.addIndicators(...)` runs
+         * the auto-routing, so the indicator lands here regardless of its
+         * `isOverlay` declaration. Use to force an overlay-style indicator
+         * onto a separate pane, or to drop an oscillator-style one onto
+         * the price pane.
+         *
+         * @param indicator Indicator instance to add.
+         * @return The added indicator.
+         */
+        addIndicator(indicator: Indicator): Indicator;
+        /**
+         * Adds a single shape to the pane (convenience alias for
+         * `addShapes` when working with one shape at a time).
+         *
+         * @param shape Shape instance to add.
+         */
+        addShape(shape: Shape): void;
         /**
          * Adds plots
          *
@@ -13452,6 +13609,21 @@ declare module FintaChart {
         private setupLayoutTheme;
         private paintGridLines;
         private invoke;
+        /**
+         * Subscribes to events fired with this pane as their target
+         * (e.g. `PaneEvent.PLOT_ADDED` from this specific pane, not any).
+         *
+         * Routes through the chart's event emitter and filters by
+         * `event.target === this`.
+         *
+         * @param events Space-delimited event name(s).
+         * @param handler Listener invoked with the matching event.
+         */
+        on(events: string, handler: IEventHandler): Pane;
+        /**
+         * Unsubscribes from events previously registered via `on`.
+         */
+        off(events?: string, handler?: IEventHandler): Pane;
         private getHeight;
         private getWidth;
         private onClick;
@@ -15070,6 +15242,7 @@ declare module FintaChart {
         private _isSelfRaisedEvent;
         private _mode;
         private _preFullWindowSize;
+        private _preFullWindowOffset;
         private _prevMode;
         private _boundOnFullScreenChanged;
         private _boundOnWindowResize;
@@ -15086,7 +15259,6 @@ declare module FintaChart {
         private enterFullScreen;
         private exitFullScreen;
         private onFullScreenChange;
-        private static updateDropDownItemIcon;
         private updateDropdown;
         private toggleWindowMode;
     }
@@ -16117,6 +16289,21 @@ declare module FintaChart {
          */
         minWidth: number;
     }
+    enum PlotHistogramStyle {
+        LINE = "line",
+        COLORED_LINE = "coloredLine",
+        COLORED_BAR_LINE = "coloredBarLine",
+        COLORED_MEAN_BAR_LINE = "coloredMeanBarLine",
+        COLUMN = "column",
+        COLORED_COLUMN = "coloredColumn",
+        BYDATES = "bydates"
+    }
+    /**
+     * Public alias matching the name used in documentation
+     * (`FintaChart.HistogramPlotStyle.COLORED_COLUMN`). Resolves to the
+     * same enum values as `PlotHistogramStyle` and `HistogramPlot.Style`.
+     */
+    const HistogramPlotStyle: typeof PlotHistogramStyle;
     /**
      * Represents plot histogram
      *
@@ -19822,6 +20009,18 @@ declare module FintaChart {
         paintVerticalAxisLabels(): void;
         hitTest(point: IPoint): boolean;
     }
+    /**
+     * Convenience constructor for a horizontal price line.
+     *
+     * Accepts the shorthand `{ value, stroke: { color, width } }` form
+     * documented in the quick-start guide and translates it into the
+     * canonical Shape config (`{ point: { value }, theme: { line: ... } }`).
+     * Falls through unchanged for already-canonical configs.
+     */
+    class HorizontalLine extends HorizontalLineShape {
+        constructor(config?: any);
+        private static normalize;
+    }
 }
 declare module FintaChart {
     /**
@@ -23897,6 +24096,11 @@ declare module FintaChart {
          * Get chart primary pane
          */
         get primaryPane(): Pane;
+        /**
+         * Alias for `primaryPane`. Both names appear across the public
+         * documentation, so both are supported on the runtime.
+         */
+        get mainPane(): Pane;
         /**
          * Get chart mouse events enabled
          */
@@ -24112,6 +24316,16 @@ declare module FintaChart {
          * @return Added chart pane
          */
         addPane(index?: number, heightRatio?: number, reducePrimaryPane?: boolean): Pane;
+        /**
+         * Creates a fresh pane below the existing ones and attaches the
+         * given indicator to it, ignoring the indicator's `isOverlay`
+         * preference. Convenience wrapper around `addPane` +
+         * `Pane.addIndicator`.
+         *
+         * @param indicator The indicator instance to add.
+         * @return The added indicator.
+         */
+        addIndicatorInNewPane(indicator: Indicator): Indicator;
         /**
          * Adds vertical scale
          *
@@ -24180,6 +24394,11 @@ declare module FintaChart {
          * @return Data range
          */
         dateRange(startDate?: Date, endDate?: Date): any;
+        /**
+         * Alias for `dispose()`. Both names are documented across the
+         * public guides; both are supported on the runtime.
+         */
+        destroy(removeContainer?: boolean): void;
         /**
          * Destroys container
          *
@@ -24489,6 +24708,17 @@ declare module FintaChart {
          * @param updateInstruments
          */
         refresh(updateInstruments?: boolean): void;
+        /**
+         * Triggers a repaint after direct property mutations (theme,
+         * options, etc.) that don't go through their own setters.
+         * Alias for `refresh()`.
+         */
+        setNeedsUpdate(): void;
+        /**
+         * Alias for `refresh()`. Intended for resize / orientation-change
+         * handlers in mobile and responsive embeddings.
+         */
+        update(updateInstruments?: boolean): void;
         /**
          * refreshes indicators
          */

package/localization/en.json

@@ -451,7 +451,8 @@
     "fullWindow": "Full Window",
     "fullScreen": "Full Screen",
     "defaultScreen": "Default Screen",
-    "defaultWindow": "Default Window"
+    "defaultWindow": "Default Window",
+    "defaultMode": "Default Mode"
   },
   "templates": {
     "create": "Create Template",
@@ -795,6 +796,7 @@
     "toRealTime": "To Real Time",
     "pause": "Pause",
     "chartText": "Replay",
+    "startRecordPrompt": "Click a bar to set the replay start point",
     "notification": {
       "text": "To load more history, exit from replay mode",
       "compareInstrumentText": "To add compare instrument, exit from replay mode"

package/localization/uk.json

@@ -444,7 +444,8 @@
     "fullWindow": "Повне вікно",
     "fullScreen": "Повний екран",
     "defaultScreen": "Стандартний екран",
-    "defaultWindow": "Стандартне вікно"
+    "defaultWindow": "Стандартне вікно",
+    "defaultMode": "Стандартний режим"
   },
   "templates": {
     "create": "Створити шаблон",
@@ -756,6 +757,7 @@
     "toRealTime": "До реального часу",
     "pause": "Пауза",
     "chartText": "Повтор",
+    "startRecordPrompt": "Клікніть по бару, щоб обрати точку старту відтворення",
     "notification": {
       "text": "Щоб завантажити більше історії, вийдіть з режиму відтворення",
       "compareInstrumentText": "Щоб додати інструмент порівняння, вийдіть з режиму відтворення"

package/package.json

@@ -2,7 +2,7 @@
     "name": "@fintatech/fintachart",
     "description": "FintaChart financial charting component",
     "homepage": "https://fintatech.com",
-    "version": "3.1.3",
+    "version": "3.1.5",
     "types": "./d.ts/FintaChart.d.ts",
     "license": "SEE LICENSE IN LICENSE.md",
     "repository": {
@@ -39,6 +39,7 @@
         "gulp-if": "~3.0.0",
         "gulp-inject": "~5.0.5",
         "gulp-javascript-obfuscator": "^1.1.6",
+        "gulp-postcss": "^10.0.0",
         "gulp-preprocess": "~4.0.2",
         "gulp-rename": "~2.0.0",
         "gulp-replace": "~1.1.3",
@@ -50,6 +51,7 @@
         "gulp-util": "~3.0.8",
         "lazypipe": "~1.0.2",
         "merge-stream": "~2.0.0",
+        "postcss-prefix-selector": "^2.1.1",
         "run-sequence": "~2.2.1",
         "sass": "~1.54.9",
         "serve-static": "~1.15.0",
@@ -59,4 +61,4 @@
         "typedoc-plugin-merge-modules": "~4.0.1",
         "typescript": "~4.8.3"
     }
-}
+}