@barchart/chart-lib 2.233.1 → 2.234.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.
@@ -1666,9 +1666,12 @@ declare module "@barchart/chart-lib" {
1666
1666
  | "SymbolNine"
1667
1667
  | "SymbolQuestion"
1668
1668
  | "SymbolFishHook"
1669
+ | "SymbolBuy"
1670
+ | "SymbolSell"
1669
1671
  | "FibonacciTimeZones"
1670
1672
  | "Text"
1671
- | "ComputedText"
1673
+ | "ProfitLoss"
1674
+ | "RewardRisk"
1672
1675
  | "DateRange"
1673
1676
  | "PriceRange"
1674
1677
  | "DatePriceRange"
@@ -2049,15 +2052,30 @@ declare module "@barchart/chart-lib" {
2049
2052
  getTimeSeries(query: ITimeSeriesQuery): ITimeSeries;
2050
2053
  }
2051
2054
 
2055
+ export type SymbolType =
2056
+ | "Unknown"
2057
+ | "Equity"
2058
+ | "EquityOption"
2059
+ | "Future"
2060
+ | "FutureOption"
2061
+ | "Forex"
2062
+ | "Index";
2063
+
2052
2064
  export interface MetaData {
2053
2065
  /** An initialization of sorts. Typically this is when we start loading the meta data (eager loading).
2054
2066
  * @returns A promise which resolves with a boolean specifying success or failure.
2055
2067
  */
2056
2068
  ready(): Promise<boolean>;
2069
+ pointValue: number;
2070
+ unitCode: string;
2071
+ symbol: string;
2072
+ symbolType: SymbolType;
2073
+ name: string;
2074
+ exchange: string;
2057
2075
  /** The key reason the meta data exists is to format the prices shown on the price scale, in tooltips, anywhere.
2058
2076
  * @param price The price to format.
2059
2077
  * @param field A field whose price this is. You may decide to format the prices differently for some fields. Typical example is `Volume` field which is almost always a huge number so it makes sense to format it with a magnitude specifier (thousands, millions, billions).
2060
- * @param option Additional formatting options, please treat as opaque for now.
2078
+ * @param options Additional formatting options, please treat as opaque for now.
2061
2079
  * @returns A string representation of the price.
2062
2080
  */
2063
2081
  format(price: number, field: Field, options: any): string;