Canvas

Defined in: src/canvas/Canvas.ts:72

Extends

• SelectableCanvas

Implements

• CanvasOptions

Constructors

Constructor

new Canvas(el?, options?): Canvas

Defined in: src/canvas/Canvas.ts:122

Parameters

el?

string | HTMLCanvasElement

options?

TCanvasOptions = {}

Returns

Canvas

Overrides

SelectableCanvas.constructor

Properties

_activeObject?

optional _activeObject: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in: src/canvas/SelectableCanvas.ts:325

Inherited from

SelectableCanvas._activeObject

---

_objects

_objects: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Defined in: src/canvas/SelectableCanvas.ts:177

TODO

needs to end up in the constructor too

Inherited from

SelectableCanvas._objects

---

_offset

_offset: object

Defined in: src/canvas/StaticCanvas.ts:159

left

left: number

top

top: number

Inherited from

SelectableCanvas._offset

---

allowTouchScrolling

allowTouchScrolling: boolean

Defined in: src/canvas/StaticCanvas.ts:123

Todo

move to Canvas

Implementation of

CanvasOptions.allowTouchScrolling

Inherited from

SelectableCanvas.allowTouchScrolling

---

altActionKey

altActionKey: TOptionalModifierKey

Defined in: src/canvas/SelectableCanvas.ts:185

Indicates which key enable alternate action on corner values: ‘altKey’, ‘shiftKey’, ‘ctrlKey’. If null or ‘none’ or any other string that is not a modifier key feature is disabled feature disabled.

Since

1.6.2

Implementation of

CanvasOptions.altActionKey

Inherited from

SelectableCanvas.altActionKey

---

altSelectionKey

altSelectionKey: TOptionalModifierKey

Defined in: src/canvas/SelectableCanvas.ts:190

Indicates which key enable alternative selection in case of a target overlapping with active object and we don’t want to loose the active selection, we can press this modifier key and continue selecting the current selected object also when is covered by another or many valid targets for selection. values: ‘altKey’, ‘shiftKey’, ‘ctrlKey’. For a series of reason that come from the general expectations on how things should work, this feature works only for preserveObjectStacking true. If null or ‘none’ or any other string that is not a modifier key feature is disabled.

Since

1.6.5

Implementation of

CanvasOptions.altSelectionKey

Inherited from

SelectableCanvas.altSelectionKey

---

backgroundColor

backgroundColor: string | TFiller

Defined in: src/canvas/StaticCanvas.ts:98

Background color of canvas instance.

Implementation of

CanvasOptions.backgroundColor

Inherited from

SelectableCanvas.backgroundColor

---

backgroundImage?

optional backgroundImage: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in: src/canvas/StaticCanvas.ts:99

Background image of canvas instance. since 2.4.0 image caching is active, please when putting an image as background, add to the canvas property a reference to the canvas it is on. Otherwise the image cannot detect the zoom vale. As an alternative you can disable image objectCaching

Implementation of

CanvasOptions.backgroundImage

Inherited from

SelectableCanvas.backgroundImage

---

backgroundVpt

backgroundVpt: boolean

Defined in: src/canvas/StaticCanvas.ts:97

if set to false background image is not affected by viewport transform

Since

1.6.3

Todo

we should really find a different way to do this

Implementation of

CanvasOptions.backgroundVpt

Inherited from

SelectableCanvas.backgroundVpt

---

centeredKey

centeredKey: TOptionalModifierKey

Defined in: src/canvas/SelectableCanvas.ts:184

Indicates which key enable centered Transform values: ‘altKey’, ‘shiftKey’, ‘ctrlKey’. If null or ‘none’ or any other string that is not a modifier key feature is disabled feature disabled.

Since

1.6.2

Implementation of

CanvasOptions.centeredKey

Inherited from

SelectableCanvas.centeredKey

---

centeredRotation

centeredRotation: boolean

Defined in: src/canvas/SelectableCanvas.ts:183

When true, objects use center point as the origin of rotate transformation. Backwards incompatibility note: This property replaces “centerTransform” (Boolean).

Since

1.3.4

Implementation of

CanvasOptions.centeredRotation

Inherited from

SelectableCanvas.centeredRotation

---

centeredScaling

centeredScaling: boolean

Defined in: src/canvas/SelectableCanvas.ts:182

When true, objects use center point as the origin of scale transformation. Backwards incompatibility note: This property replaces “centerTransform” (Boolean).

Since

1.3.4

Implementation of

CanvasOptions.centeredScaling

Inherited from

SelectableCanvas.centeredScaling

---

clipPath?

optional clipPath: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in: src/canvas/StaticCanvas.ts:105

a fabricObject that, without stroke define a clipping area with their shape. filled in black the clipPath object gets used when the canvas has rendered, and the context is placed in the top left corner of the canvas. clipPath will clip away controls, if you do not want this to happen use controlsAboveOverlay = true

Implementation of

CanvasOptions.clipPath

Inherited from

SelectableCanvas.clipPath

---

containerClass

containerClass: string

Defined in: src/canvas/SelectableCanvas.ts:204

Default element class that’s given to wrapper (div) element of canvas

Deprecated

customize CanvasDOMManager instead or access elements directly

Implementation of

CanvasOptions.containerClass

Inherited from

SelectableCanvas.containerClass

---

controlsAboveOverlay

controlsAboveOverlay: boolean

Defined in: src/canvas/StaticCanvas.ts:118

Todo

move to Canvas

Implementation of

CanvasOptions.controlsAboveOverlay

Inherited from

SelectableCanvas.controlsAboveOverlay

---

defaultCursor

defaultCursor: string

Defined in: src/canvas/SelectableCanvas.ts:200

Default cursor value used for the entire canvas

Default

default

Implementation of

CanvasOptions.defaultCursor

Inherited from

SelectableCanvas.defaultCursor

---

destroyed?

optional destroyed: boolean

Defined in: src/canvas/StaticCanvas.ts:150

If true the Canvas is in the process or has been disposed/destroyed. No more rendering operation will be executed on this canvas.

Inherited from

SelectableCanvas.destroyed

---

disposed?

optional disposed: boolean

Defined in: src/canvas/StaticCanvas.ts:157

Started the process of disposing but not done yet. WIll likely complete the render cycle already scheduled but stopping adding more.

Inherited from

SelectableCanvas.disposed

---

elements

elements: CanvasDOMManager

Defined in: src/canvas/SelectableCanvas.ts:310

Inherited from

SelectableCanvas.elements

---

enablePointerEvents

enablePointerEvents: boolean

Defined in: src/canvas/Canvas.ts:80

When the option is enabled, PointerEvent is used instead of TPointerEvent.

Implementation of

CanvasOptions.enablePointerEvents

---

enableRetinaScaling

enableRetinaScaling: boolean

Defined in: src/canvas/StaticCanvas.ts:112

When true, canvas is scaled by devicePixelRatio for better rendering on retina screens

Implementation of

CanvasOptions.enableRetinaScaling

Inherited from

SelectableCanvas.enableRetinaScaling

---

fireMiddleClick

fireMiddleClick: boolean

Defined in: src/canvas/SelectableCanvas.ts:225

Indicates if the canvas can fire middle click events

Since

1.7.8

Implementation of

CanvasOptions.fireMiddleClick

Inherited from

SelectableCanvas.fireMiddleClick

---

fireRightClick

