npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@antv/util

v3.3.10

Published

> AntV 底层依赖的工具库,不建议在自己业务中使用。

Downloads

1,452,930

Readme

util

AntV 底层依赖的工具库,不建议在自己业务中使用。

Build Status npm Version npm Download npm License

Usage

import { gradient } from '@antv/util';

原则

  • util 只有一个 npm 包,按照目录来组织不同类型的方法,避免 monorepo 互相依赖
  • 内容和 AntV 强相关,避免做和 lodash 等相同的工具库
  • 不使用的方法,及时删除,并保持新增方法可以按需引入
  • 旧版本的不维护,如果 AntV 技术栈的旧版本需要迭代,请升级到 v3

API

提供以下 Path 工具方法,包含转换、几何计算等。

path2String

将 PathArray 转换成字符串形式,不会对原始定义中的命令进行修改:

const str: PathArray = [
  ['M', 10, 10],
  ['L', 100, 100],
  ['l', 10, 10],
  ['h', 20],
  ['v', 20],
];
expect(path2String(str)).toEqual('M10 10L100 100l10 10h20v20');

path2Array

将 PathArray 转换成数组,不会对原始定义中的命令进行修改:

const str = 'M10 10L100 100l10 10h20v20';
expect(path2Array(str)).toEqual([
  ['M', 10, 10],
  ['L', 100, 100],
  ['l', 10, 10],
  ['h', 20],
  ['v', 20],
]);

path2Absolute

将定义中的相对命令转换成绝对命令,例如:

  • l -> L
  • h -> H
  • v -> V

完整方法签名如下:

path2Absolute(pathInput: string | PathArray): AbsoluteArray;
const str: PathArray = [
  ['M', 10, 10],
  ['L', 100, 100],
  ['l', 10, 10],
  ['h', 20],
  ['v', 20],
];
const arr = path2Absolute(str);
expect(arr).toEqual([
  ['M', 10, 10],
  ['L', 100, 100],
  ['L', 110, 110],
  ['H', 130],
  ['V', 130],
]);

path2Curve

将部分命令转曲,例如 L / A 转成 C 命令,借助 cubic bezier 易于分割的特性用于实现形变动画。 该方法内部会调用 path2Absolute,因此最终返回的 PathArray 中仅包含 M 和 C 命令。

完整方法签名如下:

path2Curve(pathInput: string | PathArray): CurveArray;
expect(
  path2Curve([
    ['M', 0, 0],
    ['L', 100, 100],
  ]),
).toEqual([
  ['M', 0, 0],
  ['C', 44.194173824159215, 44.194173824159215, 68.75, 68.75, 100, 100],
]);

clonePath

复制路径:

const cloned = clonePath(pathInput);

reverseCurve

const pathArray: CurveArray = [
  ['M', 170, 90],
  ['C', 150, 90, 155, 10, 130, 10],
  ['C', 105, 10, 110, 90, 90, 90],
  ['C', 70, 90, 75, 10, 50, 10],
  ['C', 25, 10, 30, 90, 10, 90],
];

const reversed = reverseCurve(pathArray);

getPathBBox

获取几何定义下的包围盒,形如:

export interface PathBBox {
  width: number;
  height: number;
  x: number;
  y: number;
  x2: number;
  y2: number;
  cx: number;
  cy: number;
  cz: number;
}
const bbox = getPathBBox([['M', 0, 0], ['L', 100, 0], ['L', 100, 100], ['L', 0, 100], ['Z']]);

expect(bbox).toEqual({ cx: 50, cy: 50, cz: 150, height: 100, width: 100, x: 0, x2: 100, y: 0, y2: 100 });

getTotalLength

获取路径总长度。

const length = getTotalLength([['M', 0, 0], ['L', 100, 0], ['L', 100, 100], ['L', 0, 100], ['Z']]);

expect(length).toEqual(400);

getPointAtLength

获取路径上从起点出发,到指定距离的点。

const point = getPointAtLength([['M', 0, 0], ['L', 100, 0], ['L', 100, 100], ['L', 0, 100], ['Z']], 0);
expect(point).toEqual({ x: 0, y: 0 });

getPathArea

计算路径包围的面积。内部实现中首先通过 path2Curve 转曲,再计算 cubic curve 面积,详见

方法签名如下:

function getPathArea(path: PathArray): number;

isPointInStroke

判断一个点是否在路径上,仅通过几何定义计算,不考虑其他样式属性例如线宽、lineJoin、miter 等。

方法签名如下:

isPointInStroke(pathInput: string | PathArray, point: Point): boolean;
const result = isPointInStroke(segments, { x: 10, y: 10 });

distanceSquareRoot

计算两点之间的距离。

方法签名如下:

distanceSquareRoot(a: [number, number], b: [number, number]): number;

equalizeSegments

将两条路径处理成段数相同,用于形变动画前的分割操作。

const [formattedPath1, formattedPath2] = equalizeSegments(path1, path2);

isPointInPolygon

判断一个点是否在多边形内。多边形形如:

const polygon = [
  [0, 0],
  [0, 100],
  [30, 100],
  [30, 0],
];

// [0, 0] 在多边形的边上
isPointInPolygon(polygon, 0, 0); // true

isPolygonsIntersect

判断两个多边形是否相交:

isPolygonsIntersect(polygon1, polygon2);

Benchmarks

Build first.

yarn run benchmarks

We can get the following output in the console, it can be seen that the same method from 5.0 is ~3 times faster than 4.0.

// logs
// Path2String#4.0 x 14,795 ops/sec ±3.35% (79 runs sampled)
// Path2String#5.0 x 51,710 ops/sec ±2.05% (85 runs sampled)
// Fastest is Path2String#5.0

// Path2Absolute#4.0 x 14,524 ops/sec ±2.55% (80 runs sampled)
// Path2Absolute#5.0 x 35,120 ops/sec ±3.10% (81 runs sampled)
// Fastest is Path2Absolute#5.0

License

MIT@AntV.