SVG Path Properties 项目使用教程

SVG Path Properties 项目使用教程

svg-path-propertiesPure Javascript alternative to path.getPointAtLength(t) and getTotalLength() functions. Works with Canvas & Node项目地址:https://gitcode.com/gh_mirrors/sv/svg-path-properties

1. 项目的目录结构及介绍

SVG Path Properties 是一个用于计算 SVG 路径属性的纯 JavaScript 库。以下是该项目的目录结构及其介绍：

svg-path-properties/
├── LICENSE
├── README.md
├── package.json
├── src/
│   ├── arc.js
│   ├── bezier.js
│   ├── catmullRom.js
│   ├── cubicBezier.js
│   ├── line.js
│   ├── path.js
│   ├── quadraticBezier.js
│   └── svgPathProperties.js
├── test/
│   ├── arc.test.js
│   ├── bezier.test.js
│   ├── catmullRom.test.js
│   ├── cubicBezier.test.js
│   ├── line.test.js
│   ├── path.test.js
│   ├── quadraticBezier.test.js
│   └── svgPathProperties.test.js
└── webpack.config.js

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录，包含各种路径处理的相关文件。
• test/: 测试代码目录，包含各种测试文件。
• webpack.config.js: Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/svgPathProperties.js，这是库的主入口文件。它导出了 SVGPathProperties 类，该类提供了计算路径属性的主要功能。

// src/svgPathProperties.js
import Path from './path';

class SVGPathProperties {
  constructor(path) {
    this.path = new Path(path);
  }

  getTotalLength() {
    return this.path.getTotalLength();
  }

  getPointAtLength(pos) {
    return this.path.getPointAtLength(pos);
  }

  getTangentAtLength(pos) {
    return this.path.getTangentAtLength(pos);
  }
}

export default SVGPathProperties;

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 webpack.config.js。

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。

{
  "name": "svg-path-properties",
  "version": "1.1.0",
  "description": "Pure Javascript alternative to getPointAtLength(t) and getTotalLength() functions. Works with Canvas objects and when ... ",
  "main": "dist/svg-path-properties.js",
  "scripts": {
    "build": "webpack",
    "test": "jest"
  },
  "keywords": [
    "svg",
    "path",
    "properties",
    "getPointAtLength",
    "getTotalLength"
  ],
  "author": "Roger Veciana i Rovira",
  "license": "MIT",
  "devDependencies": {
    "jest": "^26.6.3",
    "webpack": "^5.11.1",
    "webpack-cli": "^4.3.1"
  }
}

webpack.config.js

webpack.config.js 文件用于配置 Webpack，定义如何打包项目。

const path = require('path');

module.exports = {
  entry: './src/svgPathProperties.js',
  output: {
    filename: 'svg-path-properties.js',
    path: path.resolve(__dirname, 'dist'),
    library: 'SVGPathProperties',
    libraryTarget: 'umd'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'
        }
      }
    ]
  }
};

以上是 SVG Path Properties 项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

svg-path-propertiesPure Javascript alternative to path.getPointAtLength(t) and getTotalLength() functions. Works with Canvas & Node项目地址:https://gitcode.com/gh_mirrors/sv/svg-path-properties