openalgo-charts 1.0.2 → 1.0.3

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 /** Library version string. Matches package.json (published npm release). */
-declare const VERSION = "1.0.2";
+declare const VERSION = "1.0.3";
 /** Returns the current library version. */
 declare function version(): string;
 
@@ -365,6 +365,12 @@ interface SeriesStyle {
     volumeScaled?: boolean;
     /** Whether the series is drawn and counted in autoscale. Default true. */
     visible?: boolean;
+    /** Optional label carried with the series (for host-drawn legends). */
+    title?: string;
+    /** Show the dashed horizontal last-price line across the plot. Default true. */
+    priceLineVisible?: boolean;
+    /** Show the last-value tag on the price axis. Default true. */
+    lastValueVisible?: boolean;
     color?: string;
     lineWidth?: number;
     /** Line dash style for line/step/area/HLC series. Default 'solid'. */
@@ -405,6 +411,14 @@ interface ChartTheme {
     axisFontSize?: number;
     /** Grid line dash style (default 'solid'). */
     gridStyle?: 'solid' | 'dashed' | 'dotted';
+    /** Crosshair line dash style (default 'dashed'). */
+    crosshairStyle?: 'solid' | 'dashed' | 'dotted';
+    /** Crosshair line width in device px (default 1 = hairline). */
+    crosshairWidth?: number;
+    /** Background of the crosshair value tags (defaults to `crosshair`). */
+    crosshairLabelBackground?: string;
+    /** Show the crosshair price/time value tags (default true). */
+    crosshairLabelVisible?: boolean;
     upColor: string;
     downColor: string;
     wickUpColor: string;
@@ -578,6 +592,20 @@ interface SeriesApi {
     createMarkers(): SeriesMarkers;
 }
 
+/**
+ * Axis label rendering (ARCHITECTURE.md §6, §5.3). Price axis (right strip) and
+ * time axis (bottom strip). Time labels switch from clock to date at IST day
+ * boundaries; gaps are already collapsed by the logical-index time scale.
+ */
+
+/**
+ * Boundary class of a time-axis label, passed to a custom `timeFormatter` as a
+ * hint so a host can render adaptive labels (year at year boundaries, month at
+ * month boundaries, day otherwise, clock intraday) — parity with common
+ * `tickMarkFormatter(time, tickMarkType)` APIs.
+ */
+type TickMarkType = 'year' | 'month' | 'day' | 'time' | 'timeWithSeconds';
+
 /**
  * A pane is one vertically-stacked drawing region (price pane, volume pane,
  * indicator pane). It owns a base + top canvas (ARCHITECTURE.md §3.1) and a
@@ -605,7 +633,7 @@ interface PaneRenderContext {
     /** Draw the horizontal (price) grid lines. */
     showHorzGrid: boolean;
     /** Optional custom time label formatter (UTC seconds -> string). Defaults to IST. */
-    timeFormatter?: (utcSeconds: number) => string;
+    timeFormatter?: (utcSeconds: number, tickMark?: TickMarkType) => string;
 }
 declare class Pane {
     readonly element: HTMLElement;
@@ -1061,7 +1089,7 @@ interface ChartOptions {
      * omitted, labels use IST (Indian market default). e.g. for UTC:
      * `(s) => new Date(s * 1000).toISOString().slice(11, 16)`.
      */
-    timeFormatter?: (utcSeconds: number) => string;
+    timeFormatter?: (utcSeconds: number, tickMark?: TickMarkType) => string;
 }
 interface AddSeriesOptions {
     /** Target pane index (0 = price). Higher panes are created on demand. */
@@ -1280,7 +1308,7 @@ declare class Chart {
      * Set a custom time-axis + crosshair label formatter (UTC seconds -> string)
      * at runtime. Pass undefined to restore the IST default.
      */
-    setTimeFormatter(fn: ((utcSeconds: number) => string) | undefined): void;
+    setTimeFormatter(fn: ((utcSeconds: number, tickMark?: TickMarkType) => string) | undefined): void;
     /** Swap the palette at runtime (dark/light toggle) without recreating the chart. */
     setTheme(theme: ChartTheme): void;
     /**
@@ -1294,7 +1322,7 @@ declare class Chart {
             horzLines?: boolean;
         };
         priceFormatter?: ((price: number) => string) | null;
-        timeFormatter?: ((utcSeconds: number) => string) | undefined;
+        timeFormatter?: ((utcSeconds: number, tickMark?: TickMarkType) => string) | undefined;
         crosshairMode?: CrosshairMode;
     }): void;
     panes(): readonly Pane[];
@@ -2126,4 +2154,4 @@ declare function lerp(a: number, b: number, t: number): number;
  */
 declare function roundToTick(value: number, step: number): number;
 
-export { ALT_PRESET, type AddSeriesOptions, type AggTick, BUILTIN_COMMANDS, type Bar, type BarUpdate, type BarsRequest, CandleBuilder, type CandleBuilderOptions, type CandleStyle, type CandleUpdate, Chart, type ChartEvent, type ChartOptions, type ChartTheme, type CrosshairMoveEvent, type CustomShortcut, DEFAULT_CANDLE_BUILDER_OPTIONS, DEFAULT_CANDLE_STYLE, DEFAULT_HISTOGRAM_STYLE, DEFAULT_KEYMAP, DEFAULT_PRICE_SCALE_OPTIONS, DEFAULT_THEME, DEFAULT_TIME_SCALE_OPTIONS, DEFAULT_TRADING_COLORS, type DataFeed, type DepthLevel, type DrawItem, EventMarkers, FakeDataFeed, type FeedScheduler, type HistogramStyle, type IPrimitive, IST_OFFSET_SECONDS, InvalidationLevel, type KeymapEntry, type LateTickPolicy, type LinePoint, type LogicalRange, LogoWatermark, type LogoWatermarkOptions, type LtpEvent, type MarkerPosition, type MarkerShape, type MarkerSize, type MarketDepth, type OpenAlgoConfig, OpenAlgoDataFeed, type OpenAlgoLiveConfig, OpenAlgoLiveDataFeed, type OpenAlgoTradeConfig, OpenAlgoTradeFeed, type OpenAlgoWsConfig, OpenAlgoWsFeed, type OrderSide$1 as OrderSide, type OrderType$1 as OrderType, type OriginalTime, Pane, type PaneInvalidation, type PlaceOrder, type PositionSide, PriceLine, type PriceLineOptions, type PriceRange, PriceScale, type PriceScaleId, type PriceScaleMode, type PriceScaleOptions, type PrimitiveHit, type PrimitiveHost, type PrimitiveRenderContext, type RendererEntry, type SeriesApi, type SeriesDataItem, type SeriesMarker, SeriesMarkers, type SeriesRenderContext, type SeriesStyle, type SeriesType, type ShortcutListItem, ShortcutManager, type ShortcutManagerOptions, type ShortcutPreset, type ShortcutScope, type ShortcutTriggerEvent, type Size, type SocketFactory, type SocketLike, type SupertrendPoint, type Tick, TickBarAggregator, type TickTimeframe, TimeScale, type TimeScaleOp, type TimeScaleOptions, type TradeFeed, type TradeMarkerVariant, TradeMarkersPrimitive, type TradingColors, TradingController, type TradingHost, type TradingLineStyle, type TradingLineVariant, type TradingOrder, type TradingOrderSide, type TradingOrderType, type TradingPosition, type TradingSettings, type TradingSyncPayload, type TradingTrade, type UTCSeconds, type UnsubscribeFn, VERSION, type VolumeMode, type WatermarkPosition, type Whitespace, type WsControlMessage, type WsMode, type WsState, type ZOrder, atr, autoscaleRange, bestHit, bitmapSize, clamp, compactVolume, conflateBars, conflateItems, conflationGroupSize, createChart, darkTheme, drawShape, effectiveMarkerPx, ema, emaSeries, epochMsToUtcSeconds, eventToCombo, formatCombo, formatIstDate, formatIstTime, formatIstTimeSeconds, formatSubscribe, formatUnsubscribe, generateBars, getChartType, intervalToSeconds, isNewIstDay, isReservedCombo, isValidCombo, isWhitespace, istStringToUtcSeconds, lerp, lightTheme, mapHistoryResponse, mapOrder, mapPosition, markerSizePx, mergeBars, niceTicks, normalizeCombo, optimalBarWidth, parseCombo, parseMessage, precisionForStep, registerChartType, registeredChartTypes, roundToTick, rowTimeToUtcSeconds, rsi, rsiSeries, snapToDevicePixel, supertrend, supertrendSeries, toBar, trueRange, utcSecondsToIstDateString, utcSecondsToIstParts, version, verticalGradient, watermarkRect };
+export { ALT_PRESET, type AddSeriesOptions, type AggTick, BUILTIN_COMMANDS, type Bar, type BarUpdate, type BarsRequest, CandleBuilder, type CandleBuilderOptions, type CandleStyle, type CandleUpdate, Chart, type ChartEvent, type ChartOptions, type ChartTheme, type CrosshairMoveEvent, type CustomShortcut, DEFAULT_CANDLE_BUILDER_OPTIONS, DEFAULT_CANDLE_STYLE, DEFAULT_HISTOGRAM_STYLE, DEFAULT_KEYMAP, DEFAULT_PRICE_SCALE_OPTIONS, DEFAULT_THEME, DEFAULT_TIME_SCALE_OPTIONS, DEFAULT_TRADING_COLORS, type DataFeed, type DepthLevel, type DrawItem, EventMarkers, FakeDataFeed, type FeedScheduler, type HistogramStyle, type IPrimitive, IST_OFFSET_SECONDS, InvalidationLevel, type KeymapEntry, type LateTickPolicy, type LinePoint, type LogicalRange, LogoWatermark, type LogoWatermarkOptions, type LtpEvent, type MarkerPosition, type MarkerShape, type MarkerSize, type MarketDepth, type OpenAlgoConfig, OpenAlgoDataFeed, type OpenAlgoLiveConfig, OpenAlgoLiveDataFeed, type OpenAlgoTradeConfig, OpenAlgoTradeFeed, type OpenAlgoWsConfig, OpenAlgoWsFeed, type OrderSide$1 as OrderSide, type OrderType$1 as OrderType, type OriginalTime, Pane, type PaneInvalidation, type PlaceOrder, type PositionSide, PriceLine, type PriceLineOptions, type PriceRange, PriceScale, type PriceScaleId, type PriceScaleMode, type PriceScaleOptions, type PrimitiveHit, type PrimitiveHost, type PrimitiveRenderContext, type RendererEntry, type SeriesApi, type SeriesDataItem, type SeriesMarker, SeriesMarkers, type SeriesRenderContext, type SeriesStyle, type SeriesType, type ShortcutListItem, ShortcutManager, type ShortcutManagerOptions, type ShortcutPreset, type ShortcutScope, type ShortcutTriggerEvent, type Size, type SocketFactory, type SocketLike, type SupertrendPoint, type Tick, TickBarAggregator, type TickMarkType, type TickTimeframe, TimeScale, type TimeScaleOp, type TimeScaleOptions, type TradeFeed, type TradeMarkerVariant, TradeMarkersPrimitive, type TradingColors, TradingController, type TradingHost, type TradingLineStyle, type TradingLineVariant, type TradingOrder, type TradingOrderSide, type TradingOrderType, type TradingPosition, type TradingSettings, type TradingSyncPayload, type TradingTrade, type UTCSeconds, type UnsubscribeFn, VERSION, type VolumeMode, type WatermarkPosition, type Whitespace, type WsControlMessage, type WsMode, type WsState, type ZOrder, atr, autoscaleRange, bestHit, bitmapSize, clamp, compactVolume, conflateBars, conflateItems, conflationGroupSize, createChart, darkTheme, drawShape, effectiveMarkerPx, ema, emaSeries, epochMsToUtcSeconds, eventToCombo, formatCombo, formatIstDate, formatIstTime, formatIstTimeSeconds, formatSubscribe, formatUnsubscribe, generateBars, getChartType, intervalToSeconds, isNewIstDay, isReservedCombo, isValidCombo, isWhitespace, istStringToUtcSeconds, lerp, lightTheme, mapHistoryResponse, mapOrder, mapPosition, markerSizePx, mergeBars, niceTicks, normalizeCombo, optimalBarWidth, parseCombo, parseMessage, precisionForStep, registerChartType, registeredChartTypes, roundToTick, rowTimeToUtcSeconds, rsi, rsiSeries, snapToDevicePixel, supertrend, supertrendSeries, toBar, trueRange, utcSecondsToIstDateString, utcSecondsToIstParts, version, verticalGradient, watermarkRect };