new Group()
Group class
组织类
- Mixes In:
- Source:
- Tutorials:
- See:
-
- fabric.Group#initialize for constructor definition
Extends
Members
__corner :number|string|any
keeps the value of the last hovered corner during mouse move.
0 is no corner, or 'mt', 'ml', 'mtr' etc..
It should be private, but there is no harm in using it as
a read-only property.
保持鼠标移动时最后一个悬停角的值。
0表示没有角,或者'mt', 'ml', 'mtr'等。
它应该是私人的,但是把它用作
一个只读属性。
Type:
- number | string | any
- Inherited From:
- Default Value:
-
- 0
- Source:
absolutePositioned :boolean
Meaningful ONLY when the object is used as clipPath.
if true, the clipPath will have its top and left relative to canvas, and will
not be influenced by the object transform. This will make the clipPath relative
to the canvas, but clipping just a particular object.
WARNING this is beta, this feature may change or be renamed.
since 2.4.0
只有当对象用作clipPath时才有意义。
如果为true, clipPath将有它的顶部和左侧相对于画布,并将
不受对象变换的影响。这将使clipPath成为相对的
到画布上,但只是剪切一个特定的对象。
警告:这是测试版,此功能可能会更改或重新命名。
自从测试盒框
Type:
- boolean
- Inherited From:
- Default Value:
-
- false
- Source:
aCoords
Describe object's corner position in canvas object absolute coordinates
properties are tl,tr,bl,br and describe the four main corner.
each property is an object with x, y, instance of Fabric.Point.
The coordinates depends from this properties: width, height, scaleX, scaleY
skewX, skewY, angle, strokeWidth, top, left.
Those coordinates are useful to understand where an object is. They get updated
with oCoords but they do not need to be updated when zoom or panning change.
The coordinates get updated with @method setCoords.
You can calculate them without updating with @method calcACoords();
描述对象在画布对象绝对坐标中的角位置
属性是tl,tr,bl,br,并描述了四个主要角。
每个属性都是Fabric.Point的x、y、实例的对象。
坐标取决于这些属性:width, height, scaleX, scaleY
skewX, skewY,角度,strokeWidth,顶部,左边。
这些坐标对于了解物体的位置很有用。他们得到更新
与oCoords,但他们不需要更新时缩放或平移变化。
坐标通过@method setcoordinates更新。
你可以计算它们不更新@method calcACoords();
- Inherited From:
- Source:
angle :Number
Angle of rotation of an object (in degrees)
物体的旋转角度(以度为单位)
Type:
- Number
- Inherited From:
- Source:
backgroundColor :String
Background color of an object.
takes css colors https://www.w3.org/TR/css-color-3/
物体的背景颜色。
使用css颜色https://www.w3.org/TR/css-color-3/
Type:
- String
- Inherited From:
- Source:
borderColor :String
Color of controlling borders of an object (when it's active)
控制对象边框的颜色(当对象处于活动状态时)
Type:
- String
- Inherited From:
- Default Value:
-
- rgb(178,204,255)
- Source:
borderDashArray :Array
Array specifying dash pattern of an object's borders (hasBorder must be true)
指定对象边框的破折号样式的数组(hasBorder必须为true)
Type:
- Array
- Since:
-
- 1.6.2
- Inherited From:
- Source:
borderOpacityWhenMoving :Number
Opacity of object's controlling borders when object is active and moving
当对象处于活动和移动状态时,对象控制边框的不透明度
Type:
- Number
- Inherited From:
- Default Value:
-
- 0.4
- Source:
borderScaleFactor :Number
Scale factor of object's controlling borders
bigger number will make a thicker border
border is 1, so this is basically a border thickness
since there is no way to change the border itself.
物体控制边界的比例因子
数字越大,边框越厚
Border是1,这就是边框的厚度
因为没有办法改变边界本身。
Type:
- Number
- Inherited From:
- Default Value:
-
- 1
- Source:
cacheProperties :Array
Groups are container, do not render anything on theyr own, ence no cache properties
组是容器,它们自己不呈现任何东西,没有缓存属性
Type:
- Array
- Overrides:
- Default Value:
-
-
[]
-
- Source:
centeredRotation :Boolean
When true, this object will use center point as the origin of transformation
when being rotated via the controls.
Backwards incompatibility note: This property replaces "centerTransform" (Boolean).
当为true时,该对象将使用中心点作为变换原点
当通过控制旋转时。
注意:此属性将替换“centerTransform”(布尔值)。
Type:
- Boolean
- Since:
-
- 1.3.4
- Inherited From:
- Default Value:
-
- true
- Source:
centeredScaling :Boolean
When true, this object will use center point as the origin of transformation
when being scaled via the controls.
Backwards incompatibility note: This property replaces "centerTransform" (Boolean).
当为true时,该对象将使用中心点作为变换原点
当通过控制进行缩放时。
注意:此属性将替换“centerTransform”(布尔值)。
Type:
- Boolean
- Since:
-
- 1.3.4
- Inherited From:
- Source:
clipPath :fabric.Object
a fabricObject that, without stroke define a clipping area with their shape. filled in black
the clipPath object gets used when the object has rendered, and the context is placed in the center
of the object cacheCanvas.
If you want 0,0 of a clipPath to align with an object center, use clipPath.originX/Y to 'center'
一个fabricObject,没有描边,用它们的形状定义一个裁剪区域。填充黑色
clipPath对象在呈现对象时被使用,上下文被放置在中间
对象cachcanvas的。
如果希望clipPath的0,0与对象中心对齐,请使用clipPath。originX / Y“中心”
Type:
- Inherited From:
- Source:
colorProperties :Array
List of properties to consider for animating colors.
动画颜色需要考虑的属性列表。
Type:
- Array
- Inherited From:
- Source:
controls
custom controls interface
controls are added by default_controls.js
自定义控件接口
通过default_controls.js添加控件
- Inherited From:
- Source:
cornerColor :String
Color of controlling corners of an object (when it's active)
物体控制角的颜色(当它处于活动状态时)
Type:
- String
- Inherited From:
- Default Value:
-
- rgb(178,204,255)
- Source:
cornerDashArray :Array
Array specifying dash pattern of an object's control (hasBorder must be true)
指定对象控件的破折号样式的数组(hasBorder必须为true)
Type:
- Array
- Since:
-
- 1.6.2
- Inherited From:
- Source:
cornerSize :Number
Size of object's controlling corners (in pixels)
对象控制角的大小(像素)
Type:
- Number
- Inherited From:
- Default Value:
-
- 13
- Source:
cornerStrokeColor :String
Color of controlling corners of an object (when it's active and transparentCorners false)
控制对象角的颜色(当它是活动的并且transparentCorners为false时)
Type:
- String
- Since:
-
- 1.6.2
- Inherited From:
- Source:
cornerStyle :String
Specify style of control, 'rect' or 'circle'
指定控件的样式,'rect'或'circle'
Type:
- String
- Since:
-
- 1.6.2
- Inherited From:
- Source:
dirty :Boolean
When set to `true`, object's cache will be rerendered next render call.
since 1.7.0
当设置为' true '时,对象的缓存将在下一次渲染调用时被重新渲染。
自从1.7.0
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
evented :Boolean
When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4
当设置为' false '时,对象不能成为事件的目标。所有事件都通过它传播。介绍了v1.3.4
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
excludeFromExport :Boolean
When `true`, object is not exported in OBJECT/JSON
当' true '时,对象不会以object /JSON的形式导出
Type:
- Boolean
- Since:
-
- 1.6.3
- Inherited From:
- Source:
fill :String
Color of object's fill
takes css colors https://www.w3.org/TR/css-color-3/
对象填充的颜色
使用css颜色https://www.w3.org/TR/css-color-3/
Type:
- String
- Inherited From:
- Default Value:
-
- rgb(0,0,0)
- Source:
fillRule :String
Fill rule used to fill an object
accepted values are nonzero, evenodd
Backwards incompatibility note: This property was used for setting globalCompositeOperation until v1.4.12 (use `fabric.Object#globalCompositeOperation` instead)
填充规则,用于填充对象
接受的值是非零的,甚至是奇数的
注意:此属性在v1.4.12之前被用于设置globalCompositeOperation(使用' fabric. net ')。对象# globalCompositeOperation '而不是)
Type:
- String
- Inherited From:
- Default Value:
-
- nonzero
- Source:
flipX :Boolean
When true, an object is rendered as flipped horizontally
当为true时,对象被渲染为水平翻转
Type:
- Boolean
- Inherited From:
- Source:
flipY :Boolean
When true, an object is rendered as flipped vertically
当为true时,对象被渲染为垂直翻转
Type:
- Boolean
- Inherited From:
- Source:
globalCompositeOperation :String
Composite rule used for canvas globalCompositeOperation
用于画布globalCompositeOperation的合成规则
Type:
- String
- Inherited From:
- Default Value:
-
- source-over
- Source:
hasBorders :Boolean
When set to `false`, object's controlling borders are not rendered
当设置为' false '时,对象的控制边界不会被渲染
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
hasControls :Boolean
When set to `false`, object's controls are not displayed and can not be used to manipulate object
当设置为' false '时,对象的控件不显示,也不能用于操作对象
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
hoverCursor :String
Default cursor value used when hovering over this object on canvas
悬停在画布上此对象上时使用的默认游标值
Type:
- String
- Inherited From:
- Source:
includeDefaultValues :Boolean
When `false`, default object's values are not included in its serialization
当' false '时,默认对象的值不包含在其序列化中
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
inverted :boolean
Meaningful ONLY when the object is used as clipPath.
if true, the clipPath will make the object clip to the outside of the clipPath
since 2.4.0
只有当对象用作clipPath时才有意义。
如果为true, clipPath将使对象剪辑到clipPath的外部
自从测试盒框
Type:
- boolean
- Inherited From:
- Default Value:
-
- false
- Source:
left :Number
Left position of an object. Note that by default it's relative to object left. You can change this by setting originX={left/center/right}
物体的左侧位置。注意,默认情况下它是相对于左对象的。您可以通过设置originX={左/中/右}来改变这一点。
Type:
- Number
- Inherited From:
- Source:
lineCoords
Describe object's corner position in canvas element coordinates.
includes padding. Used of object detection.
set and refreshed with setCoords.
在画布元素坐标中描述对象的角位置。
包括填充。用于物体检测
设置和刷新setCoords。
- Inherited From:
- Source:
lockMovementX :Boolean
When `true`, object horizontal movement is locked
当' true '时,对象水平移动被锁定
Type:
- Boolean
- Inherited From:
- Source:
lockMovementY :Boolean
When `true`, object vertical movement is locked
当' true '时,物体垂直移动被锁定
Type:
- Boolean
- Inherited From:
- Source:
lockRotation :Boolean
When `true`, object rotation is locked
当' true '时,对象旋转锁定
Type:
- Boolean
- Inherited From:
- Source:
lockScalingFlip :Boolean
When `true`, object cannot be flipped by scaling into negative values
当' true '时,对象不能通过缩放到负值来翻转
Type:
- Boolean
- Inherited From:
- Source:
lockScalingX :Boolean
When `true`, object horizontal scaling is locked
当' true '时,对象水平缩放被锁定
Type:
- Boolean
- Inherited From:
- Source:
lockScalingY :Boolean
When `true`, object vertical scaling is locked
当' true '时,对象垂直缩放锁定
Type:
- Boolean
- Inherited From:
- Source:
lockSkewingX :Boolean
When `true`, object horizontal skewing is locked
当' true '时,对象水平倾斜被锁定
Type:
- Boolean
- Inherited From:
- Source:
lockSkewingY :Boolean
When `true`, object vertical skewing is locked
当' true '时,对象垂直倾斜被锁定
Type:
- Boolean
- Inherited From:
- Source:
minScaleLimit :Number
Minimum allowed scale value of an object
对象允许的最小缩放值
Type:
- Number
- Inherited From:
- Source:
moveCursor :String
Default cursor value used when moving this object on canvas
在画布上移动此对象时使用的默认游标值
Type:
- String
- Inherited From:
- Source:
noScaleCache :Boolean
When `true`, cache does not get updated during scaling. The picture will get blocky if scaled
too much and will be redrawn with correct details at the end of scaling.
this setting is performance and application dependant.
default to true
since 1.7.0
当' true '时,缓存在伸缩过程中不会更新。这幅画按比例放大就会变得块状
太多,会在缩放结束时用正确的细节重新绘制。
此设置取决于性能和应用程序。
默认为true
自从1.7.0
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
objectCaching :Boolean
When `true`, object is cached on an additional canvas.
When `false`, object is not cached unless necessary ( clipPath )
default to true
当' true '时,对象被缓存到额外的画布上。
当' false '时,除非必要,否则不会缓存对象(clipPath)
默认为true
Type:
- Boolean
- Since:
-
- 1.7.0
- Inherited From:
- Default Value:
-
- true
- Source:
oCoords
Describe object's corner position in canvas element coordinates.
properties are depending on control keys and padding the main controls.
each property is an object with x, y and corner.
The `corner` property contains in a similar manner the 4 points of the
interactive area of the corner.
The coordinates depends from the controls positionHandler and are used
to draw and locate controls
在画布元素坐标中描述对象的角位置。
属性取决于控制键和填充主控件。
每个属性都是一个包含x、y和corner的对象。
' corner '属性以类似的方式包含
角落的互动区域。
坐标依赖于控件positionHandler并被使用
绘制和定位控件
- Inherited From:
- Source:
originX :String
Horizontal origin of transformation of an object (one of "left", "right", "center")
See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups
物体变换的横向原点(“左”、“右”、“中”之一)
参见http://jsfiddle.net/1ow02gea/244/了解originX/originY如何影响组中的对象
Type:
- String
- Inherited From:
- Default Value:
-
- left
- Source:
originY :String
Vertical origin of transformation of an object (one of "top", "bottom", "center")
See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups
物体变换的垂直原点(“上”、“下”、“中心”之一)
参见http://jsfiddle.net/1ow02gea/244/了解originX/originY如何影响组中的对象
Type:
- String
- Inherited From:
- Default Value:
-
- top
- Source:
padding :Number
Padding between object and its controlling borders (in pixels)
对象及其控制边界之间的填充(像素单位)
Type:
- Number
- Inherited From:
- Source:
paintFirst :String
Determines if the fill or the stroke is drawn first (one of "fill" or "stroke")
确定是先绘制填充还是先绘制描边("fill"或"stroke"之一)
Type:
- String
- Inherited From:
- Default Value:
-
- fill
- Source:
perPixelTargetFind :Boolean
When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box
当设置为“true”时,在画布上按像素“找到”对象,而不是根据边界框
Type:
- Boolean
- Inherited From:
- Source:
scaleX :Number
Object scale factor (horizontal)
物体比例因子(水平)
Type:
- Number
- Inherited From:
- Default Value:
-
- 1
- Source:
scaleY :Number
Object scale factor (vertical)
物体比例因子(垂直)
Type:
- Number
- Inherited From:
- Default Value:
-
- 1
- Source:
selectable :Boolean
When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection).
But events still fire on it.
当设置为' false '时,不能选择对象进行修改(使用基于点单击的选择或基于组的选择)。
但事情还是发生了。
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
selectionBackgroundColor :String
Selection Background color of an object. colored layer behind the object when it is active.
does not mix good with globalCompositeOperation methods.
选择对象的背景颜色。当对象被激活时,后面的彩色层。
不能很好地与globalCompositeOperation方法混合。
Type:
- String
- Inherited From:
- Source:
shadow :fabric.Shadow
Shadow object representing shadow of this shape
表示此形状阴影的阴影对象
Type:
- Inherited From:
- Source:
skewX :Number
Angle of skew on x axes of an object (in degrees)
物体在x轴上的倾斜角(单位:度)
Type:
- Number
- Inherited From:
- Source:
skewY :Number
Angle of skew on y axes of an object (in degrees)
物体在y轴上的倾斜角(单位:度)
Type:
- Number
- Inherited From:
- Source:
statefullCache :Boolean
When `true`, object properties are checked for cache invalidation. In some particular
situation you may want this to be disabled ( spray brush, very big, groups)
or if your application does not allow you to modify properties for groups child you want
to disable it for groups.
default to false
since 1.7.0
当' true '时,将检查对象属性是否缓存无效。在某些特定的
你可能想要禁用的情况(喷雾刷,非常大,组)
或者如果您的应用程序不允许您修改您想要的组子的属性
为组禁用它。
缺省为false
自从1.7.0
Type:
- Boolean
- Inherited From:
- Default Value:
-
- false
- Source:
stateProperties :Array
List of properties to consider when checking if state
of an object is changed (fabric.Object#hasStateChanged)
as well as for history (undo/redo) purposes
检查if状态时要考虑的属性列表
对象的值被改变了(fabric.Object#hasStateChanged)
以及历史(撤消/重做)的目的
Type:
- Array
- Inherited From:
- Source:
stroke :String
When defined, an object is rendered via stroke and this property specifies its color
takes css colors https://www.w3.org/TR/css-color-3/
定义后,对象通过描边呈现,此属性指定其颜色
使用css颜色https://www.w3.org/TR/css-color-3/
Type:
- String
- Inherited From:
- Source:
strokeDashArray :Array
Array specifying dash pattern of an object's stroke (stroke must be defined)
指定对象笔画的虚线样式的数组(必须定义笔画)
Type:
- Array
- Inherited From:
- Source:
strokeDashOffset :Number
Line offset of an object's stroke
物体行程的线偏移量
Type:
- Number
- Inherited From:
- Source:
strokeLineCap :String
Line endings style of an object's stroke (one of "butt", "round", "square")
对象笔画的线结束样式(“屁股”、“圆”、“方”之一)
Type:
- String
- Inherited From:
- Default Value:
-
- butt
- Source:
strokeLineJoin :String
Corner style of an object's stroke (one of "bevel", "round", "miter")
物体笔画的角型(“斜角”、“圆角”、“斜角”之一)
Type:
- String
- Inherited From:
- Default Value:
-
- miter
- Source:
strokeMiterLimit :Number
Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke
对象笔画的最大斜接长度(用于strokeLineJoin = "miter")
Type:
- Number
- Inherited From:
- Default Value:
-
- 4
- Source:
strokeUniform :Boolean
When `false`, the stoke width will scale with the object.
When `true`, the stroke will always match the exact pixel size entered for stroke width.
this Property does not work on Text classes or drawing call that uses strokeText,fillText methods
default to false
当' false '时,斯托克宽度将随对象缩放。
当' true '时,笔画将始终匹配为笔画宽度输入的精确像素大小。
此属性不适用于使用strokeText、fillText方法的Text类或绘图调用
缺省为false
Type:
- Boolean
- Since:
-
- 2.6.0
- Inherited From:
- Default Value:
-
- false
- Source:
strokeWidth :Number
Width of stroke
中风的宽度
Type:
- Number
- Overrides:
- Source:
subTargetCheck :Boolean
Indicates if click, mouseover, mouseout events & hoverCursor should also check for subtargets
指示单击、鼠标悬停、鼠标移出事件和hoverCursor是否也应该检查子目标
Type:
- Boolean
- Source:
top :Number
Top position of an object. Note that by default it's relative to object top. You can change this by setting originY={top/center/bottom}
物体的顶部位置。注意,默认情况下它是相对于对象顶部的。你可以通过设置originY={top/center/bottom}来改变这一点。
Type:
- Number
- Inherited From:
- Source:
touchCornerSize :Number
Size of object's controlling corners when touch interaction is detected
检测触摸交互时物体控制角的大小
Type:
- Number
- Inherited From:
- Default Value:
-
- 24
- Source:
transparentCorners :Boolean
When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill)
当为true时,对象的控制角在内部被渲染为透明的(即描边而不是填充)
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
type :String
Type of an object
对象的类型
Type:
- String
- Overrides:
- Default Value:
-
- group
- Source:
useSetOnGroup :Boolean
setOnGroup is a method used for TextBox that is no more used since 2.0.0 The behavior is still
available setting this boolean to true.
setOnGroup是一个用于TextBox的方法,该方法自2.0.0以来不再使用
可将此布尔值设置为true。
Type:
- Boolean
- Since:
-
- 2.0.0
- Source:
visible :Boolean
When set to `false`, an object is not rendered on canvas
当设置为' false '时,对象不会在画布上渲染
Type:
- Boolean
- Inherited From:
- Default Value:
-
- true
- Source:
Methods
(static) fromObject(object, callbackopt)
Returns fabric.Group instance from an object representation
返回织物。从对象表示中将实例分组
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
object |
Object | Object to create a group from要从中创建组的对象 | |
callback |
function |
<optional> |
Callback to invoke when an group instance is created创建组实例时调用的回调 |
- Source:
_calcRotateMatrix() → {Array}
calculate rotation matrix of an object
计算物体的旋转矩阵
- Inherited From:
- Source:
Returns:
rotation matrix for the object
- Type
- Array
_calcTranslateMatrix() → {Array}
calculate the translation matrix for an object transform
计算物体变换的平移矩阵
- Inherited From:
- Source:
Returns:
rotation matrix for the object
- Type
- Array
_drawClipPath(ctx, clipPath)
Prepare clipPath state and cache and draw it on instance's cache
准备clipPath状态和缓存,并在实例的缓存上绘制它
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | 组织类 |
clipPath |
fabric.Object | 组织类 |
- Inherited From:
- Source:
_getCoords(absolute) → {Object}
return correct set of coordinates for intersection
this will return either aCoords or lineCoords.
返回交点的正确坐标集
这将返回aCoords或lineCoords。
Parameters:
Name | Type | Description |
---|---|---|
absolute |
Boolean | will return aCoords if true or lineCoords将返回aCoords如果为真或lineCoords |
- Inherited From:
- Source:
Returns:
{tl, tr, br, bl} points
- Type
- Object
_limitCacheSize(dims) → {Object|Object|Object|Object}
Limit the cache dimensions so that X * Y do not cross fabric.perfLimitSizeTotal
and each side do not cross fabric.cacheSideLimit
those numbers are configurable so that you can get as much detail as you want
making bargain with performances.
限制缓存尺寸,使X * Y不会交叉。perflimitsizetotal
并且每边不交叉
这些数字是可配置的,因此您可以获得尽可能多的详细信息
与演出讨价还价。
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
dims |
Object |
Properties
|
- Inherited From:
- Source:
Returns:
-
.width width of canvas
- Type
- Object
-
.height height of canvas
- Type
- Object
-
.zoomX zoomX zoom value to unscale the canvas before drawing cache
- Type
- Object
-
.zoomY zoomY zoom value to unscale the canvas before drawing cache
- Type
- Object
_removeCacheCanvas()
Remove cacheCanvas and its dimensions from the objects
从对象中删除cachcanvas及其维度
- Inherited From:
- Source:
_renderControls(ctx, styleOverrideopt)
Renders controls and borders for the object
the context here is not transformed
呈现对象的控件和边框
这里的上下文没有转换
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
ctx |
CanvasRenderingContext2D | Context to render on要呈现的上下文 | |
styleOverride |
Object |
<optional> |
properties to override the object style属性来覆盖对象样式 |
- Inherited From:
- Source:
_setupCompositeOperation(ctx)
Sets canvas globalCompositeOperation for specific object
custom composition operation for the particular object can be specified using globalCompositeOperation property
为特定对象设置画布globalCompositeOperation
可以使用globalCompositeOperation属性指定特定对象的自定义合成操作
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Rendering canvas context呈现画布背景 |
- Inherited From:
- Source:
_toSVG(reviveropt) → {String}
Returns svg representation of an instance
返回实例的svg表示
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reviver |
function |
<optional> |
Method for further parsing of svg representation.方法用于进一步解析svg表示。 |
- Source:
Returns:
svg representation of an instance
- Type
- String
add(…object) → {Self}
Adds objects to collection, Canvas or Group, then renders canvas
(if `renderOnAddRemove` is not `false`).
in case of Group no changes to bounding box are made.
Objects should be instances of (or inherit from) fabric.Object
Use of this function is highly discouraged for groups.
you can add a bunch of objects with the add method but then you NEED
to run a addWithUpdate call for the Group class or position/bbox will be wrong.
向集合、画布或组添加对象,然后呈现画布
(如果' renderOnAddRemove '不是' false ')。
在组的情况下,没有改变边框。
对象应该是fabric的实例(或继承自)。对象
强烈建议对团体使用此功能。
你可以用add方法添加一堆对象,但你需要
对Group类或position/bbox运行addWithUpdate调用将是错误的。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
object |
fabric.Object |
<repeatable> |
Zero or more fabric instances0个或多个结构实例 |
- Mixes In:
- Source:
Returns:
thisArg
- Type
- Self
addWithUpdate(object) → {fabric.Group}
Adds an object to a group; Then recalculates group's dimension, position.
向组中添加对象;然后重新计算组的尺寸,位置。
Parameters:
Name | Type | Description |
---|---|---|
object |
Object | 组织类 |
- Source:
Returns:
thisArg
- Type
- fabric.Group
adjustPosition(to)
Parameters:
Name | Type | Description |
---|---|---|
to |
String | One of 'left', 'center', 'right'左,中,右中的一个 |
- Inherited From:
- Source:
animate(property, value) → {fabric.Object|fabric.AnimationContext|Array.<fabric.AnimationContext>}
Animates object's properties
的对象的属性
Parameters:
Name | Type | Description |
---|---|---|
property |
String | Object | Property to animate (if string) or properties to animate (if object)属性动画(if string)或属性动画(if object) |
value |
Number | Object | Value to animate property to (if string was given first) or options object值将属性动画到(如果先给出字符串)或选项对象 |
- Inherited From:
- Source:
- Tutorials:
Returns:
-
thisArg
- Type
- fabric.Object
-
animation context (or an array if passed multiple properties) As object — multiple properties object.animate({ left: ..., top: ... }); object.animate({ left: ..., top: ... }, { duration: ... }); As string — one property object.animate('left', ...); object.animate('left', { duration: ... });
- Type
- fabric.AnimationContext | Array.<fabric.AnimationContext>
bringForward(intersectingopt) → {fabric.Object}
Moves an object up in stack of drawn objects
在绘制对象的堆栈中向上移动对象
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
intersecting |
Boolean |
<optional> |
If `true`, send object in front of next upper intersecting object如果' true ',将对象发送到上一个相交对象的前面 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
bringToFront() → {fabric.Object}
Moves an object to the top of the stack of drawn objects
将对象移动到绘制对象堆栈的顶部
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
calcOwnMatrix() → {Array}
calculate transform matrix that represents the current transformations from the
object's properties, this matrix does not include the group transformation
计算表示当前变换的变换矩阵
对象的属性,此矩阵不包括组转换
- Inherited From:
- Source:
Returns:
transform matrix for the object
- Type
- Array
calcTransformMatrix(skipGroupopt) → {Array}
calculate transform matrix that represents the current transformations from the
object's properties.
计算表示当前变换的变换矩阵
对象的属性。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
skipGroup |
Boolean |
<optional> |
return transform matrix for object not counting parent transformations There are some situation in which this is useful to avoid the fake rotation.返回不计算父转换的对象的转换矩阵 在某些情况下,这有助于避免假旋转。 |
- Inherited From:
- Source:
Returns:
transform matrix for the object
- Type
- Array
center() → {fabric.Object}
Centers object vertically and horizontally on canvas to which is was added last
You might need to call `setCoords` on an object after centering, to update controls area.
在最后添加的画布上垂直和水平地居中对象
你可能需要在定心后对对象调用setCoords来更新控件区域。
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
centerH() → {fabric.Object}
Centers object horizontally on canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
在最后添加对象的画布上水平居中。
你可能需要在定心后对对象调用setCoords来更新控件区域。
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
centerV() → {fabric.Object}
Centers object vertically on canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
将对象垂直集中在最后添加到的画布上。
你可能需要在定心后对对象调用setCoords来更新控件区域。
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
clone(callback, propertiesToIncludeopt)
Clones an instance, using a callback method will work for every object.
克隆一个实例,使用回调方法将适用于每个对象。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
function | Callback is invoked with a clone as a first argumentCallback调用时使用克隆作为第一个参数 | |
propertiesToInclude |
Array |
<optional> |
Any properties that you might want to additionally include in the output您可能希望在输出中额外包含的任何属性 |
- Inherited From:
- Source:
cloneAsImage(callback, optionsopt) → {fabric.Object}
Creates an instance of fabric.Image out of an object
makes use of toCanvasElement.
Once this method was based on toDataUrl and loadImage, so it also had a quality
and format option. toCanvasElement is faster and produce no loss of quality.
If you need to get a real Jpeg or Png from an object, using toDataURL is the right way to do it.
toCanvasElement and then toBlob from the obtained canvas is also a good option.
This method is sync now, but still support the callback because we did not want to break.
When fabricJS 5.0 will be planned, this will probably be changed to not have a callback.
创建fabric的实例。从对象中提取图像
使用toCanvasElement。
一旦这个方法是基于toDataUrl和loadImage,那么它也有一个质量
和格式的选择。toCanvasElement更快,而且不会产生质量损失。
如果需要从对象中获取真正的Jpeg或Png,使用toDataURL是正确的方法。
toCanvasElement和toBlob从获得的画布也是一个很好的选择。
这个方法现在是同步的,但仍然支持回调,因为我们不想中断。
在计划fabricJS 5.0时,这可能会更改为没有回调。
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
callback |
function | callback, invoked with an instance as a first argument回调,使用实例作为第一个参数调用 | ||||||||||||||||||||||||||||||||||||||||||||||
options |
Object |
<optional> |
for clone as image, passed to toDataURL
Properties
|
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
complexity() → {Number}
Returns number representation of a collection complexity
返回集合复杂度的数字表示
- Overrides:
- Mixes In:
- Source:
Returns:
complexity
- Type
- Number
contains(object, deepopt) → {Boolean}
Returns true if collection contains an object
如果集合包含一个对象,则返回true
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
object |
Object | Object to check against要检查的对象 | ||
deep |
Boolean |
<optional> |
false | `true` to check all descendants, `false` to check only `_objects`' true '检查所有后代,' false '只检查' _objects ' |
- Mixes In:
- Source:
Returns:
`true` if collection contains an object
- Type
- Boolean
containsPoint(point, linesopt, absoluteopt, calculateopt) → {Boolean}
Checks if point is inside the object
检查点是否在对象内部
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
point |
fabric.Point | Point to check against检查点 | |
lines |
Object |
<optional> |
object returned from @method _getImageLines对象从@method _getImageLines返回 |
absolute |
Boolean |
<optional> |
use coordinates without viewportTransform使用坐标而不使用viewportTransform |
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords使用当前位置的坐标而不是。ocoordinates |
- Inherited From:
- Source:
Returns:
true if point is inside the object
- Type
- Boolean
destroy() → {fabric.Group}
Destroys a group (restoring state of its objects)
销毁一个组(恢复其对象的状态)
- Source:
Returns:
thisArg
- Type
- fabric.Group
dispose()
cancel instance's running animations
取消实例正在运行的动画
- Overrides:
- Source:
drawBorders(ctx, styleOverride) → {fabric.Object}
Draws borders of an object's bounding box.
Requires public properties: width, height
Requires public options: padding, borderColor
绘制对象的边框。
需要公共属性:宽度,高度
需要公共选项:padding, borderColor
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to draw on使用的上下文 |
styleOverride |
Object | object to override the object style对象来覆盖对象样式 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
drawBordersInGroup(ctx, options, styleOverride) → {fabric.Object}
Draws borders of an object's bounding box when it is inside a group.
Requires public properties: width, height
Requires public options: padding, borderColor
当对象位于组内时,绘制其边界框的边框。
需要公共属性:宽度,高度
需要公共选项:padding, borderColor
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to draw on使用的上下文 |
options |
object | object representing current object parameters表示当前对象参数的对象 |
styleOverride |
Object | object to override the object style对象来覆盖对象样式 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
drawCacheOnCanvas(ctx)
Paint the cached copy of the object on the target context.
在目标上下文中绘制对象的缓存副本。
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to render on要呈现的上下文 |
- Inherited From:
- Source:
drawClipPathOnCache(ctx, clipPath)
Execute the drawing operation for an object clipPath
执行对象clipPath的绘图操作
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to render on要呈现的上下文 |
clipPath |
fabric.Object | 组织类 |
- Inherited From:
- Source:
drawControls(ctx, styleOverride) → {fabric.Object}
Draws corners of an object's bounding box.
Requires public properties: width, height
Requires public options: cornerSize, padding
绘制对象的边界框的角。
需要公共属性:宽度,高度
需要公共选项:角尺寸,填充
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to draw on使用的上下文 |
styleOverride |
Object | object to override the object style对象来覆盖对象样式 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
drawObject(ctx)
Execute the drawing operation for an object on a specified context
在指定的上下文中为对象执行绘图操作
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to render on要呈现的上下文 |
- Overrides:
- Source:
drawSelectionBackground(ctx) → {fabric.Object}
Draws a colored layer behind the object, inside its selection borders.
Requires public options: padding, selectionBackgroundColor
this function is called when the context is transformed
has checks to be skipped when the object is on a staticCanvas
在对象后面的选择边框内绘制一个彩色图层。
需要公共选项:padding, selectionBackgroundColor
在转换上下文时调用此函数
当对象在staticCanvas上时,是否要跳过检查
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context to draw on使用的上下文 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
forEachControl(fn)
Calls a function for each control. The function gets called,
with the control, the object that is calling the iterator and the control's key
为每个控件调用函数。函数被调用,
对于控件,调用迭代器的对象和控件的键
Parameters:
Name | Type | Description |
---|---|---|
fn |
function | function to iterate over the controls over函数来遍历控件 |
- Inherited From:
- Source:
forEachObject(callback, context) → {Self}
Executes given function for each object in this group
为该组中的每个对象执行给定的函数
Parameters:
Name | Type | Description |
---|---|---|
callback |
function | Callback invoked with current object as first argument, index - as second and an array of all objects - as third. Callback is invoked in a context of Global Object (e.g. `window`) when no `context` argument is given用当前对象作为第一个参数调用回调, Index——作为第二个,所有对象的数组——作为第三个。 回调是在全局对象的上下文中调用的。“窗口”) 当没有给出' context '参数时 |
context |
Object | Context (aka thisObject)上下文(即thisObject) |
- Mixes In:
- Source:
Returns:
thisArg
- Type
- Self
fxStraighten(callbacks) → {fabric.Object}
Same as fabric.Object.prototype.straighten but with animation
和fabric. object .prototype.straight一样,但是带有动画
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
callbacks |
Object | Object with callback functions
Properties
|
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
getBoundingRect(absoluteopt, calculateopt) → {Object}
Returns coordinates of object's bounding rectangle (left, top, width, height)
the box is intended as aligned to axis of canvas.
返回对象的边界矩形(左,上,宽,高)的坐标
盒子要与画布轴对齐。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
absolute |
Boolean |
<optional> |
use coordinates without viewportTransform使用坐标而不使用viewportTransform |
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords / .aCoords使用当前位置的坐标,而不是.oCoords / .aCoords |
- Inherited From:
- Source:
Returns:
Object with left, top, width, height properties
- Type
- Object
getCenterPoint() → {fabric.Point}
Returns the real center coordinates of the object
返回对象的真实中心坐标
- Inherited From:
- Source:
Returns:
- Type
- fabric.Point
getCoords() → {Array}
return correct set of coordinates for intersection
this will return either aCoords or lineCoords.
The coords are returned in an array.
返回交点的正确坐标集
这将返回aCoords或lineCoords。
这些坐标以数组的形式返回。
- Inherited From:
- Source:
Returns:
[tl, tr, br, bl] of points
- Type
- Array
getLocalPointer(e, pointeropt) → {Object}
Returns coordinates of a pointer relative to an object
返回指针相对于对象的坐标
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
e |
Event | Event to operate upon要操作的事件 | |
pointer |
Object |
<optional> |
Pointer to operate upon (instead of event)要操作的指针(而不是事件) |
- Inherited From:
- Source:
Returns:
Coordinates of a pointer (x, y)
- Type
- Object
getObjectOpacity() → {Number}
Return the object opacity counting also the group property
返回对象不透明度计数和组属性
- Inherited From:
- Source:
Returns:
- Type
- Number
getObjects(typeopt) → {Array}
Returns an array of children objects of this instance
Type parameter introduced in 1.3.10
since 2.3.5 this method return always a COPY of the array;
返回此实例的子对象数组
类型参数在1.3.10中引入
自2.3.5以来,该方法总是返回数组的副本;
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
type |
String |
<optional> |
When specified, only objects of this type are returned指定时,只返回此类型的对象 |
- Mixes In:
- Source:
Returns:
- Type
- Array
getObjectScaling() → {Object}
Return the object scale factor counting also the group scaling
返回对象缩放因子计数和组缩放
- Inherited From:
- Source:
Returns:
object with scaleX and scaleY properties
- Type
- Object
getPointByOrigin(originX, originY) → {fabric.Point}
Returns the coordinates of the object as if it has a different origin
返回对象的坐标,就好像它有不同的原点一样
Parameters:
Name | Type | Description |
---|---|---|
originX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
originY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
- Inherited From:
- Source:
Returns:
- Type
- fabric.Point
getScaledHeight() → {Number}
Returns height of an object bounding box counting transformations
before 2.0 it was named getHeight();
返回对象边界框计数转换的高度
在2.0之前,它被命名为getHeight();
- Inherited From:
- Source:
Returns:
height value
- Type
- Number
getScaledWidth() → {Number}
Returns width of an object's bounding box counting transformations
before 2.0 it was named getWidth();
返回对象的边界框计数转换的宽度
在2.0之前,它被命名为getWidth();
- Inherited From:
- Source:
Returns:
width value
- Type
- Number
getSvgCommons() → {String}
Returns id attribute for svg output
返回svg输出的id属性
- Inherited From:
- Source:
Returns:
- Type
- String
getSvgFilter() → {String}
Returns filter for svg shadow
返回svg阴影的过滤器
- Inherited From:
- Source:
Returns:
- Type
- String
getSvgSpanStyles(style, useWhiteSpace) → {String}
Returns styles-string for svg-export
返回svg-export的样式字符串
Parameters:
Name | Type | Description |
---|---|---|
style |
Object | the object from which to retrieve style properties要从中检索样式属性的对象 |
useWhiteSpace |
Boolean | a boolean to include an additional attribute in the style.在样式中包含额外属性的布尔值。 |
- Inherited From:
- Source:
Returns:
- Type
- String
getSvgStyles() → {String}
Returns styles-string for svg-export, specific version for group
返回svg-export的样式-字符串,组的特定版本
- Overrides:
- Source:
Returns:
- Type
- String
getSvgTextDecoration(style) → {String}
Returns text-decoration property for svg-export
返回svg-export的文本装饰属性
Parameters:
Name | Type | Description |
---|---|---|
style |
Object | the object from which to retrieve style properties要从中检索样式属性的对象 |
- Inherited From:
- Source:
Returns:
- Type
- String
getSvgTransform(use) → {String}
Returns transform-string for svg-export
返回用于svg-export的transform-string
Parameters:
Name | Type | Description |
---|---|---|
use |
Boolean | the full transform or the single object one.完整的变换或者单个物体的变换。 |
- Inherited From:
- Source:
Returns:
- Type
- String
getTotalObjectScaling() → {Object}
Return the object scale factor counting also the group scaling, zoom and retina
返回对象缩放因子计数,还包括组缩放、缩放和视网膜
- Inherited From:
- Source:
Returns:
object with scaleX and scaleY properties
- Type
- Object
getViewportTransform() → {Array}
Retrieves viewportTransform from Object's canvas if possible
如果可能的话,从对象的画布中检索viewportTransform
- Inherited From:
- Source:
Returns:
- Type
- Array
hasFill()
return true if the object will draw a fill
Does not consider text styles. This is just a shortcut used at rendering time
We want it to be an approximation and be fast.
wrote to avoid extra caching, it has to return true when fill happens,
can guess when it will not happen at 100% chance, does not matter if it misses
some use case where the fill is invisible.
如果对象将绘制填充,则返回true
不考虑文本样式。这只是在渲染时使用的一个快捷方式
我们希望它是一个近似值,而且要快。
为了避免额外的缓存,它必须在填充发生时返回true,
能猜出它什么时候不会发生的几率是100%吗,错过了也没关系吗
在一些用例中填充是不可见的。
- Since:
-
- 3.0.0
- Inherited From:
- Source:
Returns:
Boolean
hasStateChanged(propertySetopt) → {Boolean}
Returns true if object state (one of its state properties) was changed
如果对象状态(它的一个状态属性)被更改,则返回true
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
propertySet |
String |
<optional> |
optional name for the set of property we want to save要保存的属性集的可选名称 |
- Inherited From:
- Source:
Returns:
true if instance' state has changed since `fabric.Object#saveState` was called
- Type
- Boolean
hasStroke()
return true if the object will draw a stroke
Does not consider text styles. This is just a shortcut used at rendering time
We want it to be an approximation and be fast.
wrote to avoid extra caching, it has to return true when stroke happens,
can guess when it will not happen at 100% chance, does not matter if it misses
some use case where the stroke is invisible.
如果对象将绘制笔画,则返回true
不考虑文本样式。这只是在渲染时使用的一个快捷方式
我们希望它是一个近似值,而且要快。
为了避免额外的缓存,它必须在stroke发生时返回true,
能猜出它什么时候不会发生的几率是100%吗,错过了也没关系吗
在一些用例中,笔画是不可见的。
- Since:
-
- 3.0.0
- Inherited From:
- Source:
Returns:
Boolean
initialize(objects, optionsopt, isAlreadyGroupedopt) → {Object}
Constructor
构造函数
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
objects |
Object | Group objects组对象 | |
options |
Object |
<optional> |
Options object选择对象 |
isAlreadyGrouped |
Boolean |
<optional> |
if true, objects have been grouped already.如果为真,则对象已经分组。 |
- Overrides:
- Source:
Returns:
thisArg
- Type
- Object
insertAt(object, index, nonSplicing) → {Self}
Inserts an object into collection at specified index, then renders canvas (if `renderOnAddRemove` is not `false`)
An object should be an instance of (or inherit from) fabric.Object
Use of this function is highly discouraged for groups.
you can add a bunch of objects with the insertAt method but then you NEED
to run a addWithUpdate call for the Group class or position/bbox will be wrong.
在指定索引处的集合中插入一个对象,然后渲染画布(如果' renderOnAddRemove '不是' false ')
对象应该是fabric的实例(或从其继承)。对象
强烈建议对团体使用此功能。
你可以用insertAt方法添加一堆对象,但你需要
对Group类或position/bbox运行addWithUpdate调用将是错误的。
Parameters:
Name | Type | Description |
---|---|---|
object |
Object | Object to insert对象插入 |
index |
Number | Index to insert object at要插入对象的索引 |
nonSplicing |
Boolean | When `true`, no splicing (shifting) of objects occurs当' true '时,不会发生对象的拼接(移动) |
- Mixes In:
- Source:
Returns:
thisArg
- Type
- Self
intersectsWithObject(other, absoluteopt, calculateopt) → {Boolean}
Checks if object intersects with another object
检查对象是否与另一个对象相交
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
other |
Object | Object to test对象来测试 | |
absolute |
Boolean |
<optional> |
use coordinates without viewportTransform使用坐标而不使用viewportTransform |
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords使用当前位置的坐标而不是。ocoordinates |
- Inherited From:
- Source:
Returns:
true if object intersects with another object
- Type
- Boolean
intersectsWithRect(pointTL, pointBR, absoluteopt, calculateopt) → {Boolean}
Checks if object intersects with an area formed by 2 points
检查物体是否与2点组成的区域相交
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
pointTL |
Object | top-left point of area区域的左上角 | |
pointBR |
Object | bottom-right point of area右下角的区域 | |
absolute |
Boolean |
<optional> |
use coordinates without viewportTransform使用坐标而不使用viewportTransform |
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords使用当前位置的坐标而不是。ocoordinates |
- Inherited From:
- Source:
Returns:
true if object intersects with an area formed by 2 points
- Type
- Boolean
isCacheDirty()
Check if cache is dirty
检查缓存是否脏
- Overrides:
- Source:
isContainedWithinObject(other, absoluteopt, calculateopt) → {Boolean}
Checks if object is fully contained within area of another object
检查对象是否完全包含在另一个对象的区域内
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
other |
Object | Object to test对象来测试 | |
absolute |
Boolean |
<optional> |
use coordinates without viewportTransform使用坐标而不使用viewportTransform |
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords使用当前位置的坐标而不是。ocoordinates |
- Inherited From:
- Source:
Returns:
true if object is fully contained within area of another object
- Type
- Boolean
isContainedWithinRect(pointTL, pointBR, absoluteopt, calculateopt) → {Boolean}
Checks if object is fully contained within area formed by 2 points
检查对象是否完全包含在由2点组成的区域内
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
pointTL |
Object | top-left point of area区域的左上角 | |
pointBR |
Object | bottom-right point of area右下角的区域 | |
absolute |
Boolean |
<optional> |
use coordinates without viewportTransform使用坐标而不使用viewportTransform |
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords使用当前位置的坐标而不是。ocoordinates |
- Inherited From:
- Source:
Returns:
true if object is fully contained within area formed by 2 points
- Type
- Boolean
isControlVisible(controlKey) → {Boolean}
Returns true if the specified control is visible, false otherwise.
如果指定的控件是可见的则返回true,否则返回false。
Parameters:
Name | Type | Description |
---|---|---|
controlKey |
String | The key of the control. Possible values are 'tl', 'tr', 'br', 'bl', 'ml', 'mt', 'mr', 'mb', 'mtr'.控制键。可能的值是“tl”,“tr”,“品牌”,“提单”、“毫升”、“太”,“先生”,“m”,“地铁”。 |
- Inherited From:
- Source:
Returns:
true if the specified control is visible, false otherwise
- Type
- Boolean
isEmpty() → {Boolean}
Returns true if collection contains no objects
如果集合不包含对象,则返回true
- Mixes In:
- Source:
Returns:
true if collection is empty
- Type
- Boolean
isOnACache() → {Boolean}
Check if this group or its parent group are caching, recursively up
检查这个组或它的父组是否正在缓存,递归向上
- Source:
Returns:
- Type
- Boolean
isOnScreen(calculateopt) → {Boolean}
Checks if object is contained within the canvas with current viewportTransform
the check is done stopping at first point that appears on screen
使用当前viewportTransform检查对象是否包含在画布中
检查在屏幕上出现的第一个点停止
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .aCoords使用当前位置的坐标而不是。acoords |
- Inherited From:
- Source:
Returns:
true if object is fully or partially contained within canvas
- Type
- Boolean
isPartiallyOnScreen(calculateopt) → {Boolean}
Checks if object is partially contained within the canvas with current viewportTransform
使用当前viewportTransform检查对象是否部分包含在画布中
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
calculate |
Boolean |
<optional> |
use coordinates of current position instead of .oCoords使用当前位置的坐标而不是。ocoordinates |
- Inherited From:
- Source:
Returns:
true if object is partially contained within canvas
- Type
- Boolean
isType(type) → {Boolean}
Returns true if specified type is identical to the type of an instance
如果指定的类型与实例的类型相同,则返回true
Parameters:
Name | Type | Description |
---|---|---|
type |
String | Type to check against键入以进行检查 |
- Inherited From:
- Source:
Returns:
- Type
- Boolean
item(index) → {Self}
Returns object at specified index
返回指定索引处的对象
Parameters:
Name | Type | Description |
---|---|---|
index |
Number | 组织类 |
- Mixes In:
- Source:
Returns:
thisArg
- Type
- Self
moveTo(index) → {fabric.Object}
Moves an object to specified level in stack of drawn objects
将对象移动到绘制对象堆栈中的指定级别
Parameters:
Name | Type | Description |
---|---|---|
index |
Number | New position of object物体的新位置 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
needsItsOwnCache()
When set to `true`, force the object to have its own cache, even if it is inside a group
it may be needed when your object behave in a particular way on the cache and always needs
its own isolated canvas to render correctly.
Created to be overridden
since 1.7.12
当设置为' true '时,强制对象拥有自己的缓存,即使它在组中
当你的对象在缓存上以一种特定的方式运行时,可能需要它,并且总是需要它
它自己的独立画布来正确渲染。
创建以被覆盖
自从1.7.12
- Inherited From:
- Source:
Returns:
Boolean
onDeselect(optionsopt)
This callback function is called every time _discardActiveObject or _setActiveObject
try to to deselect this object. If the function returns true, the process is cancelled
这个回调函数在每次_discardActiveObject或_setActiveObject时被调用
尝试取消选择此对象。如果函数返回true,则取消进程
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
options sent from the upper functions
Properties
|
- Inherited From:
- Source:
onSelect(optionsopt)
This callback function is called every time _discardActiveObject or _setActiveObject
try to to select this object. If the function returns true, the process is cancelled
这个回调函数在每次_discardActiveObject或_setActiveObject时被调用
尝试选择此对象。如果函数返回true,则取消进程
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
options sent from the upper functions
Properties
|
- Inherited From:
- Source:
remove(…object) → {Self}
Removes objects from a collection, then renders canvas (if `renderOnAddRemove` is not `false`)
从集合中移除对象,然后渲染画布(如果' renderOnAddRemove '不是' false ')
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
object |
fabric.Object |
<repeatable> |
Zero or more fabric instances0个或多个结构实例 |
- Mixes In:
- Source:
Returns:
thisArg
- Type
- Self
removeWithUpdate(object) → {fabric.Group}
Removes an object from a group; Then recalculates group's dimension, position.
从组中删除对象;然后重新计算组的尺寸,位置。
Parameters:
Name | Type | Description |
---|---|---|
object |
Object | 组织类 |
- Source:
Returns:
thisArg
- Type
- fabric.Group
render(ctx)
Renders instance on a given context
在给定的上下文中呈现实例
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | context to render instance on上下文来渲染实例 |
- Overrides:
- Source:
rotate(angle) → {fabric.Object}
Sets "angle" of an instance with centered rotation
设置实例的“角度”,以居中旋转
Parameters:
Name | Type | Description |
---|---|---|
angle |
Number | Angle value (in degrees)角度值(以度为单位) |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
saveState(optionsopt) → {fabric.Object}
Saves state of an object
保存对象的状态
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Object |
<optional> |
Object with additional `stateProperties` array to include when saving state对象,该对象具有在保存状态时要包含的附加' stateProperties '数组 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
scale(value) → {fabric.Object}
Scales an object (equally by x and y)
缩放对象(x和y相等)
Parameters:
Name | Type | Description |
---|---|---|
value |
Number | Scale factor比例因子 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
scaleToHeight(value, absolute) → {fabric.Object}
Scales an object to a given height, with respect to bounding box (scaling by x/y equally)
根据边界框将对象缩放到给定的高度(相等地按x/y缩放)
Parameters:
Name | Type | Description |
---|---|---|
value |
Number | New height value新的高度值 |
absolute |
Boolean | ignore viewport忽略视窗 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
scaleToWidth(value, absolute) → {fabric.Object}
Scales an object to a given width, with respect to bounding box (scaling by x/y equally)
根据边框将对象缩放到给定的宽度(相等地按x/y缩放)
Parameters:
Name | Type | Description |
---|---|---|
value |
Number | New width value新的宽度值 |
absolute |
Boolean | ignore viewport忽略视窗 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
sendBackwards(intersectingopt) → {fabric.Object}
Moves an object down in stack of drawn objects
在绘制对象的堆栈中向下移动对象
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
intersecting |
Boolean |
<optional> |
If `true`, send object behind next lower intersecting object如果' true ',则将对象发送到下一个相交对象的后面 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
sendToBack() → {fabric.Object}
Moves an object to the bottom of the stack of drawn objects
将对象移动到绘制对象堆栈的底部
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
setControlsVisibility(optionsopt) → {fabric.Object}
Sets the visibility state of object controls.
设置对象控件的可见性状态。
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
Options object
Properties
|
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
setControlVisible(controlKey, visible) → {fabric.Object}
Sets the visibility of the specified control.
设置指定控件的可见性。
Parameters:
Name | Type | Description |
---|---|---|
controlKey |
String | The key of the control. Possible values are 'tl', 'tr', 'br', 'bl', 'ml', 'mt', 'mr', 'mb', 'mtr'.控制键。可能的值是“tl”,“tr”,“品牌”,“提单”、“毫升”、“太”,“先生”,“m”,“地铁”。 |
visible |
Boolean | true to set the specified control visible, false otherwise设置指定的控件为True,否则为false |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
setCoords(skipCornersopt) → {fabric.Object}
Sets corner and controls position coordinates based on current angle, width and height, left and top.
oCoords are used to find the corners
aCoords are used to quickly find an object on the canvas
lineCoords are used to quickly find object during pointer events.
See https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords and http://fabricjs.com/fabric-gotchas
设置角并基于当前角度、宽度和高度、左侧和顶部控制位置坐标。
oCoords是用来找到角落的
aCoords用于在画布上快速查找对象
lineCoords用于在指针事件期间快速查找对象。
参见https://github.com/fabricjs/fabric.js/wiki/When-to-call-setCoords和http://fabricjs.com/fabric-gotchas
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
skipCorners |
Boolean |
<optional> |
skip calculation of oCoords.跳过oCoords的计算。 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
setObjectsCoords() → {fabric.Group}
Sets coordinates of all objects inside group
设置组内所有对象的坐标
- Source:
Returns:
thisArg
- Type
- fabric.Group
setOnGroup()
This callback function is called by the parent group of an object every
time a non-delegated property changes on the group. It is passed the key
and value as parameters. Not adding in this function's signature to avoid
Travis build error about unused variables.
这个回调函数由对象的父组调用
更改组上的非委托属性的时间。它被传递了密钥
值作为参数。没有添加此函数的签名以避免
关于未使用变量的Travis构建错误。
- Inherited From:
- Source:
setOptions(optionsopt)
Sets object's properties from options
从选项设置对象的属性
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Object |
<optional> |
Options object选择对象 |
- Inherited From:
- Source:
setPositionByOrigin(pos, originX, originY) → {void}
Sets the position of the object taking into consideration the object's origin
考虑到对象的原点,设置对象的位置
Parameters:
Name | Type | Description |
---|---|---|
pos |
fabric.Point | The new position of the object对象的新位置 |
originX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
originY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
- Inherited From:
- Source:
Returns:
- Type
- void
setupState(optionsopt) → {fabric.Object}
Setups state of an object
设置对象的状态
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
options |
Object |
<optional> |
Object with additional `stateProperties` array to include when saving state对象,该对象具有在保存状态时要包含的附加' stateProperties '数组 |
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
shouldCache() → {Boolean}
Decide if the object should cache or not. Create its own cache level
needsItsOwnCache should be used when the object drawing method requires
a cache step. None of the fabric classes requires it.
Generally you do not cache objects in groups because the group is already cached.
决定对象是否应该缓存。创建自己的缓存级别
当对象绘图方法需要时,应该使用needsitsonncache
缓存的一步。没有任何fabric类需要它。
通常不按组缓存对象,因为组已经被缓存了。
- Overrides:
- Source:
Returns:
- Type
- Boolean
size() → {Number}
Returns a size of a collection (i.e: length of an array containing its objects)
返回集合的大小(即包含其对象的数组的长度)
- Mixes In:
- Source:
Returns:
Collection size
- Type
- Number
straighten() → {fabric.Object}
Straightens an object (rotating it from current angle to one of 0, 90, 180, 270, etc. depending on which is closer)
将对象拉直(将其从当前角度旋转到0、90、180、270等,取决于哪个更接近)
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
toActiveSelection() → {fabric.ActiveSelection}
make a group an active selection, remove the group from canvas
the group has to be on canvas for this to work.
使一个组成为一个活动选择,从画布中删除该组
团队必须在画布上才能成功。
- Source:
Returns:
thisArg
toCanvasElement(options) → {HTMLCanvasElement}
Converts an object into a HTMLCanvas element
将对象转换为HTMLCanvas元素
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Options object
Properties
|
- Inherited From:
- Source:
Returns:
Returns DOM element
- Type
- HTMLCanvasElement
toClipPathSVG(reviveropt) → {String}
Returns svg clipPath representation of an instance
返回实例的svg clipPath表示
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reviver |
function |
<optional> |
Method for further parsing of svg representation.方法用于进一步解析svg表示。 |
- Overrides:
- Source:
Returns:
svg representation of an instance
- Type
- String
toDatalessObject(propertiesToIncludeopt) → {Object}
Returns object representation of an instance, in dataless mode.
以无数据模式返回实例的对象表示。
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
propertiesToInclude |
Array |
<optional> |
Any properties that you might want to additionally include in the output您可能希望在输出中额外包含的任何属性 |
- Overrides:
- Source:
Returns:
object representation of an instance
- Type
- Object
toDataURL(options) → {String}
Converts an object into a data-url-like string
将对象转换为类似于数据url的字符串
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Options object
Properties
|
- Inherited From:
- Source:
Returns:
Returns a data: URL containing a representation of the object in the format specified by options.format
- Type
- String
toJSON(propertiesToIncludeopt) → {Object}
Returns a JSON representation of an instance
返回实例的JSON表示形式
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
propertiesToInclude |
Array |
<optional> |
Any properties that you might want to additionally include in the output您可能希望在输出中额外包含的任何属性 |
- Inherited From:
- Source:
Returns:
JSON
- Type
- Object
toLocalPoint(point, originX, originY) → {fabric.Point}
Returns the point in local coordinates
返回局部坐标中的点
Parameters:
Name | Type | Description |
---|---|---|
point |
fabric.Point | The point relative to the global coordinate system相对于全局坐标系的点 |
originX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
originY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
- Inherited From:
- Source:
Returns:
- Type
- fabric.Point
toObject(propertiesToIncludeopt) → {Object}
Returns object representation of an instance
返回实例的对象表示
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
propertiesToInclude |
Array |
<optional> |
Any properties that you might want to additionally include in the output您可能希望在输出中额外包含的任何属性 |
- Overrides:
- Source:
Returns:
object representation of an instance
- Type
- Object
toString() → {String}
Returns string represenation of a group
返回组的字符串表示形式
- Overrides:
- Source:
Returns:
- Type
- String
toSVG(reviveropt) → {String}
Returns svg representation of an instance
返回实例的svg表示
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
reviver |
function |
<optional> |
Method for further parsing of svg representation.方法用于进一步解析svg表示。 |
- Inherited From:
- Source:
Returns:
svg representation of an instance
- Type
- String
transform(ctx)
Transforms context when rendering an object
在呈现对象时转换上下文
Parameters:
Name | Type | Description |
---|---|---|
ctx |
CanvasRenderingContext2D | Context上下文 |
- Inherited From:
- Source:
translateToCenterPoint(point, originX, originY) → {fabric.Point}
Translates the coordinates from origin to center coordinates (based on the object's dimensions)
将坐标从原点坐标转换为中心坐标(基于对象的尺寸)
Parameters:
Name | Type | Description |
---|---|---|
point |
fabric.Point | The point which corresponds to the originX and originY params与originX和originY参数对应的点 |
originX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
originY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
- Inherited From:
- Source:
Returns:
- Type
- fabric.Point
translateToGivenOrigin(point, fromOriginX, fromOriginY, toOriginX, toOriginY) → {fabric.Point}
Translates the coordinates from a set of origin to another (based on the object's dimensions)
将坐标从一组原点转换为另一组原点(基于对象的维度)
Parameters:
Name | Type | Description |
---|---|---|
point |
fabric.Point | The point which corresponds to the originX and originY params与originX和originY参数对应的点 |
fromOriginX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
fromOriginY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
toOriginX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
toOriginY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
- Inherited From:
- Source:
Returns:
- Type
- fabric.Point
translateToOriginPoint(center, originX, originY) → {fabric.Point}
Translates the coordinates from center to origin coordinates (based on the object's dimensions)
将坐标从中心坐标转换为原点坐标(基于对象的尺寸)
Parameters:
Name | Type | Description |
---|---|---|
center |
fabric.Point | The point which corresponds to center of the object与物体中心相对应的点 |
originX |
String | Horizontal origin: 'left', 'center' or 'right'水平原点:“左”、“中”或“右” |
originY |
String | Vertical origin: 'top', 'center' or 'bottom'垂直原点:“顶部”、“中心”或“底部” |
- Inherited From:
- Source:
Returns:
- Type
- fabric.Point
ungroupOnCanvas() → {fabric.Group}
Destroys a group (restoring state of its objects)
销毁一个组(恢复其对象的状态)
- Source:
Returns:
thisArg
- Type
- fabric.Group
viewportCenter() → {fabric.Object}
Centers object on current viewport of canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
将对象集中在它最后添加到的画布的当前视图中。
你可能需要在定心后对对象调用setCoords来更新控件区域。
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
viewportCenterH() → {fabric.Object}
Centers object horizontally on current viewport of canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
将对象水平地居中于它最后添加到的画布的当前视图中。
你可能需要在定心后对对象调用setCoords来更新控件区域。
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
viewportCenterV() → {fabric.Object}
Centers object vertically on current viewport of canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
将对象垂直集中在它最后添加到的画布的当前视图中。
你可能需要在定心后对对象调用setCoords来更新控件区域。
- Inherited From:
- Source:
Returns:
thisArg
- Type
- fabric.Object
willDrawShadow() → {Boolean}
Check if this object or a child object will cast a shadow
检查此对象或子对象是否会投下阴影
- Overrides:
- Source:
Returns:
- Type
- Boolean