pencil.js / index / use

Function: use()

function use(plugin, options?): object;

Defined in: index.ts:153

Install a plugin in Pencil.js

Parameters

Parameter	Type	Description
plugin	Plugin	Plugin to install
options?	any	Option passed down to the plugin

Returns

The Pencil.js package

Arc

Arc: typeof Arc;

author

author: string;

Author of the library

BaseEvent

BaseEvent: typeof BaseEvent;

Button

Button: typeof Button;

Checkbox

Checkbox: typeof Checkbox;

Circle

Circle: typeof Circle;

Color

Color: typeof Color;

Component

Component: typeof Component;

ConicGradient

ConicGradient: typeof ConicGradient;

Container

Container: typeof Container;

Ellipse

Ellipse: typeof Ellipse;

EventEmitter

EventEmitter: typeof EventEmitter;

from

from: <T>(json) => T;

Construct Pencil.js objects (and their children) from a JSON definition

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type	Description
json	Definition	Valid JSON definition (from any toJSON call)

Returns

T

Example

const copy = from(JSON.parse(JSON.stringify(scene)));

Heart

Heart: typeof Heart;

homepage

homepage: string;

Homepage of the library

Image

Image: typeof Image;

Input

Input: typeof Input;

Instruction

Instruction: typeof Instruction;

KeyboardEvent

KeyboardEvent: typeof KeyboardEvent;

Knob

Knob: typeof Knob;

Line

Line: typeof Line;

LinearGradient

LinearGradient: typeof LinearGradient;

Math

Math: math;

Constrain a number between two limits.

Param

value

Any number

Param

min

Minimal limit for the value

Param

max

Maximal limit for the value

Example

constrain(999, 0, 50); // => 50
constrain(-999, 0, 50); // => 0

MouseEvent

MouseEvent: typeof MouseEvent;

Navigation

Navigation: navigation;

NetworkEvent

NetworkEvent: typeof NetworkEvent;

OffScreenCanvas

OffScreenCanvas: typeof OffScreenCanvas;

Particles

Particles: typeof Particles;

Path

Path: typeof Path;

Pattern

Pattern: typeof Pattern;

Pie

Pie: typeof Pie;

Polygon

Polygon: typeof Polygon;

Position

Position: typeof Position;

ProgressBar

ProgressBar: typeof ProgressBar;

ProgressPie

ProgressPie: typeof ProgressPie;

RadialGradient

RadialGradient: typeof RadialGradient;

Rectangle

Rectangle: typeof Rectangle;

register

register: (...classes) => void;

Make classes available to the from function (every built-in class is registered when importing the main "pencil.js" entry)

Parameters

Parameter	Type	Description
...classes	Revivable[]	Any set of classes

Returns

void

Example

class MyShape extends Component { … }
register(MyShape);

RegularPolygon

RegularPolygon: typeof RegularPolygon;

Scene

Scene: typeof Scene;

Select

Select: typeof Select;

Slider

Slider: typeof Slider;

Spline

Spline: typeof Spline;

Sprite

Sprite: typeof Sprite;

Spritesheet

Spritesheet: typeof Spritesheet;

Square

Square: typeof Square;

Star

Star: typeof Star;

Text

Text: typeof Text;

Triangle

Triangle: typeof Triangle;

use

use: (plugin, options?) => { EventEmitter: typeof EventEmitter; Container: typeof Container; Scene: typeof Scene; Component: typeof Component; Particles: typeof Particles; Arc: typeof Arc; Pie: typeof Pie; ... 45 more ...; homepage: string; };

Install a plugin in Pencil.js

Parameters

Parameter	Type	Description
plugin	Plugin	Plugin to install
options?	any	Option passed down to the plugin

Returns

{ EventEmitter: typeof EventEmitter; Container: typeof Container; Scene: typeof Scene; Component: typeof Component; Particles: typeof Particles; Arc: typeof Arc; Pie: typeof Pie; ... 45 more ...; homepage: string; }

The Pencil.js package

Vector

Vector: typeof Vector;

version

version: string;

Version of the library

Widget

Widget: typeof Widget;