README.zh-CN.md

@antv/scale

将抽象数据映射为视觉数据的比例尺工具包。 在线演示 · English

✨ 特性

• 功能强大：内置包含 15+ 丰富的比例尺类型，满足各种不同的定制化需求。
• 高性能：利用各种手段方法去提升数据映射的性能。
• TypeScript：全部 TypeScript，并提供了完整有效的类型定义。

📦 安装

$ npm install @antv/scale

🔨 上手

• 基本用法

import { Linear, LinearOptions } from '@antv/scale';

const options: LinearOptions = {
  domain: [0, 10],
  range: [0, 100],
};
const x = new Linear(options);

x.map(2); // 20
x.invert(20); // 2
x.getTicks(); // [0, 2.5, 5, 7.5, 10]

• 自定义可读 tickMethod

import { Linear } from '@antv/scale';

const x = new Linear({
  domain: [0, 10],
  range: [0, 100],
  tickCount: 3,
  tickMethod: () => [0, 5, 10],
});

x.getTicks(); // [0, 5, 10]

📎 链接

• 入门介绍
• API 索引

📮 贡献

$ git clone git@github.com:antvis/scale.git

$ cd scale

$ npm i

$ npm t

写完代码之后，提交 PR 即可。

📄 License

MIT@AntV.