fireRightClick: boolean

Defined in: src/canvas/SelectableCanvas.ts:224

Indicates if the canvas can fire right click events

Since

1.6.5

Implementation of

CanvasOptions.fireRightClick

Inherited from

SelectableCanvas.fireRightClick

---

freeDrawingBrush?

optional freeDrawingBrush: BaseBrush

Defined in: src/canvas/SelectableCanvas.ts:324

Inherited from

SelectableCanvas.freeDrawingBrush

---

freeDrawingCursor

freeDrawingCursor: string

Defined in: src/canvas/SelectableCanvas.ts:201

Cursor value used during free drawing

Default

crosshair

Implementation of

CanvasOptions.freeDrawingCursor

Inherited from

SelectableCanvas.freeDrawingCursor

---

height

height: number

Defined in: src/canvas/StaticCanvas.ts:94

Height in virtual/logical pixels of the canvas. The canvas can be taller than width if retina scaling is active

Implementation of

CanvasOptions.height

Inherited from

SelectableCanvas.height

---

hoverCursor

hoverCursor: string

Defined in: src/canvas/SelectableCanvas.ts:198

Default cursor value used when hovering over an object on canvas

Default

move

Implementation of

CanvasOptions.hoverCursor

Inherited from

SelectableCanvas.hoverCursor

---

imageSmoothingEnabled

imageSmoothingEnabled: boolean

Defined in: src/canvas/StaticCanvas.ts:113

Indicates whether this canvas will use image smoothing, this is on by default in browsers

Implementation of

CanvasOptions.imageSmoothingEnabled

Inherited from

SelectableCanvas.imageSmoothingEnabled

---

includeDefaultValues

includeDefaultValues: boolean

Defined in: src/canvas/StaticCanvas.ts:107

Indicates whether toObject/toDatalessObject should include default values if set to false, takes precedence over the object value.

Implementation of

CanvasOptions.includeDefaultValues

Inherited from

SelectableCanvas.includeDefaultValues

---

isDrawingMode

isDrawingMode: boolean

Defined in: src/canvas/SelectableCanvas.ts:218

When true, mouse events on canvas (mousedown/mousemove/mouseup) result in free drawing. After mousedown, mousemove creates a shape, and then mouseup finalizes it and adds an instance of fabric.Path onto canvas.

See

http://fabricjs.com/fabric-intro-part-4#free_drawing

Inherited from

SelectableCanvas.isDrawingMode

---

moveCursor

moveCursor: string

Defined in: src/canvas/SelectableCanvas.ts:199

Default cursor value used when moving an object on canvas

Default

move

Implementation of

CanvasOptions.moveCursor

Inherited from

SelectableCanvas.moveCursor

---

notAllowedCursor

notAllowedCursor: string

Defined in: src/canvas/SelectableCanvas.ts:202

Cursor value used for disabled elements ( corners with disabled action )

Since

2.0.0

Default

not-allowed

Implementation of

CanvasOptions.notAllowedCursor

Inherited from

SelectableCanvas.notAllowedCursor

---

overlayColor

overlayColor: string | TFiller

Defined in: src/canvas/StaticCanvas.ts:102

Overlay color of canvas instance.

Since

1.3.9

Implementation of

CanvasOptions.overlayColor

Inherited from

SelectableCanvas.overlayColor

---

overlayImage?

optional overlayImage: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in: src/canvas/StaticCanvas.ts:103

Overlay image of canvas instance. since 2.4.0 image caching is active, please when putting an image as overlay, add to the canvas property a reference to the canvas it is on. Otherwise the image cannot detect the zoom vale. As an alternative you can disable image objectCaching

Implementation of

CanvasOptions.overlayImage

Inherited from

SelectableCanvas.overlayImage

---

overlayVpt

overlayVpt: boolean

Defined in: src/canvas/StaticCanvas.ts:101

if set to false overlay image is not affected by viewport transform

Since

1.6.3

Todo

we should really find a different way to do this

Implementation of

CanvasOptions.overlayVpt

Inherited from

SelectableCanvas.overlayVpt

---

perPixelTargetFind

perPixelTargetFind: boolean

Defined in: src/canvas/SelectableCanvas.ts:207

When true, object detection happens on per-pixel basis rather than on per-bounding-box

Implementation of

CanvasOptions.perPixelTargetFind

Inherited from

SelectableCanvas.perPixelTargetFind

---

preserveObjectStacking

preserveObjectStacking: boolean

Defined in: src/canvas/SelectableCanvas.ts:220

Indicates whether objects should remain in current stack position when selected. When false objects are brought to top and rendered as part of the selection group

Default

true

Implementation of

CanvasOptions.preserveObjectStacking

Inherited from

SelectableCanvas.preserveObjectStacking

---

renderOnAddRemove

renderOnAddRemove: boolean

Defined in: src/canvas/StaticCanvas.ts:110

Indicates whether StaticCanvas#add, StaticCanvas#insertAt and StaticCanvas#remove, StaticCanvas#moveTo, StaticCanvas#clear and many more, should also re-render canvas. Disabling this option will not give a performance boost when adding/removing a lot of objects to/from canvas at once since the renders are queued and executed one per frame. Disabling is suggested anyway and managing the renders of the app manually is not a big effort ( canvas.requestRenderAll() ) Left default to true to do not break documentation and old app, fiddles.

Implementation of

CanvasOptions.renderOnAddRemove

Inherited from

SelectableCanvas.renderOnAddRemove

---

selection

selection: boolean

Defined in: src/canvas/SelectableCanvas.ts:188

Indicates whether group selection should be enabled

Implementation of

CanvasOptions.selection

Inherited from

SelectableCanvas.selection

---

selectionBorderColor

selectionBorderColor: string

Defined in: src/canvas/SelectableCanvas.ts:193

Color of the border of selection (usually slightly darker than color of selection itself)

Implementation of

CanvasOptions.selectionBorderColor

Inherited from

SelectableCanvas.selectionBorderColor

---

selectionColor

selectionColor: string

Defined in: src/canvas/SelectableCanvas.ts:191

Color of selection

Implementation of

CanvasOptions.selectionColor

Inherited from

SelectableCanvas.selectionColor

---

selectionDashArray

selectionDashArray: number[]

Defined in: src/canvas/SelectableCanvas.ts:192

Default dash array pattern If not empty the selection border is dashed

Implementation of

CanvasOptions.selectionDashArray

Inherited from

SelectableCanvas.selectionDashArray

---

selectionFullyContained

selectionFullyContained: boolean

Defined in: src/canvas/SelectableCanvas.ts:195

Select only shapes that are fully contained in the dragged selection rectangle.

Implementation of

CanvasOptions.selectionFullyContained

Inherited from

SelectableCanvas.selectionFullyContained

---

selectionKey

selectionKey: TOptionalModifierKey | ("altKey" | "ctrlKey" | "metaKey" | "shiftKey")[]

Defined in: src/canvas/SelectableCanvas.ts:189

Indicates which key or keys enable multiple click selection Pass value as a string or array of strings values: ‘altKey’, ‘shiftKey’, ‘ctrlKey’. If null or empty or containing any other string that is not a modifier key feature is disabled.

Since

1.6.2

Implementation of

CanvasOptions.selectionKey

Inherited from

SelectableCanvas.selectionKey

---

selectionLineWidth

selectionLineWidth: number

