the native mouse event
properties of the current transform
x position of the cursor
y position of the cursor
true if the action/event modified the object
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
'scale'
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
0
Css cursor style to display when the control is hovered.
if the method cursorStyleHandler is provided, this property is ignored.
'crosshair'
Optional mouseThe control handler for mouse down, provide one to handle mouse down on control
the native mouse event
properties of the current transform
x position of the cursor
y position of the cursor
true if the action/event modified the object
Optional mouseThe control mouseUpHandler, provide one to handle an effect on mouse up.
the native mouse event
properties of the current transform
x position of the cursor
y position of the cursor
true if the action/event modified the object
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.
0
Vertical offset of the control from the defined position. In pixels Positive offset moves the control to the bottom, negative to the top.
0
Sets the length of the control. If null, defaults to object's cornerSize. Expects both sizeX and sizeY to be set when set.
null
Sets the height of the control. If null, defaults to object's cornerSize. Expects both sizeX and sizeY to be set when set.
null
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.
null
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.
null
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.
true
If controls has an offsetY or offsetX, draw a line that connects the control to the bounding box
false
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.
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.
0
Returns the coords for this control based on object values.
cornerSize from the fabric object holding the control (or touchCornerSize if isTouch is true)
x coordinate where the control center should be
y coordinate where the control center should be
true if touch corner, false if normal corner
Returns control cursorStyle for css using cursorStyle. If you need a more elaborate function you can pass one in the constructor the cursorStyle property
the native mouse event
the current control ( likely this)
Returns control actionHandler
the native mouse event
on which the control is displayed
control for which the action handler is being asked
the action handler
Returns the action name. The basic implementation just return the actionName property.
the native mouse event
the current control ( likely this)
Returns control mouseDown handler
the native mouse event
on which the control is displayed
control for which the action handler is being asked
the action handler
Returns control mouseUp handler. During actions the fabricObject or the control can be of different obj
the native mouse event
on which the control is displayed
control for which the action handler is being asked
the action handler
Returns controls visibility
key where the control is memorized on the
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
the context where the control will be drawn
position of the canvas where we are about to render the control.
position of the canvas where we are about to render the control.
the object where the control is about to be rendered
Sets controls visibility
for the object
Generated using TypeDoc
The control actionHandler, provide one to handle action ( control being moved )