@graphysdk/geom-candlestick

中文文档
0.1.1-beta.1794847602792发布于 2026/11/17SEE LICENSE IN LICENSE.mdTypeScriptESM + CJS零依赖近 30 天下载 1.6万

Candlestick geom for the Graphy charting SDK (beta)

原始使用文档
文档目录5 节
  1. Install
  2. Usage
  3. Docs
  4. Feedback
  5. Licence

@graphysdk/geom-candlestick

Beta. This geom is on a 0.x version line: a minor release may change its aesthetics, style parts or look. Use a caret range (^0.1.0) to take only patches.

A candlestick geom for the Graphy charting SDK. It draws each trading session's open, high, low and close as a body between the open and close and a wick from the low to the high, coloured by whether the session rose or fell.

Learn more at graphy.dev.

Install

npm install @graphysdk/geom-candlestick @graphysdk/react

Requires React 19. Its only peer is @graphysdk/react.

Usage

Data is one row per session. Map the session to x, and the four prices to open, high, low and close:

import { createGraphyKit, GraphRenderer } from '@graphysdk/react';
import { candlestick } from '@graphysdk/geom-candlestick';

const kit = createGraphyKit({ plugins: [candlestick] });

const spec = kit.pipe(
  kit.createSpec({ x: 'date' }),
  kit.geom.candlestick({ aes: { open: 'open', high: 'high', low: 'low', close: 'close' } }),
  kit.scale.x.discrete(),
  kit.scale.y.continuous()
);

export function Prices({ data }) {
  return (
    <kit.GraphProvider spec={spec} data={data}>
      <GraphRenderer />
    </kit.GraphProvider>
  );
}

Set params: { width } to change how much of its band each body spans, a fraction in (0, 1] defaulting to 0.6, as on a bar.

The close is the candle's y, so a highlight or headline that reads y reads the close. A y in the root mapping is ignored on the candlestick layer, with a warning.

Colour the sessions with kit.style.geom.candlestick.rising() and kit.style.geom.candlestick.falling(), the wicks with kit.style.geom.candlestick.wick(), and the bodies' shared look with kit.style.geom.candlestick().

color is opt-in. Map it to candlestickDirection to colour the directions through a colour scale with a legend, or to a data column to colour the candles by its groups. A mapped colour beats the direction parts' built-in look and defaults entries; an overrides entry beats it.

Docs

Feedback

This geom is released early to hear what works. Tell us on Discord.

Licence

This package is available under PolyForm Noncommercial, Small Business, or a 32-day Free Trial. Free Trial is local or internal evaluation only — it does not cover a public page. See what you can do under the trial.

For a commercial licence, talk to us.

版本与发布记录

@graphysdk/geom-candlestick 共发布 187 个版本,首次发布于 2026/09/30;过去 12 个月发布了 187 个版本。

版本发布日期距今
0.1.1-beta.1794847602792latest2026/11/17今天
0.1.1-beta.17948408135452026/11/16今天
0.1.1-beta.17948401073962026/11/16今天
0.1.1-beta.17948274193392026/11/16今天
0.1.1-beta.17945866913282026/11/143 天前
0.1.1-beta.17945823311012026/11/133 天前

关于 @graphysdk/geom-candlestick 的常见问题

@graphysdk/geom-candlestick 是什么?

Candlestick geom for the Graphy charting SDK (beta)

如何安装 @graphysdk/geom-candlestick?

在项目目录运行 npm install @graphysdk/geom-candlestick,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^19.0.0)、@graphysdk/react(^1.9.0-beta.1794847602792)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphysdk/geom-candlestick 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graphysdk/geom-candlestick 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@graphysdk/geom-candlestick 可以商用吗?

@graphysdk/geom-candlestick 使用 SEE LICENSE IN LICENSE.md 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@graphysdk/geom-candlestick 的下载量有多少?

根据 npm 官方下载统计,@graphysdk/geom-candlestick 在 2026/10/17 – 2026/11/15 这 30 天内被下载 15,981 次,日均约 533 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graphysdk/geom-candlestick 还在维护吗?

最新版本 0.1.1-beta.1794847602792 发布于 2026/11/17(今天);至今共发布 187 个版本,其中过去 12 个月发布了 187 个;首次发布于 2026/09/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。