Defined in: src/canvas/SelectableCanvas.ts:194

Width of a line used in object/group selection

Implementation of

CanvasOptions.selectionLineWidth

Inherited from

SelectableCanvas.selectionLineWidth

---

skipOffscreen

skipOffscreen: boolean

Defined in: src/canvas/StaticCanvas.ts:111

Based on vptCoords and object.aCoords, skip rendering of objects that are not included in current viewport. May greatly help in applications with crowded canvas and use of zoom/pan If One of the corner of the bounding box of the object is on the canvas the objects get rendered.

Default

true

Implementation of

CanvasOptions.skipOffscreen

Inherited from

SelectableCanvas.skipOffscreen

---

skipTargetFind

skipTargetFind: boolean

Defined in: src/canvas/SelectableCanvas.ts:209

When true, target detection is skipped. Target detection will return always undefined. click selection won’t work anymore, events will fire with no targets. if something is selected before setting it to true, it will be deselected at the first click. area selection will still work. check the selection property too. if you deactivate both, you should look into staticCanvas.

Implementation of

CanvasOptions.skipTargetFind

Inherited from

SelectableCanvas.skipTargetFind

---

stopContextMenu

stopContextMenu: boolean

Defined in: src/canvas/SelectableCanvas.ts:223

Indicates if the right click on canvas can output the context menu or not

Since

1.6.5

Implementation of

CanvasOptions.stopContextMenu

Inherited from

SelectableCanvas.stopContextMenu

---

svgViewportTransformation

svgViewportTransformation: boolean

Defined in: src/canvas/StaticCanvas.ts:900

When true, getSvgTransform() will apply the StaticCanvas.viewportTransform to the SVG transformation. When true, a zoomed canvas will then produce zoomed SVG output.

Implementation of

CanvasOptions.svgViewportTransformation

Inherited from

SelectableCanvas.svgViewportTransformation

---

targetFindTolerance

targetFindTolerance: number

Defined in: src/canvas/SelectableCanvas.ts:208

Number of pixels around target pixel to tolerate (consider active) during object detection

Implementation of

CanvasOptions.targetFindTolerance

Inherited from

SelectableCanvas.targetFindTolerance

---

textEditingManager

textEditingManager: TextEditingManager

Defined in: src/canvas/Canvas.ts:120

---

uniformScaling

uniformScaling: boolean

Defined in: src/canvas/SelectableCanvas.ts:180

When true, objects can be transformed by one side (unproportionately) when dragged on the corners that normally would not do that.

Since

fabric 4.0 // changed name and default value

Implementation of

CanvasOptions.uniformScaling

Inherited from

SelectableCanvas.uniformScaling

---

uniScaleKey

uniScaleKey: TOptionalModifierKey

Defined in: src/canvas/SelectableCanvas.ts:181

Indicates which key switches uniform scaling. values: ‘altKey’, ‘shiftKey’, ‘ctrlKey’. If null or ‘none’ or any other string that is not a modifier key feature is disabled. totally wrong named. this sounds like uniform scaling if Canvas.uniformScaling is true, pressing this will set it to false and viceversa.

Since

1.6.2

Implementation of

CanvasOptions.uniScaleKey

Inherited from

SelectableCanvas.uniScaleKey

---

viewportTransform

viewportTransform: TMat2D

Defined in: src/canvas/StaticCanvas.ts:125

The transformation (a Canvas 2D API transform matrix) which focuses the viewport

Examples

canvas.viewportTransform = [1, 0, 0, 1, 0, 0];

canvas.viewportTransform = [0.7, 0, 0, 0.7, 50, 50];

Implementation of

CanvasOptions.viewportTransform

Inherited from

SelectableCanvas.viewportTransform

---

vptCoords

vptCoords: TCornerPoint

Defined in: src/canvas/StaticCanvas.ts:130

The viewport bounding box in scene plane coordinates, see calcViewportBoundaries

Inherited from

SelectableCanvas.vptCoords

---

width

width: number

Defined in: src/canvas/StaticCanvas.ts:93

Width in virtual/logical pixels of the canvas. The canvas can be larger than width if retina scaling is active

Implementation of

CanvasOptions.width

Inherited from

SelectableCanvas.width

---

ownDefaults

static ownDefaults: TOptions<CanvasOptions> = canvasDefaults

Defined in: src/canvas/SelectableCanvas.ts:304

Inherited from

SelectableCanvas.ownDefaults

Accessors

contextContainer

Get Signature

get contextContainer(): CanvasRenderingContext2D

Defined in: src/canvas/StaticCanvas.ts:141

Returns

CanvasRenderingContext2D

Inherited from

SelectableCanvas.contextContainer

---

contextTop

Get Signature

get contextTop(): CanvasRenderingContext2D

Defined in: src/canvas/SelectableCanvas.ts:314

Returns

CanvasRenderingContext2D

Inherited from

SelectableCanvas.contextTop

---

lowerCanvasEl

Get Signature

get lowerCanvasEl(): HTMLCanvasElement

Defined in: src/canvas/StaticCanvas.ts:137

A reference to the canvas actual HTMLCanvasElement. Can be use to read the raw pixels, but never write or manipulate

Returns

HTMLCanvasElement

Inherited from

SelectableCanvas.lowerCanvasEl

---

upperCanvasEl

Get Signature

get upperCanvasEl(): HTMLCanvasElement

Defined in: src/canvas/SelectableCanvas.ts:311

Returns

HTMLCanvasElement

Inherited from

SelectableCanvas.upperCanvasEl

---

wrapperEl

Get Signature

get wrapperEl(): HTMLDivElement

Defined in: src/canvas/SelectableCanvas.ts:317

Returns

HTMLDivElement

Inherited from

SelectableCanvas.wrapperEl

Methods

_basicEventHandler()

_basicEventHandler<T>(eventType, options): CanvasEvents & ObjectEvents[T]

Defined in: src/canvas/Canvas.ts:898

Type Parameters

T

T extends "contextmenu" | "drag" | "dragend" | "dragenter" | "dragleave" | "dragover" | "dragstart" | "drop" | "erasing:end" | "drop:before" | "drop:after" | "contextmenu:before"

Parameters

eventType

T

options

CanvasEvents & ObjectEvents[T]

Returns

CanvasEvents & ObjectEvents[T]

---

_chooseObjectsToRender()

_chooseObjectsToRender(): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Defined in: src/canvas/SelectableCanvas.ts:376

Divides objects in two groups, one to render immediately and one to render as activeGroup.

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

objects to render immediately and pushes the other in the activeGroup.

Inherited from

SelectableCanvas._chooseObjectsToRender

---

_discardActiveObject()

_discardActiveObject(e?, object?): this is { _activeObject: undefined }

Defined in: src/canvas/SelectableCanvas.ts:1250

This is supposed to be equivalent to discardActiveObject but without firing any selection events ( can still fire object transformation events ). There is commitment to have this stay this way. This is the functional part of discardActiveObject.

Parameters

e?

TPointerEvent

Event (passed along when firing “object:deselected”)

object?

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

the next object to set as active, reason why we are discarding this

Returns

this is { _activeObject: undefined }

true if the active object has been discarded

Inherited from

SelectableCanvas._discardActiveObject

---

_onStackOrderChanged()

_onStackOrderChanged(): void

Defined in: src/canvas/SelectableCanvas.ts:366

