@pipsend/charts 2.3.18 → 2.3.20

package/dist/typings.d.ts

@@ -185,6 +185,11 @@ export declare class BrushTool extends DrawingToolBase {
 	startDrawingMode(): void;
 	stopDrawingMode(): void;
 	isDrawingModeActive(): boolean;
+	/**
+	 * A brush armed for its next stroke is not a drawing yet: it stays out of the
+	 * undo history, where restoring it would re-arm a brush the app does not hold.
+	 */
+	isComplete(): boolean;
 	private _onPointerDown;
 	private _onPointerMove;
 	private _onPointerUp;
@@ -1560,12 +1565,11 @@ export declare class TradingSessionsIndicator {
 	private _highlightSessions;
 	private _highlightSession;
 	private _highlightOverlaps;
-	private _getSessionOverlap;
-	private _highlightOverlapPeriod;
+	private _eachRun;
+	private _inSession;
+	private _hourIn;
 	private _createSessionBox;
 	private _createOverlapBox;
-	private _isTimeInSession;
-	private _getUTCHour;
 	private _clearSessionBoxes;
 	/**
 	 * Merge options into the running indicator and repaint.
@@ -2610,6 +2614,14 @@ export declare function setVolumeProfileData(indicator: VolumeProfileIndicator,
  * Time at a horizontal coordinate, extrapolated past the last bar.
  */
 export declare function timeFromCoordinate(chart: IChartApi, series: ISeriesApi<SeriesType>, x: number): Time | null;
+/**
+ * Offset of `timeZone` from UTC at `time`, in seconds. Undefined, `'UTC'` and
+ * unknown zones are 0.
+ *
+ * Resolved once per UTC day, and to the quarter hour only on days with a
+ * transition: asking `Intl` for every bar is too slow for a whole series.
+ */
+export declare function timeZoneOffset(timeZone: string | undefined, time: number): number;
 /**
  * Returns the current version as a string. For example `'1.0.0'`.
  */
@@ -4428,9 +4440,10 @@ export interface IHorzScaleBehavior<HorzScaleItem> {
 	 *
 	 * @param item - tickmark item
 	 * @param barsPerMark - how many bars apart marks must be at the current zoom
+	 * @param previous - the point before it on the scale, if any
 	 * @returns false to leave the tickmark out
 	 */
-	allowsTickMark?(item: TickMark, barsPerMark: number): boolean;
+	allowsTickMark?(item: TickMark, barsPerMark: number, previous: TimeScalePoint | undefined): boolean;
 	/**
 	 * Returns the maximum tickmark weight value for the specified tickmarks on the time scale.
 	 *
@@ -5867,6 +5880,15 @@ export interface LocalizationOptions<HorzScaleItem> extends LocalizationOptionsB
 	 * @defaultValue `'dd MMM \'yy'`
 	 */
 	dateFormat: string;
+	/**
+	 * IANA time zone of the time scale's tick marks and default labels, e.g. `'America/New_York'`.
+	 *
+	 * Data, and the times custom formatters and filters receive, stay in UTC; see {@link timeZoneOffset}.
+	 * Business-day data is never shifted. Unknown zones fall back to UTC.
+	 *
+	 * @defaultValue `undefined` (UTC)
+	 */
+	timeZone?: string;
 }
 /**
  * Represents basic localization options
@@ -7448,9 +7470,12 @@ export interface TimeScaleOptions extends HorzScaleOptions {
 	 * their labels not to overlap, so a filter can pick a regular grid that fits,
 	 * e.g. every 10 minutes when every 2 would crowd the axis.
 	 *
+	 * `previousTime` is the point before it (null for the first), to tell whether a
+	 * boundary falls between the two when no bar opens exactly on it.
+	 *
 	 * @defaultValue `undefined`
 	 */
-	tickMarkFilter?: (time: Time, tickMarkType: TickMarkType, barsPerMark: number) => boolean;
+	tickMarkFilter?: (time: Time, tickMarkType: TickMarkType, barsPerMark: number, previousTime: Time | null) => boolean;
 }
 /**
  * Represents a point on the time scale
@@ -7581,8 +7606,11 @@ export interface TradingPosition<TimeType> {
 }
 export interface TradingSession {
 	name: string;
+	/** Hour (0-23) in `timeZone`. */
 	startHour: number;
 	endHour: number;
+	/** IANA zone the hours are in, so the session follows its city's daylight saving. UTC when absent. */
+	timeZone?: string;
 	color: string;
 	opacity: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "private": false,
-  "version": "2.3.18",
+  "version": "2.3.20",
   "name": "@pipsend/charts",
   "author": "Pipsend",
   "license": "SEE LICENSE IN LICENSE",