@pipsend/charts 2.1.0 → 2.2.0

package/dist/typings.d.ts

@@ -1906,9 +1906,9 @@ export declare function applyEMA(series: ISeriesApi<SeriesType>, chart: IChartAp
  * Draw a source series as Heikin Ashi candles.
  *
  * The source series is left in place holding its real prices — it is only
- * hidden — so indicators bound to it keep computing on the true OHLC, and
- * `remove()` puts the chart back exactly as it was. That makes this usable as a
- * chart-type toggle:
+ * painted transparent — so indicators bound to it keep computing on the true
+ * OHLC, its price lines and primitives stay on screen, and `remove()` puts the
+ * chart back exactly as it was. That makes this usable as a chart-type toggle:
  *
  * ```js
  * const ha = applyHeikinAshi(candleSeries, chart);
@@ -2474,6 +2474,21 @@ export declare function defaultHorzScaleBehavior(): new () => IHorzScaleBehavior
  * Now ignores symbol and uses price-based detection
  */
 export declare function getPipConfig(symbolOrPrice: string | number, price?: number): PipConfig;
+/**
+ * Take a series off the screen without hiding it.
+ *
+ * `visible: false` takes down everything hung off the series as well: its
+ * price lines, primitives and price-axis label stop rendering. A transform
+ * that only wants the bars themselves out of the way — Heikin Ashi drawing
+ * over its source — needs the series to stay visible to the engine, so its
+ * paint is made transparent instead and the last-value label and price line
+ * are switched off. Custom series have no known colours; those fall back to
+ * `visible: false`.
+ *
+ * @param series - Series to blank out.
+ * @returns Puts back the options the series had when it was blanked.
+ */
+export declare function hideSeriesPaint(series: ISeriesApi<SeriesType>): () => void;
 /**
  * Check if a time value is a business day object.
  *
@@ -3680,8 +3695,11 @@ export interface HeikinAshiOptions {
 	/** Wick color of falling candles. */
 	wickDownColor?: string;
 	/**
-	 * Hide the source series while the Heikin Ashi candles are shown, so the two
-	 * do not overlap. The original visibility is restored by `remove()`.
+	 * Blank out the source series while the Heikin Ashi candles are shown, so
+	 * the two do not overlap. The source is painted transparent rather than
+	 * hidden: it stays visible to the engine, so its price lines, primitives
+	 * and everything else hung off it keep rendering. `remove()` puts its paint
+	 * back.
 	 *
 	 * @defaultValue `true`
 	 */

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.0",
+  "version": "2.2.0",
   "name": "@pipsend/charts",
   "author": "Pipsend",
   "license": "SEE LICENSE IN LICENSE",