Returns

void

Inherited from

SelectableCanvas._onStackOrderChanged

---

_set()

_set(key, value): void

Defined in: src/CommonMethods.ts:38

Parameters

key

string

value

any

Returns

void

Inherited from

SelectableCanvas._set

---

_setActiveObject()

_setActiveObject(object, e?): boolean

Defined in: src/canvas/SelectableCanvas.ts:1218

This is supposed to be equivalent to setActiveObject but without firing any event. There is commitment to have this stay this way. This is the functional part of setActiveObject.

Parameters

object

FabricObject

to set as active

e?

TPointerEvent

Event (passed along when firing “object:selected”)

Returns

boolean

true if the object has been selected

Inherited from

SelectableCanvas._setActiveObject

---

_setCursorFromEvent()

_setCursorFromEvent(e, target?): void

Defined in: src/canvas/Canvas.ts:1350

Sets the cursor depending on where the canvas is being hovered. Note: very buggy in Opera

Parameters

e

TPointerEvent

Event object

target?

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Object that the mouse is hovering, if so.

Returns

void

---

absolutePan()

absolutePan(point): void

Defined in: src/canvas/StaticCanvas.ts:391

Pan viewport so as to place point at top left corner of canvas

Parameters

point

Point

to move to

Returns

void

Inherited from

SelectableCanvas.absolutePan

---

add()

add(…objects): number

Defined in: src/canvas/StaticCanvas.ts:210

Adds objects to collection Objects should be instances of (or inherit from) FabricObject

Parameters

objects

…FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

to add

Returns

number

new array length

Inherited from

SelectableCanvas.add

---

addOrRemove()

addOrRemove(functor, _eventjsFunctor): void

Defined in: src/canvas/Canvas.ts:167

Parameters

functor

any

_eventjsFunctor

"add" | "remove"

Returns

void

---

bringObjectForward()

bringObjectForward(object, intersecting?): boolean

Defined in: src/Collection.ts:240

Moves an object or a selection up in stack of drawn objects An optional parameter, intersecting allows to move the object in front of the first intersecting object. Where intersection is calculated with bounding box. If no intersection is found, there will not be change in the stack.

Parameters

object

FabricObject

Object to send

intersecting?

boolean

If true, send object in front of next upper intersecting object

Returns

boolean

true if change occurred

Inherited from

SelectableCanvas.bringObjectForward

---

bringObjectToFront()

bringObjectToFront(object): boolean

Defined in: src/Collection.ts:194

Moves an object or the objects of a multiple selection to the top of the stack of drawn objects

Parameters

object

FabricObject

Object to send

Returns

boolean

true if change occurred

Inherited from

SelectableCanvas.bringObjectToFront

---

calcOffset()

calcOffset(): object

Defined in: src/canvas/StaticCanvas.ts:266

Calculates canvas element offset relative to the document This method is also attached as “resize” event handler of window

Returns

object

left

left: number = 0

top

top: number = 0

Inherited from

SelectableCanvas.calcOffset

---

calcViewportBoundaries()

calcViewportBoundaries(): TCornerPoint

Defined in: src/canvas/StaticCanvas.ts:488

Calculate the position of the 4 corner of canvas with current viewportTransform. helps to determinate when an object is in the current rendering viewport

Returns

TCornerPoint

Inherited from

SelectableCanvas.calcViewportBoundaries

---

cancelRequestedRender()

cancelRequestedRender(): void

Defined in: src/canvas/StaticCanvas.ts:506

Returns

void

Inherited from

SelectableCanvas.cancelRequestedRender

---

centerObject()

centerObject(object): void

Defined in: src/canvas/StaticCanvas.ts:703

Centers object vertically and horizontally in the canvas

Parameters

object

FabricObject

Object to center vertically and horizontally

Returns

void

Inherited from

SelectableCanvas.centerObject

---

centerObjectH()

centerObjectH(object): void

Defined in: src/canvas/StaticCanvas.ts:681

Centers object horizontally in the canvas

Parameters

object

FabricObject

Returns

void

Inherited from

SelectableCanvas.centerObjectH

---

centerObjectV()

centerObjectV(object): void

Defined in: src/canvas/StaticCanvas.ts:692

Centers object vertically in the canvas

Parameters

object

FabricObject

Object to center vertically

Returns

void

Inherited from

SelectableCanvas.centerObjectV

---

clear()

clear(): void

Defined in: src/canvas/Canvas.ts:1552

clear textEditingManager

Returns

void

Overrides

SelectableCanvas.clear

---

clearContext()

clearContext(ctx): void

Defined in: src/canvas/StaticCanvas.ts:423

Clears specified context of canvas element

Parameters

ctx

CanvasRenderingContext2D

Context to clear

Returns

void

Inherited from

SelectableCanvas.clearContext

---

clone()

clone(properties?): Promise<Canvas>

Defined in: src/canvas/StaticCanvas.ts:1272

Clones canvas instance

Parameters

properties?

string[]

Array of properties to include in the cloned canvas and children

Returns

Promise<Canvas>

Inherited from

SelectableCanvas.clone

---

cloneWithoutData()

cloneWithoutData(): Canvas

Defined in: src/canvas/StaticCanvas.ts:1282

Clones canvas instance without cloning existing data. This essentially copies canvas dimensions since loadFromJSON does not affect canvas size.

Returns

Canvas

Inherited from

SelectableCanvas.cloneWithoutData

---

collectObjects()

collectObjects(bbox, options): InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Defined in: src/Collection.ts:326

Given a bounding box, return all the objects of the collection that are contained in the bounding box. If includeIntersecting is true, return also the objects that intersect the bounding box as well. This is meant to work with selection. Is not a generic method.

Parameters

bbox

TBBox

a bounding box in scene coordinates

options

an object with includeIntersecting

includeIntersecting?

boolean = true

Returns

InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

array of objects contained in the bounding box, ordered from top to bottom stacking wise

Inherited from

SelectableCanvas.collectObjects

---

complexity()

complexity(): number

Defined in: src/Collection.ts:165

Returns number representation of a collection complexity

Returns

number

complexity

Inherited from

SelectableCanvas.complexity

---

contains()

contains(object, deep?): boolean

Defined in: src/Collection.ts:148

Returns true if collection contains an object.
Prefer using FabricObject#isDescendantOf for performance reasons instead of a.contains(b) use b.isDescendantOf(a)

Parameters

object

FabricObject

Object to check against

deep?

boolean

true to check all descendants, false to check only _objects

Returns

boolean

true if collection contains an object

Inherited from

SelectableCanvas.contains

---

createSVGClipPathMarkup()

createSVGClipPathMarkup(options): string

Defined in: src/canvas/StaticCanvas.ts:1025

Parameters

options

TSVGExportOptions

Returns

string

Inherited from

SelectableCanvas.createSVGClipPathMarkup

---

createSVGFontFacesMarkup()

createSVGFontFacesMarkup(): string

Defined in: src/canvas/StaticCanvas.ts:1068

Creates markup containing SVG font faces, font URLs for font faces must be collected by developers and are not extracted from the DOM by fabricjs

Returns

string

Inherited from

SelectableCanvas.createSVGFontFacesMarkup

---

createSVGRefElementsMarkup()

createSVGRefElementsMarkup(): string

Defined in: src/canvas/StaticCanvas.ts:1040

