@antv/antv-spec

中文文档
0.1.0-alpha.18发布于 2021/11/19MITTypeScriptESM + CJS零依赖近 30 天下载 1万

一种支持各种技术堆积AntV的宣说语法.

中文使用文档
文档目录4 节
  1. 特征
  2. 安装
  3. 示例
  4. 文档

蚂蚁光谱

一种支持各种技术堆积AntV的宣说语法.

特征

计划: AntV 的统一可视化方案
适配器: 将计划翻译为图表库

安装

npm install @antv/antv-spec

示例

import { useEffect } from "react";
import { AntVSpec, specToG2Plot } from "@antv/antv-spec";

export default function App() {
  const chartSpec: AntVSpec = {
    basis: {
      type: "chart"
    },
    data: {
      type: "json-array",
      values: [
        { year: "2007", sales: 28, type: "A" },
        { year: "2008", sales: 55, type: "A" },
        { year: "2009", sales: 43, type: "A" },
        { year: "2010", sales: 91, type: "A" },
        { year: "2011", sales: 81, type: "A" },
        { year: "2012", sales: 53, type: "A" },
        { year: "2013", sales: 19, type: "A" },
        { year: "2014", sales: 87, type: "A" },
        { year: "2015", sales: 52, type: "A" },

        { year: "2007", sales: 34, type: "B" },
        { year: "2008", sales: 52, type: "B" },
        { year: "2009", sales: 70, type: "B" },
        { year: "2010", sales: 11, type: "B" },
        { year: "2011", sales: 46, type: "B" },
        { year: "2012", sales: 79, type: "B" },
        { year: "2013", sales: 23, type: "B" },
        { year: "2014", sales: 54, type: "B" },
        { year: "2015", sales: 99, type: "B" }
      ]
    },
    layer: [
      {
        mark: {
          type: "line",
          style: { color: "#444444" }
        },
        encoding: {
          x: {
            field: "year",
            type: "temporal"
          },
          y: {
            field: "sales",
            type: "quantitative"
          },
          color: {
            field: "type",
            type: "nominal",
            scale: {
              range: ["#5c0011", "#ffec3d", "#7cb305", "#08979c", "#003a8c"]
            }
          }
        }
      }
    ]
  };

  useEffect(() => {
    specToG2Plot(chartSpec, document.getElementById("container"));
  });

  return <div className="container"></div>;
}

文档

这个计划仍然是alpha版本. 我们热烈欢迎任何贡献.

更多用法请检查 快速 API。 。 。 .

版本与发布记录

@antv/antv-spec 共发布 17 个版本,首次发布于 2021/08/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.0-alpha.18latest2021/11/194 年前
0.1.0-alpha.172021/11/194 年前
0.1.0-alpha.152021/11/194 年前
0.1.0-alpha.142021/11/194 年前
0.1.0-alpha.132021/11/194 年前
0.1.0-alpha.122021/11/194 年前

其他发布通道:alpha → 0.1.0-alpha.6。

关于 @antv/antv-spec 的常见问题

@antv/antv-spec 是什么?

一种支持各种技术堆积AntV的宣说语法.

如何安装 @antv/antv-spec?

在项目目录运行 npm install @antv/antv-spec,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@antv/g6(^4.3.11)、@antv/g2plot(^2.3.27)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@antv/antv-spec 支持 TypeScript 吗?

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

@antv/antv-spec 支持 ESM 还是 CommonJS?

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

@antv/antv-spec 可以商用吗?

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

@antv/antv-spec 的下载量有多少?

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

@antv/antv-spec 还在维护吗?

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