@neplex/vectorizer
A simple Node.js library to convert raster images into svg using VTracer, with time complexity of O(n).
Installation
npm install @neplex/vectorizer
Usage
import {
vectorize,
ColorMode,
Hierarchial,
PathSimplifyMode,
} from '@neplex/vectorizer';
import { readFile, writeFile } from 'node:fs/promises';
const src = await readFile('./raster.png');
const svg = await vectorize(src, {
colorMode: ColorMode.Color,
colorPrecision: 6,
filterSpeckle: 4,
spliceThreshold: 45,
cornerThreshold: 60,
hierarchical: Hierarchical.Stacked,
mode: PathSimplifyMode.Spline,
layerDifference: 5,
lengthThreshold: 5,
maxIterations: 2,
pathPrecision: 5,
});
console.log(svg); // <svg>...</svg>
await writeFile('./vector.svg', svg);
If you want to use synchronous API, you can use vectorizeSync instead.
API
vectorize(data: Buffer, config?: Config | Preset): Promise<string>
Takes an image buffer and returns a promise that resolves to an SVG string.
vectorizeSync(data: Buffer, config?: Config | Preset): string
Takes an image buffer and returns an SVG string synchronously.
vectorizeRaw(data: Buffer, args: RawDataConfig, config?: Config | Preset): Promise<string>
Takes a raw pixel data buffer and returns a promise that resolves to an SVG string.
vectorizeRawSync(data: Buffer, args: RawDataConfig, config?: Config | Preset): string
Takes a raw pixel data buffer and returns an SVG string synchronously.
Demo
Generated under the following configuration:
{
colorMode: ColorMode.Color,
colorPrecision: 8,
filterSpeckle: 4,
spliceThreshold: 45,
cornerThreshold: 60,
hierarchical: Hierarchical.Stacked,
mode: PathSimplifyMode.Spline,
layerDifference: 6,
lengthThreshold: 4,
maxIterations: 2
}
| Raster Image (PNG Input) | Vector Image (Generated SVG) |
|---|---|
 CC-BY-SA 3.0 by Niabot |
 CC-BY-SA 3.0 by Niabot |
10 Aug 21, 2022
8 Nov 16, 2022
12 Feb 19, 2023
1 Feb 10, 2022
7 Aug 29, 2023
18 Dec 16, 2023
4 Mar 28, 2024
5 Mar 16, 2023
3 Mar 23, 2022
4 Feb 20, 2023
26 Feb 13, 2023
1 Jan 1, 2022
6 Apr 4, 2023
50 Apr 26, 2023
3 Jul 30, 2023
7 Nov 17, 2022
10 Nov 29, 2022
63.8k Jan 7, 2023
301 Jan 4, 2023