Creates markup containing SVG referenced elements like patterns, gradients etc.

Returns

string

Inherited from

SelectableCanvas.createSVGRefElementsMarkup

---

destroy()

destroy(): void

Defined in: src/canvas/Canvas.ts:1560

clear textEditingManager

Returns

void

Overrides

SelectableCanvas.destroy

---

discardActiveObject()

discardActiveObject(e?): this is { _activeObject: undefined }

Defined in: src/canvas/SelectableCanvas.ts:1280

Discards currently active object and fire events. If the function is called by fabric as a consequence of a mouse event, the event is passed as a parameter and sent to the fire function for the custom events. When used as a method the e param does not have any application.

Parameters

e?

TPointerEvent

Returns

this is { _activeObject: undefined }

true if the active object has been discarded

Inherited from

SelectableCanvas.discardActiveObject

---

dispose()

dispose(): Promise<boolean>

Defined in: src/canvas/StaticCanvas.ts:1416

Waits until rendering has settled to destroy the canvas

Returns

Promise<boolean>

a promise resolving to true once the canvas has been destroyed or to false if the canvas has was already destroyed

Throws

if aborted by a consequent call

Inherited from

SelectableCanvas.dispose

---

drawClipPathOnCanvas()

drawClipPathOnCanvas(ctx, clipPath): void

Defined in: src/canvas/StaticCanvas.ts:570

Paint the cached clipPath on the lowerCanvasEl

Parameters

ctx

CanvasRenderingContext2D

Context to render on

clipPath

TCachedFabricObject

Returns

void

Inherited from

SelectableCanvas.drawClipPathOnCanvas

---

drawControls()

drawControls(ctx): void

Defined in: src/canvas/SelectableCanvas.ts:1388

Draws objects’ controls (borders/controls)

Parameters

ctx

CanvasRenderingContext2D

Context to render controls on

Returns

void

Inherited from

SelectableCanvas.drawControls

---

endCurrentTransform()

endCurrentTransform(e?): void

Defined in: src/canvas/SelectableCanvas.ts:1300

End the current transform. You don’t usually need to call this method unless you are interrupting a user initiated transform because of some other event ( a press of key combination, or something that block the user UX )

Parameters

e?

TPointerEvent

send the mouse event that generate the finalize down, so it can be used in the event

Returns

void

Inherited from

SelectableCanvas.endCurrentTransform

---

findNewLowerIndex()

findNewLowerIndex(object, idx, intersecting?): number

Defined in: src/Collection.ts:272

Parameters

object

FabricObject

idx

number

intersecting?

boolean

Returns

number

Inherited from

SelectableCanvas.findNewLowerIndex

---

findNewUpperIndex()

findNewUpperIndex(object, idx, intersecting?): number

Defined in: src/Collection.ts:295

Parameters

object

FabricObject

idx

number

intersecting?

boolean

Returns

number

Inherited from

SelectableCanvas.findNewUpperIndex

---

findTarget()

findTarget(e): FullTargetsInfoWithContainer

Defined in: src/canvas/SelectableCanvas.ts:730

This function is in charge of deciding which is the object that is the current target of an interaction event. For interaction event we mean a pointer related action on the canvas. Which is the 11/09/2018 TODO: would be cool if findTarget could discern between being a full target or the outside part of the corner.

Parameters

e

TPointerEvent

mouse event

Returns

FullTargetsInfoWithContainer

the target found

Inherited from

SelectableCanvas.findTarget

---

fire()

fire<K>(eventName, options?): void

Defined in: src/Observable.ts:167

Fires event with an optional options object

Type Parameters

K

K extends keyof CanvasEvents

Parameters

eventName

K

Event name to fire

options?

CanvasEvents[K]

Options object

Returns

void

Inherited from

SelectableCanvas.fire

---

forEachObject()

forEachObject(callback): void

Defined in: src/Collection.ts:91

Executes given function for each object in this group A simple shortcut for getObjects().forEach, before es6 was more complicated, now is just a shortcut.

Parameters

callback

(object, index, array) => any

Callback invoked with current object as first argument, index - as second and an array of all objects - as third.

Returns

void

Inherited from

SelectableCanvas.forEachObject

---

get()

get(property): any

Defined in: src/CommonMethods.ts:59

Basic getter

Parameters

property

string

Property name

Returns

any

value of a property

Inherited from

SelectableCanvas.get

---

getActiveObject()

getActiveObject(): undefined | FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in: src/canvas/SelectableCanvas.ts:1120

Returns currently active object

Returns

undefined | FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

active object

Inherited from

SelectableCanvas.getActiveObject

---

getActiveObjects()

getActiveObjects(): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Defined in: src/canvas/SelectableCanvas.ts:1128

Returns an array with the current selected objects

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

active objects array

Inherited from

SelectableCanvas.getActiveObjects

---

getCenterPoint()

getCenterPoint(): Point

Defined in: src/canvas/StaticCanvas.ts:674

Returns coordinates of a center of canvas.

Returns

Point

Inherited from

SelectableCanvas.getCenterPoint

---

getContext()

getContext(): CanvasRenderingContext2D

Defined in: src/canvas/StaticCanvas.ts:431

Returns context of canvas where objects are drawn

Returns

CanvasRenderingContext2D

Inherited from

SelectableCanvas.getContext

---

getElement()

getElement(): HTMLCanvasElement

Defined in: src/canvas/StaticCanvas.ts:415

Returns <canvas> element corresponding to this instance

Returns

HTMLCanvasElement

Inherited from

SelectableCanvas.getElement

---

getHeight()

getHeight(): number

Defined in: src/canvas/StaticCanvas.ts:282

Returns canvas height (in px)

Returns

number

Inherited from

SelectableCanvas.getHeight

---

getObjects()

getObjects(…types?): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Defined in: src/Collection.ts:108

Returns an array of children objects of this instance

Parameters

types?

…string[]

When specified, only objects of these types are returned

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Inherited from

SelectableCanvas.getObjects

---

getScenePoint()

getScenePoint(e): Point

Defined in: src/canvas/SelectableCanvas.ts:1009

Parameters

e

TPointerEvent

Returns

Point

