Skip to content

Main Navigation Guide Modules API

Migrate from v3

Appearance

Sidebar Navigation

API reference

arc

Classes

Arc

base-event

Classes

BaseEvent

button

Classes

Button

Interfaces

ButtonOptions

checkbox

Classes

Checkbox

Interfaces

CheckboxOptions

circle

Classes

Circle

color

Classes

Color

Type Aliases

ColorDefinition

component

Classes

Component

Interfaces

ComponentOptions

ShadowOptions

StyleLike

Type Aliases

Style

conic-gradient

Classes

ConicGradient

Interfaces

ConicGradientJSON

Type Aliases

ColorStops

container

Classes

Container

Interfaces

ContainerJSON

ContainerOptions

draggable

Interfaces

DraggableAPI

DraggableOptions

ellipse

Classes

Ellipse

event-emitter

Classes

EventEmitter

Interfaces

EventListener

Type Aliases

EventCallback

heart

Classes

Heart

image

Classes

Image

Interfaces

ImageOptions

Type Aliases

ImageSource

index

Interfaces

Plugin

Variables

author

default

homepage

version

Functions

from

register

use

input

Classes

Input

Interfaces

InputOptions

keyboard-event

Classes

KeyboardEvent

knob

Classes

Knob

Interfaces

KnobOptions

line

Classes

Line

Interfaces

LineOptions

linear-gradient

Classes

LinearGradient

Interfaces

LinearGradientJSON

math

Variables

degreeCircle

phi

radianCircle

Functions

average

constrain

distribute

equals

lerp

map

modulo

random

sum

truncate

mouse-event

Classes

MouseEvent

navigation

Functions

back

displayScene

getCurrentScene

prepareScenes

network-event

Classes

NetworkEvent

offscreen-canvas

Classes

OffScreenCanvas

Interfaces

OffScreenCanvasOptions

particles

Classes

Particles

Interfaces

ParticleData

ParticlesOptions

Type Aliases

OptionsGenerator

ParticlesCallback

path

Classes

Instruction

Path

Interfaces

InstructionJSON

Type Aliases

InstructionCallback

pattern

Classes

Pattern

Interfaces

PatternJSON

PatternOptions

Type Aliases

PatternRepetition

PatternSource

pie

Classes

Pie

polygon

Classes

Polygon

position

Classes

Position

Interfaces

AbstractPosition

Type Aliases

Operation

PositionDefinition

progress-bar

Classes

ProgressBar

Interfaces

ProgressBarOptions

progress-pie

Classes

ProgressPie

Interfaces

ProgressPieOptions

radial-gradient

Classes

RadialGradient

Interfaces

RadialGradientJSON

rectangle

Classes

Rectangle

Interfaces

RectangleOptions

regular-polygon

Classes

RegularPolygon

resizable

Interfaces

ResizableOptions

rotatable

Interfaces

RotatableAPI

scene

Classes

Scene

Interfaces

SceneOptions

select

Classes

Select

Interfaces

SelectOptions

serialization

Interfaces

Definition

Revivable

Functions

from

register

slider

Classes

Slider

Interfaces

SliderOptions

spline

Classes

Spline

sprite

Classes

Sprite

Spritesheet

Interfaces

FrameData

FrameRectangle

SpriteOptions

SpritesheetData

Type Aliases

FrameSelector

square

Classes

Square

star

Classes

Star

text

Classes

Text

Interfaces

TextMeasures

TextOptions

Type Aliases

FontOptions

triangle

Classes

Triangle

vector

Classes

Vector

Interfaces

AbstractVector

Type Aliases

VectorDefinition

widget

Classes

Widget

Interfaces

WidgetBase

WidgetOptions

On this page

pencil.js / navigation

navigation

Functions

back
displayScene
getCurrentScene
prepareScenes

Pager

Previous pageMouseEvent

Released under the MIT License.

Made with ❤️ by Guillaume Martigny