# @datafe-open/markdown-chart 中文文档

规范地址：https://npmcn.com/package/%40datafe-open/markdown-chart/

版本：0\.4\.1
npm 元数据更新时间：2026-10-31T14:54:59.953Z
中文译文更新时间：2026-11-11T13:33:51.320Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40datafe-open/markdown-chart
原文对照：https://npmcn.com/package/%40datafe-open/markdown-chart/?lang=original
项目主页：https://github.com/datafe/markdown-chart#readme
源码仓库：https://github.com/datafe/markdown-chart

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：174 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-07-17T03:16:53.684Z
- 最新版本发布：2026-10-31T14:54:59.677Z
- 近 30 天下载量：36467（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 28 个）

## 中文简介

Markdown中的JSON图表框架中立登记册和生命周期控制器

## 安装

```sh
npm install @datafe-open/markdown-chart
```

也可以使用：`pnpm add @datafe-open/markdown-chart`、`yarn add @datafe-open/markdown-chart`、`bun add @datafe-open/markdown-chart`

## README

# @ datafe- open/ markdown- 图表

框架中立的渲染器登记册 `markdown-chart` 栅栏路由器, 严格JSON 剖析器和一容器图 生命周期控制器。 光学 内置数据集和渲染器 -- -- 物质化的参考数据集 内建的图表/数据交换和有边框的数据表. 开关使用可访问图表/表格图标和Quen码WebShell启发 纸牌造型。 主机可以覆盖 `--markdown-chart-background`, (中文(简体) ), `--markdown-chart-subtle-background`, (中文(简体) ), `--markdown-chart-accent`,以及 `--markdown-chart-accent-foreground`。选定的图表/数据图标前景 倒计时 `--markdown-chart-background`,则 `#ffffff`,所以主机可以对齐 一个自定义口音背景,并带有一个对比的前景. 见 [第三方通知](https://npmcn.com/package/%40datafe-open/markdown-chart/THIRD_PARTY_NOTICES.md) 源的归属和源的归属 许可细节.

制作人可能会通过 `getTitle(parsed)`核心修饰 值和创建标题元素时, 只有当它不是空的; 它永远不会提供 一个倒置的标题。 当没有标题时,图表/数据控件仍保持右对齐 中,图表保留了工具栏上垂直间距的8px.

密码信封保持默认值 `data` 和可选名称 `datasets` 单独 从渲染器拥有的 `spec`。 。 。 . `parseMarkdownChartEnvelope()` 已验证的曝光 内入或引用表格、图表或层次图数据对象,并将两个表单传递给选定的 变形器。 共享图表/数据视图检查默认值 `data`; 渲染器拥有 显示任何选定的命名数据集.

`materializeChartData()` 是共享的渲染器中性参考边界。 主机 提供 `ResolveChartDataRef` 和可选验证; 核心转发不透明 校正、 声明形状和中止信号; 验证返回的平面行, 节点/链接,或嵌入子和明确的限制;并返回内线数据. Graph 接收节点/链接子视图, 而等级级则接收平分 页:1 它不选择运输、取取、授权或 解释任何参考计划.

渲染者可以回来 `preferredHeight` 对于一个有界限、可垂直滚动的 画布或 `renderError` 用于特定图表限制失败。 渲染错误 跳过挂载但保存已实现的数据视图; 格式错误的 JSON/ source 和 运行时间故障仍然致命.

动态渲染器解析背景 `language` 选项 原文 `rawLanguage` 第一个标志。 适应器应当保留 `rawLanguage` 何时 动态栅栏嵌入文件路径等对大小写敏感的有效载荷.

`ChartRenderRequest.streaming` 是块级待处理状态。 标记下适配器 只推迟一个未终止的尾篱;完成的块仍被挂起,同时 周围的文件继续流出. `ChartController` 制作一个 当块待决和解析时可见装入状态, 实际化,或运行时间正在飞行中。 设定 `ChartRenderRequest.loadingLabel` 以本地化默认文本。 自定义标记 使被隔离的块成为可使用的适配器 `findUnclosedMarkdownFence` 改为 识别活动的尾端栅栏,而不重复栅栏解析.

设定 `ChartRenderRequest.labels` 来本地化图表访问标签 图表/数据控制、空数据文本、调试通知和适配器出错 堕倒. `MarkdownChartLabelOverrides` 部分; 省略条目保留 导出 `DEFAULT_MARKDOWN_CHART_LABELS`框架适配器显示 不变 `labels` 对象.

`ChartRenderRequest.referenceActions` 是用于 可点击引用 。 仅转发核心 `{ rendererId, reference: { ref, label } }`;它不解析校对,授权访问,获取内容,导航, 或创建面板。 主机可以隐藏不支持的引用 `canOpen` 财务报告和审定财务报表 手柄接受点击 `open`。 。 。 .

## 常见问题

### @datafe-open/markdown-chart 是什么？

Markdown中的JSON图表框架中立登记册和生命周期控制器

### 如何安装 @datafe-open/markdown-chart？

在项目目录运行 npm install @datafe-open/markdown-chart，或使用 pnpm add / yarn add / bun add。

### @datafe-open/markdown-chart 支持 TypeScript 吗？

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

### @datafe-open/markdown-chart 支持 ESM 还是 CommonJS？

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

### @datafe-open/markdown-chart 可以商用吗？

@datafe-open/markdown-chart 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @datafe-open/markdown-chart 的下载量有多少？

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

### @datafe-open/markdown-chart 还在维护吗？

最新版本 0\.4\.1 发布于 2026/10/31（10 天前）；至今共发布 28 个版本，其中过去 12 个月发布了 28 个；首次发布于 2026/07/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。