point existing in the scene (the same plane as the plane FabricObject#getCenterPoint exists in). This means that changes to the viewportTransform do not change the values of the point, however, from the viewer’s perspective, the point is changed.

Example

const viewportPoint = sendPointToPlane(
 this.getScenePoint(e),
 canvas.viewportTransform
);

Inherited from

SelectableCanvas.getScenePoint

---

getSelectionContext()

getSelectionContext(): CanvasRenderingContext2D

Defined in: src/canvas/SelectableCanvas.ts:1104

Returns context of canvas where object selection is drawn

Returns

CanvasRenderingContext2D

Alias

Inherited from

SelectableCanvas.getSelectionContext

---

getSelectionElement()

getSelectionElement(): HTMLCanvasElement

Defined in: src/canvas/SelectableCanvas.ts:1112

Returns <canvas> element on which object selection is drawn

Returns

HTMLCanvasElement

Inherited from

SelectableCanvas.getSelectionElement

---

getTopContext()

getTopContext(): CanvasRenderingContext2D

Defined in: src/canvas/SelectableCanvas.ts:1095

Returns context of top canvas where interactions are drawn

Returns

CanvasRenderingContext2D

Inherited from

SelectableCanvas.getTopContext

---

getViewportPoint()

getViewportPoint(e): Point

Defined in: src/canvas/SelectableCanvas.ts:990

Parameters

e

TPointerEvent

Returns

Point

point existing in the same plane as the HTMLCanvasElement, (0, 0) being the top left corner of the HTMLCanvasElement. This means that changes to the viewportTransform do not change the values of the point and it remains unchanged from the viewer’s perspective.

Example

const scenePoint = sendPointToPlane(
 this.getViewportPoint(e),
 undefined,
 canvas.viewportTransform
);

Inherited from

SelectableCanvas.getViewportPoint

---

getVpCenter()

getVpCenter(): Point

Defined in: src/canvas/StaticCanvas.ts:741

Calculate the point in canvas that correspond to the center of actual viewport.

Returns

Point

vpCenter, viewport center

Inherited from

SelectableCanvas.getVpCenter

---

getWidth()

getWidth(): number

Defined in: src/canvas/StaticCanvas.ts:274

Returns canvas width (in px)

Returns

number

Inherited from

SelectableCanvas.getWidth

---

getZoom()

getZoom(): number

Defined in: src/canvas/StaticCanvas.ts:344

Returns canvas zoom level

Returns

number

Inherited from

SelectableCanvas.getZoom

---

insertAt()

insertAt(index, …objects): number

Defined in: src/canvas/StaticCanvas.ts:216

Inserts an object into collection at specified index

Parameters

index

number

Index to insert object at

objects

…FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

Object(s) to insert

Returns

number

new array length

Inherited from

SelectableCanvas.insertAt

---

isEmpty()

isEmpty(): boolean

Defined in: src/Collection.ts:128

Returns true if collection contains no objects

Returns

boolean

true if collection is empty

Inherited from

SelectableCanvas.isEmpty

---

isTargetTransparent()

isTargetTransparent(target, x, y): boolean

Defined in: src/canvas/SelectableCanvas.ts:460

Returns true if object is transparent at a certain location Clarification: this is is target transparent at location X or are controls there

Parameters

target

FabricObject

Object to check

x

number

Left coordinate in viewport space

y

number

Top coordinate in viewport space

Returns

boolean

TODO

this seems dumb that we treat controls with transparency. we can find controls programmatically without painting them, the cache canvas optimization is always valid

Inherited from

SelectableCanvas.isTargetTransparent

---

item()

item(index): FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Defined in: src/Collection.ts:120

Returns object at specified index

Parameters

index

number

Returns

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

object at index

Inherited from

SelectableCanvas.item

---

loadFromJSON()

loadFromJSON(json, reviver?, options?): Promise<Canvas>

Defined in: src/canvas/StaticCanvas.ts:1221

Populates canvas with data from the specified JSON. JSON format must conform to the one of fabric.Canvas#toJSON

IMPORTANT: It is recommended to abort loading tasks before calling this method to prevent race conditions and unnecessary networking

Parameters

json

JSON string or object

string | Record<string, any>

reviver?

<T>(serializedObj, instance) => void

Method for further parsing of JSON elements, called after each fabric object created.

options?

Abortable = {}

options

Returns

Promise<Canvas>

instance

See

• http://fabricjs.com/fabric-intro-part-3#deserialization
• demo

Examples

canvas.loadFromJSON(json).then((canvas) => canvas.requestRenderAll());

canvas.loadFromJSON(json, function(o, object) {
  // `o` = json object
  // `object` = fabric.Object instance
  // ... do some stuff ...
}).then((canvas) => {
  ... canvas is restored, add your code.
});

Inherited from

SelectableCanvas.loadFromJSON

---

moveObjectTo()

moveObjectTo(object, index): boolean

Defined in: src/Collection.ts:262

Moves an object to specified level in stack of drawn objects

Parameters

object

FabricObject

Object to send

index

number

Position to move to

Returns

boolean

true if change occurred

Inherited from

SelectableCanvas.moveObjectTo

---

off()

Call Signature

off<K>(eventName): void

Defined in: src/Observable.ts:122

Unsubscribe all event listeners for eventname. Do not use this pattern. You could kill internal fabricJS events. We know we should have protected events for internal flows, but we don’t have yet

Deprecated

This API is no longer supported and may be removed in a future release.

Type Parameters

K

K extends keyof CanvasEvents

Parameters

eventName

K

event name (eg. ‘after:render’)

Returns

void

Inherited from

SelectableCanvas.off

Call Signature

off<K>(eventName, handler): void

Defined in: src/Observable.ts:128

unsubscribe an event listener

Type Parameters

K

K extends keyof CanvasEvents

Parameters

eventName

K

event name (eg. ‘after:render’)

handler

TEventCallback

event listener to unsubscribe

Returns

void

Inherited from

SelectableCanvas.off

Call Signature

off(handlers): void

Defined in: src/Observable.ts:133

unsubscribe event listeners

Parameters

handlers

EventRegistryObject<EventSpec>

handlers key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})

Returns

void

Inherited from

SelectableCanvas.off

Call Signature

off(): void

Defined in: src/Observable.ts:137

unsubscribe all event listeners

Returns

void

Inherited from

SelectableCanvas.off

---

on()

Call Signature

on<K, E>(eventName, handler): VoidFunction

Defined in: src/Observable.ts:23

Observes specified event

Type Parameters

K

K extends keyof CanvasEvents

E

E extends TPointerEventInfo<TPointerEvent> | TPointerEventInfo<TPointerEvent> & object | TPointerEventInfo<WheelEvent> | TPointerEventInfo<TPointerEvent> & InEvent | TPointerEventInfo<TPointerEvent> & OutEvent | TPointerEventInfo<TPointerEvent> & TPointerEventInfo<TPointerEvent> & object | SimpleEventHandler<Event> | DragEventData | DragEventData & InEvent | DragEventData & OutEvent | TEventWithTarget<DragEvent> | DropEventData | { drawables: { backgroundImage?: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>; overlayImage?: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>; }; path: FabricObject; subTargets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]; targets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]; } | { path: FabricObject; } | { path: FabricObject; } | { target: IText; } | { target: IText; } | object & Partial<TEvent<TPointerEvent>> | { target: IText; } | { ctx: CanvasRenderingContext2D; } | { ctx: CanvasRenderingContext2D; } | LayoutBeforeEvent & object | LayoutAfterEvent & object | { target: FabricObject; } | { target: FabricObject; } | TEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object & ModifyPathEvent | ModifiedEvent<TPointerEvent> | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object

Parameters

eventName

K

Event name (eg. ‘after:render’)

handler

TEventCallback<E>

Function that receives a notification when an event of the specified type occurs

Returns

VoidFunction

disposer

Alias

on

Inherited from

SelectableCanvas.on

Call Signature

on(handlers): VoidFunction

Defined in: src/Observable.ts:27

Observes specified event

Parameters

handlers

EventRegistryObject<EventSpec>

key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})

Returns

VoidFunction

disposer

Alias

on

Inherited from

SelectableCanvas.on

---

once()

Call Signature

once<K, E>(eventName, handler): VoidFunction

Defined in: src/Observable.ts:62

Observes specified event once

Type Parameters

K

K extends keyof CanvasEvents

E

