ninja-canvashelper
TypeScript icon, indicating that this package has built-in type declarations

0.1.1 • Public • Published

ninja-canvashelper

GitHub Workflow Status

GitHub code size in bytes GitHub top language npm type definitions

GitHub

npm (tag) GitHub release (latest by date)

Simple library for simplification work with Canvas

Getting started

Install

pnpm add canvashelper

Usage

import CanvasHelper from 'ninja-canvashelper';

const cHelper = new CanvasHelper();

const canvas = cHelper.createCanvasField(
  'canvas-id',
  {
    iSize: 400,
    bSize: 400,
    parentSelector: 'body',
    styleClass: 'custom-canvas',
  }
);

Docs

CanvasHelper

  • cHelper.createCanvasField(id, options) - create canvas instance ang get it
  • cHelper.addCanvasField(id, element) - add canvas element ang get it
  • cHelper.removeCanvasField(id) - remove canvas instance by id
  • cHelper.getCanvasById(id) - get canvas instance by id
  • cHelper.collection - get all created canvases

CanvasItem

  • canvas.canvasNode - get canvas element
  • canvas.context2D - get canvas 2d context
  • canvas.parent - get parent node of canvas
  • canvas.draw - get canvas draw tool
  • canvas.id - get canvas SHA-256 id

CanvasDrawing

  • canvas.draw.clear(full, options) - clear canvas field full, or with options
  • canvas.draw.drawRect(options) - draw rect with options
  • canvas.draw.drawLine(options, lineOptions) - draw line with options
  • canvas.draw.drawArc(options) - draw circle with options

License

Check license in LICENSE file

Author

@steelWinds

Readme

Keywords

none

Package Sidebar

Install

npm i ninja-canvashelper

Weekly Downloads

1

Version

0.1.1

License

none

Unpacked Size

35.9 kB

Total Files

28

Last publish

Collaborators

  • steelwinds