signature_pad
- Version 5.1.2
- Published
- 446 kB
- No dependencies
- MIT license
Install
npm i signature_padyarn add signature_padpnpm add signature_padOverview
Library for drawing smooth signatures.
Index
Classes
Interfaces
Classes
class SignaturePad
class SignaturePad extends SignatureEventTarget {}constructor
constructor(canvas: HTMLCanvasElement, options?: Options);property backgroundColor
backgroundColor: string;property canvasContextOptions
canvasContextOptions: CanvasRenderingContext2DSettings;property compositeOperation
compositeOperation: GlobalCompositeOperation;property dotSize
dotSize: number;property maxWidth
maxWidth: number;property minDistance
minDistance: number;property minWidth
minWidth: number;property penColor
penColor: string;property throttle
throttle: number;property velocityFilterWeight
velocityFilterWeight: number;method clear
clear: () => void;method fromData
fromData: (pointGroups: PointGroup[], { clear }?: FromDataOptions) => void;method fromDataURL
fromDataURL: (dataUrl: string, options?: FromDataUrlOptions) => Promise<void>;method isEmpty
isEmpty: () => boolean;method off
off: () => void;method on
on: () => void;method redraw
redraw: () => void;method toData
toData: () => PointGroup[];method toDataURL
toDataURL: { (type: 'image/svg+xml', encoderOptions?: ToSVGOptions): string; (type?: string, encoderOptions?: number): string;};method toSVG
toSVG: ({ includeBackgroundColor, includeDataUrl }?: ToSVGOptions) => string;Interfaces
interface BasicPoint
interface BasicPoint {}interface FromDataOptions
interface FromDataOptions {}property clear
clear?: boolean;interface FromDataUrlOptions
interface FromDataUrlOptions {}interface Options
interface Options extends Partial<PointGroupOptions> {}property backgroundColor
backgroundColor?: string;property canvasContextOptions
canvasContextOptions?: CanvasRenderingContext2DSettings;property minDistance
minDistance?: number;property throttle
throttle?: number;interface PointGroup
interface PointGroup extends PointGroupOptions {}property points
points: BasicPoint[];interface PointGroupOptions
interface PointGroupOptions {}property compositeOperation
compositeOperation: GlobalCompositeOperation;This is the globalCompositeOperation for the line. *default: 'source-over'*
See Also
https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation
property dotSize
dotSize: number;property maxWidth
maxWidth: number;property minWidth
minWidth: number;property penColor
penColor: string;property velocityFilterWeight
velocityFilterWeight: number;interface SignatureEvent
interface SignatureEvent {}interface ToSVGOptions
interface ToSVGOptions {}property includeBackgroundColor
includeBackgroundColor?: boolean;property includeDataUrl
includeDataUrl?: boolean;Package Files (2)
Dependencies (0)
No dependencies.
Dev Dependencies (27)
- @eslint/js
- @semantic-release/changelog
- @semantic-release/commit-analyzer
- @semantic-release/git
- @semantic-release/github
- @semantic-release/npm
- @semantic-release/release-notes-generator
- @types/jest
- @types/node
- cpy-cli
- del
- del-cli
- esbuild
- esbuild-plugin-umd-wrapper
- eslint
- eslint-config-prettier
- globals
- jest
- jest-canvas-mock
- jest-environment-jsdom
- prettier
- semantic-release
- serve
- ts-jest
- tslib
- typescript
- typescript-eslint
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/signature_pad.
- Markdown[](https://www.jsdocs.io/package/signature_pad)
- HTML<a href="https://www.jsdocs.io/package/signature_pad"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 4087 ms. - Missing or incorrect documentation? Open an issue for this package.