E extends TPointerEventInfo<TPointerEvent> | TPointerEventInfo<TPointerEvent> & object | TPointerEventInfo<WheelEvent> | TPointerEventInfo<TPointerEvent> & InEvent | TPointerEventInfo<TPointerEvent> & OutEvent | TPointerEventInfo<TPointerEvent> & TPointerEventInfo<TPointerEvent> & object | SimpleEventHandler<Event> | DragEventData | DragEventData & InEvent | DragEventData & OutEvent | TEventWithTarget<DragEvent> | DropEventData | { drawables: { backgroundImage?: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>; overlayImage?: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>; }; path: FabricObject; subTargets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]; targets: FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]; } | { path: FabricObject; } | { path: FabricObject; } | { target: IText; } | { target: IText; } | object & Partial<TEvent<TPointerEvent>> | { target: IText; } | { ctx: CanvasRenderingContext2D; } | { ctx: CanvasRenderingContext2D; } | LayoutBeforeEvent & object | LayoutAfterEvent & object | { target: FabricObject; } | { target: FabricObject; } | TEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object | BasicTransformEvent<TPointerEvent> & object & ModifyPathEvent | ModifiedEvent<TPointerEvent> | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object | Partial<TEvent<TPointerEvent>> & object

Parameters

eventName

K

Event name (eg. ‘after:render’)

handler

TEventCallback<E>

Function that receives a notification when an event of the specified type occurs

Returns

VoidFunction

disposer

Alias

once

Inherited from

SelectableCanvas.once

Call Signature

once(handlers): VoidFunction

Defined in: src/Observable.ts:66

Observes specified event once

Parameters

handlers

EventRegistryObject<EventSpec>

key/value pairs (eg. {‘after:render’: handler, ‘selection:cleared’: handler})

Returns

VoidFunction

disposer

Alias

once

Inherited from

SelectableCanvas.once

---

relativePan()

relativePan(point): void

Defined in: src/canvas/StaticCanvas.ts:402

Pans viewpoint relatively

Parameters

point

Point

(position vector) to move by

Returns

void

Inherited from

SelectableCanvas.relativePan

---

removeListeners()

removeListeners(): void

Defined in: src/canvas/Canvas.ts:210

Removes all event listeners, used when disposing the instance

Returns

void

---

renderAll()

renderAll(): void

Defined in: src/canvas/SelectableCanvas.ts:388

Renders both the top canvas and the secondary container canvas.

Returns

void

Inherited from

SelectableCanvas.renderAll

---

renderCanvas()

renderCanvas(ctx, objects): void

Defined in: src/canvas/StaticCanvas.ts:522

Renders background, objects, overlay and controls.

Parameters

ctx

CanvasRenderingContext2D

objects

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

to render

Returns

void

Inherited from

SelectableCanvas.renderCanvas

---

renderTop()

renderTop(): void

Defined in: src/canvas/SelectableCanvas.ts:428

Method to render only the top canvas. Also used to render the group selection box. Does not render text selection.

Returns

void

Inherited from

SelectableCanvas.renderTop

---

renderTopLayer()

renderTopLayer(ctx): void

Defined in: src/canvas/SelectableCanvas.ts:409

text selection is rendered by the active text instance during the rendering cycle

Parameters

ctx

CanvasRenderingContext2D

Returns

void

Inherited from

SelectableCanvas.renderTopLayer

---

requestRenderAll()

requestRenderAll(): void

Defined in: src/canvas/StaticCanvas.ts:478

Append a renderAll request to next animation frame. unless one is already in progress, in that case nothing is done a boolean flag will avoid appending more.

Returns

void

Inherited from

SelectableCanvas.requestRenderAll

---

searchPossibleTargets()

searchPossibleTargets(objects, pointer): TargetsInfoWithContainer

Defined in: src/canvas/SelectableCanvas.ts:936

Search inside an objects array the fiurst object that contains pointer Collect subTargets of that object inside the subTargets array passed as parameter

Parameters

objects

FabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>[]

objects array to look into

pointer

Point

coordinates from viewport to check.

Returns

TargetsInfoWithContainer

top most object on screen that contains pointer

Inherited from

SelectableCanvas.searchPossibleTargets

---

sendObjectBackwards()

sendObjectBackwards(object, intersecting?): boolean

Defined in: src/Collection.ts:214

Moves an object or a selection down in stack of drawn objects An optional parameter, intersecting allows to move the object in behind the first intersecting object. Where intersection is calculated with bounding box. If no intersection is found, there will not be change in the stack.

Parameters

object

FabricObject

Object to send

intersecting?

boolean

If true, send object behind next lower intersecting object

Returns

boolean

true if change occurred

Inherited from

SelectableCanvas.sendObjectBackwards

---

sendObjectToBack()

sendObjectToBack(object): boolean

Defined in: src/Collection.ts:178

Moves an object or the objects of a multiple selection to the bottom of the stack of drawn objects

Parameters

object

FabricObject

Object to send to back

Returns

boolean

true if change occurred

Inherited from

SelectableCanvas.sendObjectToBack

---

set()

set(key, value?): Canvas

Defined in: src/CommonMethods.ts:29

Sets property to a given value. When changing position/dimension -related properties (left, top, scale, angle, etc.) set does not update position of object’s borders/controls. If you need to update those, call setCoords().

Parameters

key

Property name or object (if object, iterate over the object properties)

string | Record<string, any>

value?

any

Property value (if function, the value is passed into it and its return value is used as a new one)

Returns

Canvas

Inherited from

SelectableCanvas.set

---

setActiveObject()

setActiveObject(object, e?): boolean

Defined in: src/canvas/SelectableCanvas.ts:1202

Sets given object as the only active object on canvas

Parameters

object

FabricObject

Object to set as an active one

e?

TPointerEvent

Event (passed along when firing “object:selected”)

Returns

boolean

true if the object has been selected

Inherited from

SelectableCanvas.setActiveObject

---

setCursor()

setCursor(value): void

Defined in: src/canvas/SelectableCanvas.ts:676

Set the cursor type of the canvas element

Parameters

value

string

Cursor type of the canvas element.

Returns

void

See

http://www.w3.org/TR/css3-ui/#cursor

Inherited from

SelectableCanvas.setCursor

---

setDimensions()

Call Signature

setDimensions(dimensions, options?): void

Defined in: src/canvas/StaticCanvas.ts:321

Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em)

Parameters

dimensions

Partial<CSSDimensions>

Object with width/height properties

options?

Options object

backstoreOnly?

false

Set the given dimensions only as canvas backstore dimensions

cssOnly?

true

Set the given dimensions only as css dimensions

Returns

void

Inherited from

SelectableCanvas.setDimensions

Call Signature

setDimensions(dimensions, options?): void

Defined in: src/canvas/StaticCanvas.ts:325

Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em)

Parameters

dimensions

Partial<TSize>

Object with width/height properties

options?

Options object

backstoreOnly?

true

Set the given dimensions only as canvas backstore dimensions

cssOnly?

false

Set the given dimensions only as css dimensions

Returns

void

Inherited from

SelectableCanvas.setDimensions

Call Signature

setDimensions(dimensions, options?): void

Defined in: src/canvas/StaticCanvas.ts:329

Sets dimensions (width, height) of this canvas instance. when options.cssOnly flag active you should also supply the unit of measure (px/%/em)

Parameters

dimensions

Partial<TSize>

Object with width/height properties

options?

undefined

Options object

Returns

void

Inherited from

SelectableCanvas.setDimensions

---

setViewportTransform()

