@graphysdk/geom-funnel

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

Funnel geom for the Graphy charting SDK (beta)

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

@graphysdk/geom-funnel

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 funnel geom for the Graphy charting SDK. It shows how many of a starting count reach each stage of a process: one bar per stage, centred on a common line and as long as the stage's count, with a band joining each bar to the next so the narrowing reads as one shape.

Learn more at graphy.dev.

Install

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

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

Usage

Data is one row per stage, in the order the funnel runs. Map the stage to x and its count to y. The classic funnel, stages running down, is coord.flip(), and the value axis measures from the centre line, so hide it:

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

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

const data = {
  columns: [{ key: 'stage' }, { key: 'visitors' }],
  rows: [
    { stage: 'Visited', visitors: 10000 },
    { stage: 'Added to cart', visitors: 3000 },
    { stage: 'Paid', visitors: 1200 },
  ],
};

const spec = kit.pipe(
  kit.createSpec({ x: 'stage', y: 'visitors' }),
  kit.geom.funnel({ dataLabels: { showDataLabels: true } }),
  kit.scale.x.discrete(),
  kit.scale.y.continuous(),
  kit.coord.flip(),
  kit.config({ axes: { y: { visible: false } } })
);

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

The geom's default funnel stat writes each stage's share of the first stage to funnelPercentOfFirst and of the stage before it to funnelPercentOfPrevious. Map label to either to print it, or name it in a highlight. Under stat: kit.stat.identity(), map percentOfFirst and percentOfPrevious to shares already in your data. params.width sets the fraction of its band a bar spans (0.7 by default). Colour the bars with kit.style.geom.funnel() and the bands between them with kit.style.geom.funnel.connector().

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-funnel 共发布 156 个版本,首次发布于 2026/10/08;过去 12 个月发布了 156 个版本。

版本发布日期距今
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-funnel 的常见问题

@graphysdk/geom-funnel 是什么?

Funnel geom for the Graphy charting SDK (beta)

如何安装 @graphysdk/geom-funnel?

在项目目录运行 npm install @graphysdk/geom-funnel,或使用 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-funnel 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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