hyperprop-charting-library 0.1.23 → 0.1.25

package/docs/API.md

@@ -32,6 +32,8 @@ Top-level options:
 - `backgroundColor` (default `#101114`)
 - `axisColor` (legacy shorthand for axis line/text color)
 - `axis?: AxisOptions`
+- `xAxis?: AxisOptions` (overrides bottom-axis label text/font)
+- `yAxis?: AxisOptions` (overrides right-axis label text/font)
 - `priceDecimals` (default `2`, used for axis/ticker/line price labels)
 - `stabilizePriceLabels` (default `true`, prevents ticker/crosshair/price-tag width jitter)
 - `priceLabelMinIntegerDigits` (default `3`, baseline integer-digit width for stabilized labels)
@@ -50,6 +52,9 @@ Top-level options:
 - `candleBodyWidthRatio` (default `0.7`)
 - `candleMinWidth` (default `0.5`)
 - `candleWickWidth` (default `1`)
+- `tickSize` (default `0`; when > 0, formatter/pointer prices snap to tick)
+- `candleColorMode` (`"openClose" | "prevClose"`, default `"openClose"`)
+- `candleColorEpsilon` (default `-1` = auto from `priceDecimals`; set `0` to disable tolerance)
 - `autoScaleSmoothing` (default `0.16`)
 - `autoScaleIgnoreLatestCandle` (default `true`)
 - `doubleClickEnabled` (default `true`)
@@ -246,6 +251,9 @@ Connector/fill visuals:
 - `visible?: boolean` (default `true`)
 - `pane?: "overlay" | "separate"`
 - `paneHeightRatio?: number` (for separate panes; `0.08` to `0.45` recommended)
+- `zIndex?: number` (render order; lower first)
+- `excludeFromAutoscale?: boolean` (default `true` for indicator instances)
+- `overlayScaleWeight?: number` (`0..1`; only used when `excludeFromAutoscale` is `false`)
 - `inputs?: Record<string, unknown>` (plugin-specific parameters)
 
 ### `IndicatorPlugin`
@@ -267,7 +275,7 @@ Connector/fill visuals:
 
 Built-in:
 
-- `"volume"`: separate pane histogram (uses `OhlcDataPoint.v`)
+- `"volume"`: overlay histogram by default (uses `OhlcDataPoint.v`; can be moved to separate pane)
 - `"sma"`: Simple Moving Average (overlay)
 - `"ema"`: Exponential Moving Average (overlay)
 - `"rsi"`: Relative Strength Index (separate pane, 30/50/70 guides)
@@ -295,6 +303,13 @@ Volume/VWMA note:
 
 - if your data has no `v`, `volume`/`vwma` will have limited or no output.
 
+Volume style inputs:
+
+- `upOpacity`, `downOpacity`
+- `upColor`, `downColor`
+- `minBarWidth`
+- `overlayHeightRatio` (when used as overlay)
+
 ---
 
 ## `ChartInstance` Methods
@@ -323,6 +338,8 @@ Volume/VWMA note:
 - `setDoubleClickAction(action: "reset" | "placeLimitOrder"): void`
 - `registerIndicator(plugin: IndicatorPlugin): void`
 - `unregisterIndicator(type: string): void`
+- `listBuiltInIndicators(): BuiltInIndicatorInfo[]`
+- `getIndicators(): IndicatorInstanceOptions[]`
 - `addIndicator(type: string, inputs?: Record<string, unknown>, options?: Partial<IndicatorInstanceOptions>): string`
 - `updateIndicator(id: string, patch: Partial<IndicatorInstanceOptions>): void`
 - `removeIndicator(id: string): void`

package/docs/RECIPES.md

@@ -26,6 +26,45 @@ Use:
 - `autoScaleSmoothing` for smoother scale transitions
 - `autoScaleIgnoreLatestCandle` to reduce live-candle jitter
 
+## Tick-size aware chart precision
+
+```ts
+const chart = createChart(rootEl, {
+  tickSize: 0.25,
+  priceDecimals: 2
+});
+```
+
+## Style x-axis and y-axis labels differently
+
+```ts
+const chart = createChart(rootEl, {
+  axis: { lineColor: "#374151" },
+  xAxis: { textColor: "#9ca3af", fontSize: 11 },
+  yAxis: { textColor: "#e5e7eb", fontSize: 12 }
+});
+```
+
+## Stabilize candle up/down coloring on tiny deltas
+
+```ts
+const chart = createChart(rootEl, {
+  // default behavior
+  candleColorMode: "openClose",
+  // auto epsilon from priceDecimals (recommended)
+  candleColorEpsilon: -1
+});
+```
+
+Use previous-close mode if your UX expects green/red by last-close change:
+
+```ts
+const chart = createChart(rootEl, {
+  candleColorMode: "prevClose",
+  candleColorEpsilon: -1
+});
+```
+
 ## Add a static alert/level line
 
 ```ts
@@ -118,6 +157,26 @@ Recommended range:
 
 - `0.08` to `0.45` (library clamps to safe bounds)
 
+## Use indicator z-order and autoscale influence
+
+```ts
+chart.addIndicator("ema", { length: 34 }, { zIndex: 5 });
+chart.addIndicator("wma", { length: 55 }, { zIndex: 10 });
+
+chart.addIndicator("sma", { length: 200 }, {
+  excludeFromAutoscale: false,
+  overlayScaleWeight: 0.25
+});
+```
+
+## Query built-ins and active indicator instances
+
+```ts
+const builtIns = chart.listBuiltInIndicators();
+const active = chart.getIndicators();
+console.log({ builtIns, active });
+```
+
 ## Remove or hide indicators
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperprop-charting-library",
-  "version": "0.1.23",
+  "version": "0.1.25",
   "description": "Lightweight TypeScript charting core",
   "type": "module",
   "main": "./dist/hyperprop-charting-library.cjs",