IItemLayout
Defined in: core/items/ilayout.ts:7
Methods
Section titled “Methods”bringForward()
Section titled “bringForward()”bringForward():
Promise<IItemLayout>
Defined in: core/items/ilayout.ts:446
return: Promise
Move item one level up in the z-index (to the front)
Chainable.
item.bringForward().then(function(item) { // Promise resolves with same Item instance});Returns
Section titled “Returns”Promise<IItemLayout>
bringToFront()
Section titled “bringToFront()”bringToFront():
Promise<IItemLayout>
Defined in: core/items/ilayout.ts:480
return: Promise
Move item to highest level in the z-index (to the absolute front)
Chainable.
item.bringToFront().then(function(item) { // Promise resolves with same Item instance});Returns
Section titled “Returns”Promise<IItemLayout>
getCanvasRotate()
Section titled “getCanvasRotate()”getCanvasRotate():
Promise<number>
Defined in: core/items/ilayout.ts:336
return: Promise
Get canvas rotation of the item
item.getCanvasRotate().then(function(deg) { // The rest of your code here});Returns
Section titled “Returns”Promise<number>
getCropping()
Section titled “getCropping()”getCropping():
Promise<Object>
Defined in: core/items/ilayout.ts:286
return: Promise
Get the cropping of the item
This returns an object with properties of left, top, right, and bottom whose values are between 0 - 1. This object is not a coordinate system. Top value indicates the portion of the item removed(cropped) from the top, left value indicates the portion of the item removed from the left, and so on.
item.getCropping().then(function(crop) { // The rest of your code here var left = crop.left; var top = crop.top; var right = crop.right; var bottom = crop.bottom;});Returns
Section titled “Returns”Promise<Object>
getEnhancedRotate()
Section titled “getEnhancedRotate()”getEnhancedRotate():
Promise<number>
Defined in: core/items/ilayout.ts:372
return: Promise
Get the z-rotation value as can be seen in the item properties window. This value takes into account rotateZ along with canvas rotation.
item.getEnhancedRotate().then(function(deg) { // The rest of your code here});Returns
Section titled “Returns”Promise<number>
getPosition()
Section titled “getPosition()”getPosition(
output?):Promise<Rectangle>
Defined in: core/items/ilayout.ts:128
return: Promise
Get the position of the item
See also: #util/Rectangle Util/Rectangle
item.getPosition().then(function(pos) { // The rest of your code here});Parameters
Section titled “Parameters”output?
Section titled “output?”number
Returns
Section titled “Returns”Promise<Rectangle>
getRotateX()
Section titled “getRotateX()”getRotateX():
Promise<number>
Defined in: core/items/ilayout.ts:198
return: Promise
Get Rotate X value of the item
item.getRotateX().then(function(deg) { // The rest of your code here});Returns
Section titled “Returns”Promise<number>
getRotateY()
Section titled “getRotateY()”getRotateY():
Promise<number>
Defined in: core/items/ilayout.ts:163
return: Promise
Get Rotate Y value of the item
item.getRotateY().then(function(deg) { // The rest of your code here});Returns
Section titled “Returns”Promise<number>
getRotateZ()
Section titled “getRotateZ()”getRotateZ():
Promise<number>
Defined in: core/items/ilayout.ts:233
return: Promise
Get Rotate Z value of the item.
item.getRotateX().then(function(deg) { // The rest of your code here});Returns
Section titled “Returns”Promise<number>
isEnhancedResizeEnabled()
Section titled “isEnhancedResizeEnabled()”isEnhancedResizeEnabled():
Promise<boolean>
Defined in: core/items/ilayout.ts:91
return: Promise
Check if Enhance Resize is Enabled or Disabled
item.isEnhancedResizeEnabled().then(function(bool) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
isKeepAspectRatio()
Section titled “isKeepAspectRatio()”isKeepAspectRatio():
Promise<boolean>
Defined in: core/items/ilayout.ts:21
return: Promise
Check if Aspect Ratio is set to ON or OFF
item.isKeepAspectRatio().then(function(bool) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
isPositionLocked()
Section titled “isPositionLocked()”isPositionLocked():
Promise<boolean>
Defined in: core/items/ilayout.ts:56
return: Promise
Check if Position Locked is set to ON or OFF
item.isPositionLocked().then(function(bool) { // The rest of your code here});Returns
Section titled “Returns”Promise<boolean>
sendBackward()
Section titled “sendBackward()”sendBackward():
Promise<IItemLayout>
Defined in: core/items/ilayout.ts:463
return: Promise
Move item one level down in the z-index (to the back)
Chainable.
item.sendBackward().then(function(item) { // Promise resolves with same Item instance});Returns
Section titled “Returns”Promise<IItemLayout>
sendToBack()
Section titled “sendToBack()”sendToBack():
Promise<IItemLayout>
Defined in: core/items/ilayout.ts:497
return: Promise
Move item to lowest level in the z-index (to the absolute back)
Chainable.
item.sendToBack().then(function(item) { // Promise resolves with same Item instance});Returns
Section titled “Returns”Promise<IItemLayout>
setCanvasRotate()
Section titled “setCanvasRotate()”setCanvasRotate(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:356
param: (value: number)
return: Promise<Item>Set canvas rotation of the item (possible values - 0, 90, 180, 270)
Chainable.
item.setCanvasRotate(90).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemLayout>
setCropping()
Section titled “setCropping()”setCropping(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:321
param: (value: Object)
Set Item cropping.
This accepts an object with properties left, top, right, and bottom whose values are between 0 - 1. This object is not a coordinate system. Top value indicates the portion of the item removed(cropped) from the top, left value indicates the portion of the item removed from the left, and so on.
Chainable.
Please do note that this method will NOT automatically modify/calculate the height and width of the item whenever you modify cropping, unlike the behavior of XBC when modifying it through the properties window.
You will need to manually modify the height and width of the item each time you modify this value to get the best results. If not, it might result to the stretching and/or shrinking of the item.
var obj = {};obj.left = 0.1;obj.top = 0.2;obj.right = 0;obj.bottom = 0.1;item.setCropping(obj).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”Object
Returns
Section titled “Returns”Promise<IItemLayout>
setCroppingEnhanced()
Section titled “setCroppingEnhanced()”setCroppingEnhanced(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:429
param: (value: Object)
Set item cropping while automatically calculating and modifying width and height to account for the cropped value.
This accepts an object with properties left, top, right, and bottom whose values are between 0 - 1. This object is not a coordinate system. Top value indicates the portion of the item removed(cropped) from the top, left value indicates the portion of the item removed from the left, and so on.
Chainable.
This behaves the same as in the item properties window and is done to prevent item stretching.
var obj = {};obj.left = 0.1;obj.top = 0.2;obj.right = 0;obj.bottom = 0.1;item.setCroppingEnhanced(obj).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”Object
Returns
Section titled “Returns”Promise<IItemLayout>
setEnhancedResizeEnabled()
Section titled “setEnhancedResizeEnabled()”setEnhancedResizeEnabled(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:111
param: (value: boolean)
return: Promise<Item>Set Enhance Resize to ON or OFF
Chainable.
item.setEnhancedResizeEnabled(true).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<IItemLayout>
setEnhancedRotate()
Section titled “setEnhancedRotate()”setEnhancedRotate(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:397
param: (value: number)
return: Promise<Item>Set Rotate Z value of the item, also taking into account canvas rotation.
Chainable.
This method automatically modifies/calculates the height and width of the item whenever you modify the z-rotation value, changing its orientation (vertical / horizontal) at certain angles. This behavior is what is exhibited in the item properties window.
item.setEnhancedRotate(30).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemLayout>
setKeepAspectRatio()
Section titled “setKeepAspectRatio()”setKeepAspectRatio(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:41
param: (value: boolean)
return: Promise<Item>Set Aspect Ratio to ON or OFF
Chainable.
item.setKeepAspectRatio(true).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<IItemLayout>
setPosition()
Section titled “setPosition()”setPosition(
value,output?):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:148
param: (value: Rectangle, output: number = 0)
Set Item Position. Relative coordinates (0-1) are required.
Chainable.
var rect = xjs.Rectangle.fromCoordinates(0, 0, 1, 1);item.setPosition(rect).then(function(item) { // Promise resolves with same Item instance});See also: #util/Rectangle Util/Rectangle
Parameters
Section titled “Parameters”output?
Section titled “output?”number
Returns
Section titled “Returns”Promise<IItemLayout>
setPositionLocked()
Section titled “setPositionLocked()”setPositionLocked(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:76
param: (value: boolean)
return: Promise<Item>Set Position Lock to ON or OFF
Chainable.
item.setPositionLocked(true).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<IItemLayout>
setRotateX()
Section titled “setRotateX()”setRotateX(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:218
param: (value: number)
return: Promise<Item>Set Rotate X value of the item
Chainable.
item.setRotateX(30).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemLayout>
setRotateY()
Section titled “setRotateY()”setRotateY(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:183
param: (value: number)
return: Promise<Item>Set Rotate Y value of the item
Chainable.
item.setRotateY(30).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemLayout>
setRotateZ()
Section titled “setRotateZ()”setRotateZ(
value):Promise<IItemLayout>
Defined in: core/items/ilayout.ts:261
param: (value: number)
return: Promise<Item>Set Rotate Z value of the item.
Chainable.
Please do note that this method will NOT automatically modify/calculate the height and width of the item whenever you modify the rotate Z value, unlike the behavior of XBC when modifying it through the properties window.
You will need to manually modify the height and width of the item each time you modify this value to get the best results. If not, it might result to the stretching and/or shrinking of the item.
item.setRotateZ(30).then(function(item) { // Promise resolves with same Item instance});Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemLayout>