Control

Constructors

new Control()

new Control(options?): Control

Parameters

• options?: Partial<Control>

Returns

Control

Defined in

src/controls/Control.ts:142

Properties

actionHandler

actionHandler: TransformActionHandler

The control actionHandler, provide one to handle action ( control being moved )

Param

the native mouse event

Param

properties of the current transform

Param

x position of the cursor

Param

y position of the cursor

Defined in

src/controls/Control.ts:154

actionName

actionName: string = SCALE

Name of the action that the control will likely execute. This is optional. FabricJS uses to identify what the user is doing for some extra optimizations. If you are writing a custom control and you want to know somewhere else in the code what is going on, you can use this string here. you can also provide a custom getActionName if your control run multiple actions depending on some external state. default to scale since is the most common, used on 4 corners by default

Default

'scale'

Defined in

src/controls/Control.ts:43

angle

angle: number = 0

Drawing angle of the control. NOT used for now, but name marked as needed for internal logic example: to reuse the same drawing function for different rotated controls

Default

Defined in

src/controls/Control.ts:52

cursorStyle

cursorStyle: string = 'crosshair'

Css cursor style to display when the control is hovered. if the method cursorStyleHandler is provided, this property is ignored.

Default

'crosshair'

Defined in

src/controls/Control.ts:132

mouseDownHandler?

optional mouseDownHandler: ControlActionHandler

The control handler for mouse down, provide one to handle mouse down on control

Param

the native mouse event

Param

properties of the current transform

Param

x position of the cursor

Param

y position of the cursor

Defined in

src/controls/Control.ts:164

mouseUpHandler?

optional mouseUpHandler: ControlActionHandler

The control mouseUpHandler, provide one to handle an effect on mouse up.

Param

the native mouse event

Param

properties of the current transform

Param

x position of the cursor

Param

y position of the cursor

Defined in

src/controls/Control.ts:174

offsetX

offsetX: number = 0

Horizontal offset of the control from the defined position. In pixels Positive offset moves the control to the right, negative to the left. It used when you want to have position of control that does not scale with the bounding box. Example: rotation control is placed at x:0, y: 0.5 on the boundind box, with an offset of 30 pixels vertically. Those 30 pixels will stay 30 pixels no matter how the object is big. Another example is having 2 controls in the corner, that stay in the same position when the object scale. of the bounding box.

Default

Defined in

src/controls/Control.ts:84

offsetY

offsetY: number = 0

Vertical offset of the control from the defined position. In pixels Positive offset moves the control to the bottom, negative to the top.

Default

Defined in

src/controls/Control.ts:92

sizeX

sizeX: number = 0

Sets the length of the control. If null, defaults to object’s cornerSize. Expects both sizeX and sizeY to be set when set.

Default

null

Defined in

src/controls/Control.ts:100

sizeY

sizeY: number = 0

Sets the height of the control. If null, defaults to object’s cornerSize. Expects both sizeX and sizeY to be set when set.

Default

null

Defined in

src/controls/Control.ts:108

touchSizeX

touchSizeX: number = 0

Sets the length of the touch area of the control. If null, defaults to object’s touchCornerSize. Expects both touchSizeX and touchSizeY to be set when set.

Default

null

Defined in

src/controls/Control.ts:116

touchSizeY

touchSizeY: number = 0

Sets the height of the touch area of the control. If null, defaults to object’s touchCornerSize. Expects both touchSizeX and touchSizeY to be set when set.

Default

null

Defined in

src/controls/Control.ts:124

visible

visible: boolean = true

keep track of control visibility. mainly for backward compatibility. if you do not want to see a control, you can remove it from the control set.

Default

true

Defined in

src/controls/Control.ts:30

withConnection

withConnection: boolean = false

If controls has an offsetY or offsetX, draw a line that connects the control to the bounding box

Default

false

Defined in

src/controls/Control.ts:140

x

x: number = 0

Relative position of the control. X 0,0 is the center of the Object, while -0.5 (left) or 0.5 (right) are the extremities of the bounding box.

Default

Defined in

src/controls/Control.ts:61

y

y: number = 0

Relative position of the control. Y 0,0 is the center of the Object, while -0.5 (top) or 0.5 (bottom) are the extremities of the bounding box.

Default

Defined in

src/controls/Control.ts:70

Methods

calcCornerCoords()

calcCornerCoords(angle, objectCornerSize, centerX, centerY, isTouch, fabricObject): object

Returns the coords for this control based on object values.

Parameters

• angle: TDegree

• objectCornerSize: number

cornerSize from the fabric object holding the control (or touchCornerSize if isTouch is true)

• centerX: number

x coordinate where the control center should be

• centerY: number

y coordinate where the control center should be

• isTouch: boolean

true if touch corner, false if normal corner

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

object

bl

bl: Point

br

br: Point

tl

tl: Point

tr

tr: Point

Defined in

src/controls/Control.ts:312

cursorStyleHandler()

cursorStyleHandler(eventData, control, fabricObject): string

Returns control cursorStyle for css using cursorStyle. If you need a more elaborate function you can pass one in the constructor the cursorStyle property

Parameters

• eventData: TPointerEvent

the native mouse event

• control: Control

the current control ( likely this)

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

string

Defined in

src/controls/Control.ts:245

getActionHandler()

getActionHandler(eventData, fabricObject, control): undefined | TransformActionHandler

Returns control actionHandler

Parameters

• eventData: TPointerEvent

the native mouse event

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

on which the control is displayed

• control: Control

control for which the action handler is being asked

Returns

undefined | TransformActionHandler

the action handler

Defined in

src/controls/Control.ts:197

getActionName()

getActionName(eventData, control, fabricObject): string

Returns the action name. The basic implementation just return the actionName property.

Parameters

• eventData: TPointerEvent

the native mouse event

• control: Control

the current control ( likely this)

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

Returns

string

Defined in

src/controls/Control.ts:260

getMouseDownHandler()

getMouseDownHandler(eventData, fabricObject, control): undefined | ControlActionHandler

Returns control mouseDown handler

Parameters

• eventData: TPointerEvent

the native mouse event

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

on which the control is displayed

• control: Control

control for which the action handler is being asked

Returns

undefined | ControlActionHandler

the action handler

Defined in

src/controls/Control.ts:212

getMouseUpHandler()

getMouseUpHandler(eventData, fabricObject, control): undefined | ControlActionHandler

Returns control mouseUp handler. During actions the fabricObject or the control can be of different obj

Parameters

• eventData: TPointerEvent

the native mouse event

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

on which the control is displayed

• control: Control

control for which the action handler is being asked

Returns

undefined | ControlActionHandler

the action handler

Defined in

src/controls/Control.ts:228

getVisibility()

getVisibility(fabricObject, controlKey): boolean

Returns controls visibility

Parameters

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

• controlKey: string

key where the control is memorized on the

Returns

boolean

Defined in

src/controls/Control.ts:274

positionHandler()

positionHandler(dim, finalMatrix, fabricObject, currentControl): Point

Parameters

• dim: Point

• finalMatrix: TMat2D

• fabricObject: InteractiveFabricObject<Partial<FabricObjectProps>, SerializedObjectProps, ObjectEvents>

• currentControl: Control

Returns

Point

Defined in

src/controls/Control.ts:291

render()

render(ctx, left, top, styleOverride, fabricObject): void

Render function for the control. When this function runs the context is unscaled. unrotate. Just retina scaled. all the functions will have to translate to the point left,top before starting Drawing if they want to draw a control where the position is detected. left and top are the result of the positionHandler function