setViewportTransform(vpt): void

Defined in: src/canvas/SelectableCanvas.ts:1340

Sets viewport transformation of this canvas instance

Parameters

vpt

TMat2D

a Canvas 2D API transform matrix

Returns

void

Inherited from

SelectableCanvas.setViewportTransform

---

setZoom()

setZoom(value): void

Defined in: src/canvas/StaticCanvas.ts:383

Sets zoom level of this canvas instance

Parameters

value

number

to set zoom to, less than 1 zooms out

Returns

void

Inherited from

SelectableCanvas.setZoom

---

size()

size(): number

Defined in: src/Collection.ts:136

Returns a size of a collection (i.e: length of an array containing its objects)

Returns

number

Collection size

Inherited from

SelectableCanvas.size

---

toBlob()

toBlob(options): Promise<null | Blob>

Defined in: src/canvas/StaticCanvas.ts:1341

Parameters

options

TDataUrlOptions = ...

Returns

Promise<null | Blob>

Inherited from

SelectableCanvas.toBlob

---

toCanvasElement()

toCanvasElement(multiplier?, options?): HTMLCanvasElement

Defined in: src/canvas/StaticCanvas.ts:1372

Create a new HTMLCanvas element painted with the current canvas content. No need to resize the actual one or repaint it. Will transfer object ownership to a new canvas, paint it, and set everything back. This is an intermediary step used to get to a dataUrl but also it is useful to create quick image copies of a canvas without passing for the dataUrl string

Parameters

multiplier?

number = 1

a zoom factor.

options?

TToCanvasElementOptions = ...

Cropping informations

Returns

HTMLCanvasElement

Inherited from

SelectableCanvas.toCanvasElement

---

toDatalessJSON()

toDatalessJSON(propertiesToInclude?): any

Defined in: src/canvas/StaticCanvas.ts:764

Returns dataless JSON representation of canvas

Parameters

propertiesToInclude?

string[]

Any properties that you might want to additionally include in the output

Returns

any

json string

Inherited from

SelectableCanvas.toDatalessJSON

---

toDatalessObject()

toDatalessObject(propertiesToInclude?): any

Defined in: src/canvas/StaticCanvas.ts:800

Returns dataless object representation of canvas

Parameters

propertiesToInclude?

string[]

Any properties that you might want to additionally include in the output

Returns

any

object representation of an instance

Inherited from

SelectableCanvas.toDatalessObject

---

toDataURL()

toDataURL(options?): string

Defined in: src/canvas/StaticCanvas.ts:1325

Exports canvas element to a dataurl image. Note that when multiplier is used, cropping is scaled appropriately

Parameters

options?

TDataUrlOptions = ...

Options object

Returns

string

Returns a data: URL containing a representation of the object in the format specified by options.format

See

demo

Examples

var dataURL = canvas.toDataURL({
  format: 'jpeg',
  quality: 0.8
});

var dataURL = canvas.toDataURL({
  format: 'png',
  left: 100,
  top: 100,
  width: 200,
  height: 200
});

var dataURL = canvas.toDataURL({
  format: 'png',
  multiplier: 2
});

var myObject;
var dataURL = canvas.toDataURL({
  filter: (object) => object.isContainedWithinObject(myObject) || object.intersectsWithObject(myObject)
});

Inherited from

SelectableCanvas.toDataURL

---

toggle()

toggle(property): Canvas

Defined in: src/CommonMethods.ts:46

Toggles specified property from true to false or from false to true

Parameters

property

string

Property to toggle

Returns

Canvas

Inherited from

SelectableCanvas.toggle

---

toJSON()

toJSON(): any

Defined in: src/canvas/StaticCanvas.ts:791

Returns Object representation of canvas this alias is provided because if you call JSON.stringify on an instance, the toJSON object will be invoked if it exists. Having a toJSON method means you can do JSON.stringify(myCanvas) JSON does not support additional properties because toJSON has its own signature

Returns

any

JSON compatible object

See

• http://fabricjs.com/fabric-intro-part-3#serialization
• demo

Examples

const json = canvas.toJSON();

const json = JSON.stringify(canvas);

Inherited from

SelectableCanvas.toJSON

---

toObject()

toObject(propertiesToInclude?): any

Defined in: src/canvas/StaticCanvas.ts:773

Returns object representation of canvas

Parameters

propertiesToInclude?

string[]

Any properties that you might want to additionally include in the output

Returns

any

object representation of an instance

Inherited from

SelectableCanvas.toObject

---

toString()

toString(): string

Defined in: src/canvas/StaticCanvas.ts:1475

Returns a string representation of an instance

Returns

string

string representation of an instance

Inherited from

SelectableCanvas.toString

---

toSVG()

toSVG(options?, reviver?): string

Defined in: src/canvas/StaticCanvas.ts:938

Returns SVG representation of canvas

Parameters

options?

TSVGExportOptions = {}

Options object for SVG output

reviver?

TSVGReviver

Method for further parsing of svg elements, called after each fabric object converted into svg representation.

Returns

string

SVG string

See

• http://fabricjs.com/fabric-intro-part-3#serialization
• demo

Examples

var svg = canvas.toSVG();

var svg = canvas.toSVG({suppressPreamble: true});

var svg = canvas.toSVG({
  viewBox: {
    x: 100,
    y: 100,
    width: 200,
    height: 300
  }
});

var svg = canvas.toSVG({encoding: 'ISO-8859-1'});

var svg = canvas.toSVG(null, function(svg) {
  return svg.replace('stroke-dasharray: ; stroke-linecap: butt; stroke-linejoin: miter; stroke-miterlimit: 10; ', '');
});

Inherited from

SelectableCanvas.toSVG

---

viewportCenterObject()

viewportCenterObject(object): void

Defined in: src/canvas/StaticCanvas.ts:711

Centers object vertically and horizontally in the viewport

Parameters

object

FabricObject

Object to center vertically and horizontally

Returns

void

Inherited from

SelectableCanvas.viewportCenterObject

---

viewportCenterObjectH()

viewportCenterObjectH(object): void

Defined in: src/canvas/StaticCanvas.ts:719

Centers object horizontally in the viewport, object.top is unchanged

Parameters

object

FabricObject

Object to center vertically and horizontally

Returns

void

Inherited from

SelectableCanvas.viewportCenterObjectH

---

viewportCenterObjectV()

viewportCenterObjectV(object): void

Defined in: src/canvas/StaticCanvas.ts:730

Centers object Vertically in the viewport, object.top is unchanged

Parameters

object

FabricObject

Object to center vertically and horizontally

Returns

void

Inherited from

SelectableCanvas.viewportCenterObjectV

---

zoomToPoint()

zoomToPoint(point, value): void

Defined in: src/canvas/StaticCanvas.ts:366

Sets zoom level of this canvas instance, the zoom centered around point meaning that following zoom to point with the same point will have the visual effect of the zoom originating from that point. The point won’t move. It has nothing to do with canvas center or visual center of the viewport.

Parameters

point

Point

to zoom with respect to

value

number

to set zoom to, less than 1 zooms out

Returns

void

Inherited from

SelectableCanvas.zoomToPoint

---

getDefaults()

static getDefaults(): Record<string, any>

Defined in: src/canvas/SelectableCanvas.ts:306

Returns

Record<string, any>

Inherited from

SelectableCanvas.getDefaults