@barchart/chart-lib 2.106.1 → 2.183.2

{package → chart-lib}/barchart.chart.d.ts

@@ -16,6 +16,20 @@ declare module "@barchart/chart-lib" {
      */
     export function formatPriceWithDecimals(price: number, decimals: number): string;
 
+    /**
+     * Helps if you need to know whether there's open interest for a symbol
+     * @param symbol A symbol name
+     * @returns True if the symbol has open interest
+     */
+    export function hasOpenInterest(symbol: string): boolean;
+
+    /**
+     *
+     * @param symbols An array of symbol names
+     * @returns {MetaData} A combination of sorts of the individual `MetaData` for each of the symbols; for example, if you had an expression involving 3 symbols the combined `MetaData` would have max decimals of all the symbols involved.
+     */
+    export function getCombinedMetaData(symbols: string[]): MetaData;
+
     export type FundamentalType =
         | "AccountsPayable"
         | "AccruedExpenses"
@@ -255,7 +269,7 @@ declare module "@barchart/chart-lib" {
         | "TR"
         | "IMPVOL"
         | "CTM"
-        | "GPMI"
+        | "CPMI"
         | "CTLTM"
         | "CTLTMF"
         | "DEMA"
@@ -295,7 +309,7 @@ declare module "@barchart/chart-lib" {
         | "LINRLOW"
         | "CSHO"
         | "CSHB"
-        | "GTPI"
+        | "CTPI"
         | "TCHRE"
         | "PCTCHG"
         | "ATRMA"
@@ -305,6 +319,7 @@ declare module "@barchart/chart-lib" {
         | "VSTOPLOW"
         | "SUPTR"
         | "BARCOLIX"
+        | "BARKIND"
         | "CONVLN"
         | "BASELN"
         | "LEADSP1"
@@ -323,7 +338,15 @@ declare module "@barchart/chart-lib" {
         | "BOLLSQ"
         | "TTMSQZON"
         | "TTMSQZOFF"
-        | "TTMSQZOSC";
+        | "TTMSQZOSC"
+        | "CRS"
+        | "CRSAVG"
+        | "JPIB"
+        | "JPIS"
+        | "DRS"
+        | "MRS"
+        | "PMO"
+        | "PMOS";
 
     export type GeneralFieldId =
         | "DateTime"
@@ -434,7 +457,7 @@ declare module "@barchart/chart-lib" {
         | "PIVPTS"
         | "IMPVOL"
         | "CTM"
-        | "GPMI"
+        | "CPMI"
         | "DEMA"
         | "TEMA"
         | "TSI"
@@ -450,7 +473,7 @@ declare module "@barchart/chart-lib" {
         | "LINRCHN"
         | "CSHO"
         | "CSHB"
-        | "GTPI"
+        | "CTPI"
         | "TCHRE"
         | "PCTCHG"
         | "OPINT"
@@ -465,7 +488,13 @@ declare module "@barchart/chart-lib" {
         | "DOSC"
         | "MARIB"
         | "HASMO"
-        | "TTMSQZ";
+        | "TTMSQZ"
+        | "CRS"
+        | "JPI"
+        | "CTTP"
+        | "DRS"
+        | "MRS"
+        | "PMO";
 
     type PlotType =
         | "Symbol"
@@ -678,6 +707,10 @@ declare module "@barchart/chart-lib" {
         annotationTraits?: AnnotationTraitsModel;
         /** Obsolete, please ignore. */
         curveTraits?: any[];
+        /** Will be `true` when all annotations are not supposed to move; their other properties, like line width, fill color etc. can still be changed.
+         * @default false
+         */
+        allAnnotationsLocked: boolean;
     };
 
     export type AnnotationModel = {
@@ -749,8 +782,11 @@ declare module "@barchart/chart-lib" {
         CH_CHTNEEDSCONTEXTMENU: string;
         CH_ANNSELECTIONCHANGED: string;
         CH_ANNPOINTPICKED: string;
+        CH_ANNMODIFIEDBYTOOL: string;
         CH_PANEHEIGHTSCHANGED: string;
         CH_PANESREORDERED: string;
+        CH_AXISSCALECHANGED: string;
+        CH_CHTLAYOUTCHANGED: string;
         CH_NODATAFORMAINSYMBOL: string;
         CH_CARDPLOTCLICKED: string;
         CH_CARDPLOTREMOVED: string;
@@ -767,6 +803,7 @@ declare module "@barchart/chart-lib" {
         TS_MANYCHANGED: string;
         TS_DATAPOINTADDED: string;
         TS_DATAPOINTCHANGED: string;
+        TS_TIMELINECORRECTION: string;
         TS_EVENTSCHANGED: string;
         MD_ALL: string;
         MD_CHANGED: string;
@@ -886,8 +923,20 @@ declare module "@barchart/chart-lib" {
 
     type HostingModel = "Page" | "Application";
 
+    type Environment = "Browser" | "NodeJs";
+
+    /**
+     * How should volume bars be colored:
+     * - `OpenToClose` same as main plot with `CurveAttribute` set to `OpenVsClose`
+     * - `CloseToClose` same as main plot with `CurveAttribute` set to `ChangeBased`
+     *
+     * By default, this is unset and the volume coloring will be identical to the main plot's bar coloring. This value  will only be used when the main plot does _not_ have any bar coloring set (for example, when the main plot is a line or an area plot).
+     */
+    export type DefaultVolumeBarColoring = "OpenToClose" | "CloseToClose";
+
     /** The configuration is extensively documented at our documentation site. */
     interface Config {
+        environment?: Environment;
         validateInput?: boolean;
         throttleMillis?: number;
         isAlt64?: boolean;
@@ -910,7 +959,10 @@ declare module "@barchart/chart-lib" {
         useAllFieldsForComparison?: boolean;
         credentials?: ICredentials;
         apiKey?: string;
+        defaultVolumeBarColoring?: DefaultVolumeBarColoring;
+        colorfulAnnotations?: boolean;
         fetch?(kind: UrlKind, relativeUrl: string): Promise<string>;
+        getCustomEventPopup(view: any): CustomEventPopup | null;
     }
 
     /** How should the chart be initialized on startup (if at all). Please note that this is suited for cases where the `template` is already made such that it matches the type of the main plot. This is not an issue: if the template doesn't match (main plot is set to a different kind of plot) the main plot will be replaced by the desired plot with all the values set to their defaults. */
@@ -985,6 +1037,11 @@ declare module "@barchart/chart-lib" {
         data: string;
     };
 
+    /** Additional attributes sometimes needed for drawing.
+     * - `ChangeBased`: when coloring bars, we need to know if the price movement was up or down; use the `Change` field to decide. Also known as 'Close-to-Close'.
+     * - `OpenVsClose`: like preceding phrase, but use `Open` and `Close` field values of the bar to decide. Also known as 'Open-to-Close'.
+     * The two attibutes are mutually exclusive, but we _may_ add new attributes which will be independent.
+     */
     type CurveAttribute = "ChangeBased" | "OpenVsClose";
 
     type CurveZone = {
@@ -998,11 +1055,6 @@ declare module "@barchart/chart-lib" {
 
     /** Curve is the second most important concept of the chart. It's a smallest drawable unit of time-series data. Most plots consist of several curves, each using a portion of the time-series fields associated with the plot. */
     export interface Curve {
-        /** Additional attributes sometimes needed for drawing.
-         * - `ChangeBased`: when deciding whether the price movement was up or down, use the `Change` field to decide.
-         * - `OpenVsClose`: like preceding phrase, but use `Open` and `Close` field values of the two consequtive bars to decide whether the trend is up or down.
-         * The preceding two attibutes are mutually exclusive, but this is not a rule, just an accident.
-         */
         attributes?: CurveAttribute[];
         /** The way the curve is drawn. */
         style?: CurveStyle;
@@ -1105,13 +1157,16 @@ declare module "@barchart/chart-lib" {
         dashStyle?: DashStyle;
     }
 
+    export interface ICrosshairContext {
+        crosshair: Orientation;
+        horizontal?: CrosshairProperties;
+        vertical?: CrosshairProperties;
+        haloTracking?: boolean;
+    }
+
     export interface CrosshairAccessor {
         id: string;
-        context: {
-            crosshair: Orientation;
-            horizontal?: CrosshairProperties;
-            vertical?: CrosshairProperties;
-        };
+        context: ICrosshairContext | { id: "Get" };
     }
 
     export type Orientation = "vertical" | "horizontal" | "both" | "none";
@@ -1154,6 +1209,7 @@ declare module "@barchart/chart-lib" {
     export interface OtherAccessor {
         id: string;
         context: {
+            id?: "Get" | "Update";
             /**
              * Deprecated. Use comparisonMode instead
              */
@@ -1166,6 +1222,7 @@ declare module "@barchart/chart-lib" {
             showNavigator?: boolean;
             plotHover?: boolean;
             showGoToLatest?: boolean;
+            allAnnotationsLocked?: boolean;
         };
     }
 
@@ -1207,6 +1264,7 @@ declare module "@barchart/chart-lib" {
         id: string;
         context: {
             plots?: ICompareItem[];
+            alignOnExpirations?: boolean;
         };
     }
 
@@ -1224,6 +1282,7 @@ declare module "@barchart/chart-lib" {
             id: "Delete" | "Update" | "Duplicate" | "List";
             uid?: string;
             visible?: boolean;
+            locked?: boolean;
             traits?: AnnotationTraits;
             extras?: {
                 [k: string]: any;
@@ -1380,14 +1439,18 @@ declare module "@barchart/chart-lib" {
 
     export type AnnotationId =
         | "Line"
+        | "Ray"
+        | "GannLine"
         | "VerticalLine"
         | "HorizontalLine"
         | "FiftyPercentLine"
         | "LongPosition"
         | "ShortPosition"
         | "FibonacciRetracement"
+        | "TrendBasedFibExtension"
         | "FibonacciFan"
         | "FibonacciArcs"
+        | "FibonacciChannel"
         | "GannFan"
         | "SpeedResistanceFan"
         | "SpeedResistanceArcs"
@@ -1399,23 +1462,35 @@ declare module "@barchart/chart-lib" {
         | "SymbolArrowDown"
         | "SymbolArrowRight"
         | "SymbolArrowLeft"
+        | "SymbolArrowHorizontal"
+        | "SymbolArrowVertical"
         | "SymbolArcDown"
         | "SymbolArcUp"
         | "SymbolThumbsUp"
         | "SymbolThumbsDown"
+        | "SymbolZero"
         | "SymbolOne"
         | "SymbolTwo"
         | "SymbolThree"
         | "SymbolFour"
         | "SymbolFive"
+        | "SymbolSix"
+        | "SymbolSeven"
+        | "SymbolEight"
+        | "SymbolNine"
         | "SymbolQuestion"
         | "SymbolFishHook"
         | "FibonacciTimeZones"
         | "Text"
-        | "ComputedText";
+        | "ComputedText"
+        | "DateRange"
+        | "PriceRange"
+        | "DatePriceRange"
+        | "GannBox"
+        | "GannSquare";
 
     export interface AnnotationPoint {
-        /** Price (y) coordianate. */
+        /** Price (y) coordinate. */
         price: number;
         /** Time (x) coordinate. Number because it is a JavaScript Date, milliseconds since Unix epoch. */
         time: number;
@@ -1429,10 +1504,12 @@ declare module "@barchart/chart-lib" {
         points: AnnotationPoint[];
         traits: AnnotationTraits;
         visible: boolean;
+        locked: boolean;
     }
 
     export interface AnnotationTraits {
         line?: LineTrait;
+        line2?: LineTrait;
         fill?: FillTrait;
 
         fill2?: FillTrait;
@@ -1452,6 +1529,15 @@ declare module "@barchart/chart-lib" {
         showPercentDiff?: boolean;
 
         showTrendline?: boolean;
+        drawBorder?: boolean;
+        showLeftLabels?: boolean;
+        showRightLabels?: boolean;
+        showTopLabels?: boolean;
+        showBottomLabels?: boolean;
+        showAngles?: boolean;
+        reverse?: boolean;
+        showRangesRatio?: boolean;
+
         factors?: Array<{ shown: boolean; value: number }>;
     }
 
@@ -1462,6 +1548,8 @@ declare module "@barchart/chart-lib" {
         traits: AnnotationTraits;
         extras: any;
         points: AnnotationPoint[];
+        locked: boolean;
+        visible: boolean;
         chart: ChartAccessor;
     }
 
@@ -1469,6 +1557,55 @@ declare module "@barchart/chart-lib" {
 
     export type RenderTo = string | HTMLElement;
 
+    /**
+     * Base class for the custom event popups. If you need to show custom events on a chart, you will likely
+     * want to derive from this class and then override @func showValue and @func hideValue methods
+     */
+    export class CustomEventPopup {
+        /** For internal use only */
+        view: any;
+        /** The date of the event */
+        date: Date;
+        /** The value of the event; opaque, chart does not interpret this in any way */
+        value: any;
+        /** Whether the popup is currently shown on the screen */
+        visible: boolean;
+        /** The popup HTML elements hosting the content */
+        popupElement: HTMLElement;
+        constructor(view: any);
+        /** Initial DOM setup; override if you need any additional initialization */
+        initialize();
+        /** Called when a value needs to be "shown"; basically means you should populate the DOM with the
+         * content, won't be called if the @member value doesn't change
+         */
+        showValue();
+        /** Called when hiding the popup, in case you need to do anything (most often you don't) */
+        hideValue();
+    }
+
+    /**
+     * Creates a DOM element and appends it into the @see element
+     * @param element DOM element to append the newly created element into
+     * @param nodeName Name of the DOM element to create
+     * @returns Newly created DOM element
+     */
+    export function appendDOMElement<N extends keyof HTMLElementTagNameMap>(
+        element: HTMLElement,
+        nodeName: N
+    ): HTMLElement;
+    /**
+     * Apply styles to a given DOM element
+     * @param element Element to style
+     * @param styles Key-value paris of styles to apply
+     */
+    export function styleDOMElement(element: HTMLElement, styles: object): void;
+    /**
+     * Apply attributes to a given DOM element
+     * @param element DOM element whose attributes are to be set
+     * @param attributes Key-value pairs of attributes and values to apply
+     */
+    export function setAttributesDOMElement(element: HTMLElement, attributes: object): void;
+
     /** Chart accessor is the main API entry point, it essentially _is_ the chart. */
     export class ChartAccessor {
         /** The only parameter for construction is `headless` which if set to `true` will create a chart without any kind of visual representation. This form of a chart is useful for template editors which don't render any content. */
@@ -1503,6 +1640,16 @@ declare module "@barchart/chart-lib" {
         print(options: { title: TitleOptions }): void;
         /** Reserved for internal use. */
         fromModel(model: ChartModel): void;
+        /** Returns `true` if @see undo method could be called in order to undo the last change to an annotation */
+        canUndo: boolean;
+        /** Returns `true` if @see redo method could be called in order to redo the last change to an annotation */
+        canRedo: boolean;
+        /** Reverts the last change made to any annotation */
+        undo(): void;
+        /** Does again the last change undone to an annotation */
+        redo(): void;
+        /** Starts (or resets) the interactive zoom */
+        zoom(zoomIn: boolean);
     }
 
     export enum SeriesKind {
@@ -1799,6 +1946,9 @@ declare module "@barchart/chart-lib" {
     /** So you don't have to store the instance of the data feed - just call this method. The data feed is your root entry point to all APIs. */
     function getFeed<T extends BaseDataFeed>(): T | null;
 
+    /** Shuts down the data feed, severing any and all connections to server(s). For performance reasons, should almost never be called. */
+    function shutdownFeed(): void;
+
     export interface IChartOutline {
         isTemplate: boolean;
         isDefinition: boolean;
@@ -1948,10 +2098,12 @@ declare module "@barchart/chart-lib" {
         | "HollowCandles"
         | "HeikinAshi"
         | "ElderImpulseSystem"
-        | "Renko";
-    /*| "LineBreak"
+        | "Renko"
+        | "Range"
+        | "LineBreak"
         | "Kagi"
-        | "PointAndFigure";*/
+        | "PointAndFigure"
+        | "Baseline";
 
     interface Taxonomies {
         studies: Study[];
@@ -2209,6 +2361,7 @@ declare module "@barchart/chart-lib" {
     export {
         initFeed,
         getFeed,
+        shutdownFeed,
         getChartOutline,
         BarchartSiteDataFeed,
         MarketDataFeed,