Interface ICanvas

Hierarchy

Index

Call signatures

Properties

Methods

Call signatures

(element: HTMLCanvasElement): ICanvas

Parameters

  • element: HTMLCanvasElement

Returns

ICanvas

(element: string): ICanvas

Parameters

  • element: string

Returns

ICanvas

Properties

public EMPTY_JSON: string

public _objects: IObject[]

public backgroundColor: string

public backgroundImage: string

public backgroundImageOpacity: number

public backgroundImageStretch: number

public containerClass: string

public controlsAboveOverlay: boolean

public defaultCursor: string

public freeDrawingColor: string

public freeDrawingLineWidth: number

public hoverCursor: string

public includeDefaultValues: boolean

public interactive: boolean

public moveCursor: string

public overlayImage: string

public overlayImageLeft: number

public overlayImageTop: number

public perPixelTargetFind: boolean

public renderOnAddition: boolean

public rotationCursor: string

public selection: boolean

public selectionBorderColor: string

public selectionColor: string

public selectionDashArray: Array<number>

public selectionLineWidth: number

public stateful: boolean

public targetFindTolerance: number

Methods

public add(object?: IObject[]): ICanvas

Parameters

Returns

ICanvas

public bringForward(object: IObject): ICanvas

Parameters

Returns

ICanvas

public calcOffset(): ICanvas

Returns

ICanvas

public centerObject(object: IObject): ICanvas

Parameters

Returns

ICanvas

public centerObjectH(object: IObject): ICanvas

Parameters

Returns

ICanvas

public centerObjectV(object: IObject): ICanvas

Parameters

Returns

ICanvas

public clear(): ICanvas

Returns

ICanvas

public clearContext(context: CanvasRenderingContext2D): ICanvas

Parameters

  • context: CanvasRenderingContext2D

Returns

ICanvas

public clipTo(clipFunction: (context: CanvasRenderingContext2D) => void): any

Parameters

  • clipFunction: (context: CanvasRenderingContext2D) => void

Returns

any

public complexity(): number

Returns

number

public containsPoint(e: Event, target: IObject): boolean

Parameters

Returns

boolean

public deactivateAll(): ICanvas

Returns

ICanvas

public deactivateAllWithDispatch(): ICanvas

Returns

ICanvas

public discardActiveGroup(): ICanvas

Returns

ICanvas

public discardActiveObject(): ICanvas

Returns

ICanvas

public dispose(): ICanvas

Returns

ICanvas

public drawControls(): any

Returns

any

public drawDashedLine(ctx: CanvasRenderingContext2D, x: number, y: number, x2: number, y2: number, dashArray: Array<number>): ICanvas

Parameters

  • ctx: CanvasRenderingContext2D
  • x: number
  • y: number
  • x2: number
  • y2: number
  • dashArray: Array<number>

Returns

ICanvas

public findTarget(e: MouseEvent, skipGroup: boolean): ICanvas

Parameters

  • e: MouseEvent
  • skipGroup: boolean

Returns

ICanvas

public fire(eventName: string, options: any): any

Parameters

  • eventName: string
  • options: any

Returns

any

public forEachObject(callback: (object: fabric.IObject) => void, context?: CanvasRenderingContext2D): ICanvas

Parameters

  • callback: (object: fabric.IObject) => void
  • context?: CanvasRenderingContext2D optional

Returns

ICanvas

public getActiveGroup(): IGroup

Returns

IGroup

public getActiveObject(): IObject

Returns

IObject

public getCenter(): IObject

Returns

IObject

public getContext(): CanvasRenderingContext2D

Returns

CanvasRenderingContext2D

public getElement(): HTMLCanvasElement

Returns

HTMLCanvasElement

public getHeight(): number

Returns

number

public getObjects(): IObject[]

Returns

IObject[]

public getPointer(e: any): { x: number; y: number; }

Parameters

  • e: any

Returns

{ x: number; y: number; }

public getSelectionContext(): CanvasRenderingContext2D

Returns

CanvasRenderingContext2D

public getSelectionElement(): HTMLCanvasElement

Returns

HTMLCanvasElement

public getWidth(): number

Returns

number

public insertAt(object: IObject, index: number, nonSplicing: boolean): ICanvas

Parameters

  • object: IObject
  • index: number
  • nonSplicing: boolean

Returns

ICanvas

public isEmpty(): boolean

Returns

boolean

public item(index: number): IObject

Parameters

  • index: number

Returns

IObject

public loadFromDatalessJSON(json: any, callback: () => void)

Parameters

  • json: any
  • callback: () => void

public loadFromJSON(json: any, callback: () => void)

Parameters

  • json: any
  • callback: () => void

public observe(eventCollection: IEventList): any

Parameters

Returns

any

public observe(eventName: string, handler: (e: any) => any): any

Parameters

  • eventName: string
  • handler: (e: any) => any

Returns

any

public off(eventName: any, handler: any): any

Parameters

  • eventName: any
  • handler: any

Returns

any

public on(eventCollection: IEventList): any

Parameters

Returns

any

public on(eventName: string, handler: (e: any) => any): any

Parameters

  • eventName: string
  • handler: (e: any) => any

Returns

any

public onBeforeScaleRotate(target: IObject): any

Parameters

Returns

any

public remove(object: IObject): IObject

Parameters

Returns

IObject

public renderAll(allOnTop?: boolean): ICanvas

Parameters

  • allOnTop?: boolean optional

Returns

ICanvas

public renderTop(): ICanvas

Returns

ICanvas

public sendBackwards(object: IObject): ICanvas

Parameters

Returns

ICanvas

public sendToBack(object: IObject): ICanvas

Parameters

Returns

ICanvas

public setActiveGroup(group: IGroup): ICanvas

Parameters

Returns

ICanvas

public setActiveObject(object: IObject, e?: any): ICanvas

Parameters

Returns

ICanvas

public setBackgroundImage(object: IObject): ICanvas

Parameters

Returns

ICanvas

public setDimensions(object: { width: number; height: number; }): ICanvas

Parameters

  • object: { width: number; height: number; }

Returns

ICanvas

public setHeight(height: number): ICanvas

Parameters

  • height: number

Returns

ICanvas

public setOverlayImage(url: string, callback: () => any, options: any): ICanvas

Parameters

  • url: string
  • callback: () => any
  • options: any

Returns

ICanvas

public setWidth(width: number): ICanvas

Parameters

  • width: number

Returns

ICanvas

public stopObserving(eventName: string, handler: (e: any) => any): any

Parameters

  • eventName: string
  • handler: (e: any) => any

Returns

any

public supports(methodName: string): boolean

Parameters

  • methodName: string

Returns

boolean

public toDataURL(format: string, quality?: number): string

Parameters

  • format: string
  • quality?: number optional

Returns

string

public toDataURLWithMultiplier(propertiesToInclude: Array<any>): string

Parameters

  • propertiesToInclude: Array<any>

Returns

string

public toDatalessJSON(propertiesToInclude?: Array<any>): string

Parameters

  • propertiesToInclude?: Array<any> optional

Returns

string

public toDatalessObject(propertiesToInclude?: Array<any>): string

Parameters

  • propertiesToInclude?: Array<any> optional

Returns

string

public toGrayscale(propertiesToInclude: Array<any>): string

Parameters

  • propertiesToInclude: Array<any>

Returns

string

public toJSON(propertiesToInclude: Array<any>): string

Parameters

  • propertiesToInclude: Array<any>

Returns

string

public toObject(propertiesToInclude: Array<any>): string

Parameters

  • propertiesToInclude: Array<any>

Returns

string

public toSVG(): string

Returns

string

public tostring(): string

Returns

string