Class FrameController

The FrameController is responsible for all communication regarding Frames. Methods inside this controller can be called by window.SDK.frame.{method-name}

Hierarchy

FrameController

Index

Methods

applyCropMode create createBarcodeFrame createShapeFrame duplicateFrames enterCropMode exitCropMode getAll getAllByPageId getAllLayoutProperties getById getByName getLayoutProperties getPropertiesOnSelectedLayout getSelected remove removeFrames removeImageSource rename reorderFrames reset resetCropMode resetEnableCopyfitting resetHeight resetImageFrameFitMode resetMaxCopyfitting resetMinCopyfitting resetRotation resetSize resetWidth resetX resetY select selectMultiple setBlendMode setEnableCopyfitting setFrameConstrainProportions setHeight setImageFrameFitMode setImageFromConnector setImageFromUrl setIsVisible setMaxCopyfitting setMinCopyfitting setRotation setShapeFrameEnableFill setShapeFrameEnableStroke setShapeFrameFillColor setShapeFrameStrokeColor setShapeFrameStrokeWeight setVerticalAlign setVisibility setWidth setX setY setZIndex

Methods

applyCropMode

applyCropMode(): Promise<EditorResponse<null>>
This method will exit cropping mode while saving the applied crop.

Returns

Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:631

create

create(type: FrameTypeEnum, x: number, y: number, width: number, height: number): Promise<EditorResponse<string>>
This method will create a new frame of 'type' to the template positioned on the requested coordinates.

Returns
the newly created frame's id
Parameters
- type: FrameTypeEnum
  
  the type of frame to create
- x: number
  
  X coordinate of the new frame within the template
- y: number
  
  Y coordinate of the new frame within the template
- width: number
  
  Width of the new frame within the template
- height: number
  
  Height of the new frame within the template
Returns Promise<EditorResponse<string>>
- Defined in controllers/FrameController.ts:367

createBarcodeFrame

createBarcodeFrame(type: BarcodeType, position?: { x?: number; y?: number }): Promise<EditorResponse<string>>
Experimental
This method will create a new barcode frame of 'type' type to the layout positioned on the requested coordinates. Any coordinate that is not specified will default to 'center'.

Returns
Parameters
- type: BarcodeType
  
  the type of barcode to create
- Optional position: { x?: number; y?: number }
  
  optional position object where you can specify the x, y of the barcode frame
  - Optional x?: number
  - Optional y?: number
Returns Promise<EditorResponse<string>>
- Defined in controllers/FrameController.ts:394

createShapeFrame

createShapeFrame(type: ShapeType, x: number, y: number, width: number, height: number): Promise<EditorResponse<string>>
This method will create a new frame of 'type' type to the template positioned on the requested coordinates.

Returns
the newly created shape frame's id
Parameters
- type: ShapeType
  
  the type of frame to create
- x: number
  
  X coordinate of the new frame within the template
- y: number
  
  Y coordinate of the new frame within the template
- width: number
  
  Width of the new frame within the template
- height: number
  
  Height of the new frame within the template
Returns Promise<EditorResponse<string>>
- Defined in controllers/FrameController.ts:382

duplicateFrames

duplicateFrames(ids: string[]): Promise<EditorResponse<string>>
This method will duplicate a list of frames

Returns
Parameters
- ids: string[]
  
  An array of all ids you want to duplicate
Returns Promise<EditorResponse<string>>
- Defined in controllers/FrameController.ts:404

enterCropMode

enterCropMode(id: string): Promise<EditorResponse<null>>
This method will make the specified image frame go into cropping mode.

Returns
Parameters
- id: string
  
  the id of a specific image frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:622

exitCropMode

exitCropMode(): Promise<EditorResponse<null>>
This method will exit cropping mode without saving the applied crop.

Returns

Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:650

getAll

getAll(): Promise<EditorResponse<FrameType[]>>
This method returns the list of frames

Returns
list of all frames

Returns Promise<EditorResponse<FrameType[]>>
- Defined in controllers/FrameController.ts:48

getAllByPageId

getAllByPageId(id: string): Promise<EditorResponse<FrameType[]>>
This method returns the list of frames by id

Returns
list of all frames by id
Parameters
- id: string
  
  the id of a specific page
Returns Promise<EditorResponse<FrameType[]>>
- Defined in controllers/FrameController.ts:67

getAllLayoutProperties

getAllLayoutProperties(id: string): Promise<EditorResponse<FrameLayoutType[]>>
This method returns a list of frame properties for a given layout

Returns
list of frame layout properties
Parameters
- id: string
  
  the id of a specific layout
Returns Promise<EditorResponse<FrameLayoutType[]>>
- Defined in controllers/FrameController.ts:121

getById

getById(id: string): Promise<EditorResponse<FrameType>>
This method returns a frame by its id

Returns
frame properties
Parameters
- id: string
  
  the id of a specific frame
Returns Promise<EditorResponse<FrameType>>
- Defined in controllers/FrameController.ts:87

getByName

getByName(name: string): Promise<EditorResponse<FrameType>>
This method returns a frame by its name

Returns
frame properties
Parameters
- name: string
  
  the name of a specific frame
Returns Promise<EditorResponse<FrameType>>
- Defined in controllers/FrameController.ts:77

getLayoutProperties

getLayoutProperties(id: string, layoutId?: string): Promise<EditorResponse<FrameLayoutType>>
This method returns frame layout properties for a given frame and layout

Returns
frame layout properties
Parameters
- id: string
  
  the id of a specific frame
- Optional layoutId: string
  
  the id of a specific layout
Returns Promise<EditorResponse<FrameLayoutType>>
- Defined in controllers/FrameController.ts:109

getPropertiesOnSelectedLayout

getPropertiesOnSelectedLayout(): Promise<EditorResponse<FrameLayoutType[]>>
This method returns all frame properties on current layout

Returns
all frame properties on current layout

Returns Promise<EditorResponse<FrameLayoutType[]>>
- Defined in controllers/FrameController.ts:96

getSelected

getSelected(): Promise<EditorResponse<FrameType[]>>
This method returns the list of selected frames

Returns
list of all selected frames

Returns Promise<EditorResponse<FrameType[]>>
- Defined in controllers/FrameController.ts:57

remove

remove(id: string): Promise<EditorResponse<null>>
This method will remove a specific frame using the Id.

Returns
Parameters
- id: string
  
  the id of the frame that needs to be deleted
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:342

removeFrames

removeFrames(ids: string[]): Promise<EditorResponse<null>>
This method will remove frames with the given ids.

Returns
Parameters
- ids: string[]
  
  an array of ids of the frames to be removed.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:352

removeImageSource

removeImageSource(imageFrameId: string): Promise<EditorResponse<null>>
This method removes the image source from the ImageFrame
Parameters
- imageFrameId: string
  
  the id of the imageFrame where an image needs to be removed from
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:425

rename

rename(id: string, name: string): Promise<EditorResponse<null>>
This method will update the name of a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- name: string
  
  the new name that the frame should receive
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:239

reorderFrames

reorderFrames(order: number, ids: string[]): Promise<EditorResponse<null>>
This method changes the order of frames in the z-index list.

Returns
Parameters
- order: number
  
  the index in the list to move to
- ids: string[]
  
  An array of all IDs you want to move to the given index
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:162

reset

reset(id: string): Promise<EditorResponse<null>>
This method will reset properties of a specific frame to their original values

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:249

resetCropMode

resetCropMode(id: string): Promise<EditorResponse<null>>
This method will reset the currently applied crop mode and apply the last selected fit mode again.

Returns
Parameters
- id: string
  
  the id of a specific image frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:641

resetEnableCopyfitting

resetEnableCopyfitting(id: string): Promise<EditorResponse<null>>
This method will reset the frame enableCopyfitting to the frame's original value

Returns
Parameters
- id: string
  
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:551

resetHeight

resetHeight(id: string): Promise<EditorResponse<null>>
This method will reset the height of a specific frame to its original value

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:298

resetImageFrameFitMode

resetImageFrameFitMode(id: string): Promise<EditorResponse<null>>
This method will reset the fitMode property of a specific frame to its original value

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:308

resetMaxCopyfitting

resetMaxCopyfitting(id: string): Promise<EditorResponse<null>>
This method will reset the frame maxCopyfitting to the frame's original value

Returns
Parameters
- id: string
  
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:541

resetMinCopyfitting

resetMinCopyfitting(id: string): Promise<EditorResponse<null>>
This method will reset the frame minCopyfitting to the frame's original value

Returns
Parameters
- id: string
  
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:531

resetRotation

resetRotation(id: string): Promise<EditorResponse<null>>
This method will reset the rotation value of a specific frame to its original value

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:278

resetSize

resetSize(id: string): Promise<EditorResponse<null>>
This method will reset the frame size (width and height) to the frame's original value

Returns
Parameters
- id: string
  
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:131

resetWidth

resetWidth(id: string): Promise<EditorResponse<null>>
This method will reset the width of a specific frame to its original value

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:288

resetX

resetX(id: string): Promise<EditorResponse<null>>
This method will reset the x value of a specific frame to its original value

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:258

resetY

resetY(id: string): Promise<EditorResponse<null>>
This method will reset the y value of a specific frame to its original value

Returns
Parameters
- id: string
  
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:268

select

select(id: string): Promise<EditorResponse<null>>
This method will select a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:141

selectMultiple

selectMultiple(ids: string[]): Promise<EditorResponse<null>>
This method will select multipleFrames

Returns
Parameters
- ids: string[]
  
  An array of all ids you want to select
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:151

setBlendMode

setBlendMode(id: string, blendMode: BlendMode): Promise<EditorResponse<null>>
This method will set the blend mode of a specified frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- blendMode: BlendMode
  
  the blend mode
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:612

setEnableCopyfitting

setEnableCopyfitting(id: string, value: boolean): Promise<EditorResponse<null>>
This method will enable copyFitting on a specified frame.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated
- value: boolean
  
  the new value to be set to the frame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:521

setFrameConstrainProportions

setFrameConstrainProportions(id: string, constrainProportions: boolean): Promise<EditorResponse<null>>
This method will set the constrainProportions property of a specified frame. If constrainProportionsReadOnly is true, the frame's constrainProportions property cannot be changed and this method will return an error.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated.
- constrainProportions: boolean
  
  The new constraint that you want to set to the frame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:475

setHeight

setHeight(id: string, height: string): Promise<EditorResponse<null>>
This method will set the height of a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- height: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:184

setImageFrameFitMode

setImageFrameFitMode(imageFrameId: string, fitMode: FitMode): Promise<EditorResponse<null>>
This method will set the fitMode property of a specified image frame.

Returns
Parameters
- imageFrameId: string
  
  the id of the imageFrame that needs to get updated.
- fitMode: FitMode
  
  the new fitMode that you want to set to the imageFrame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:463

setImageFromConnector

setImageFromConnector(imageFrameId: string, connectorId: string, assetId: string): Promise<EditorResponse<null>>
This method will assign an image from a mediaConnector to the correct ImageFrame

Returns
Parameters
- imageFrameId: string
  
  the id of the imageFrame where an image needs to be assigned to
- connectorId: string
- assetId: string
  
  Unique id of the asset that you want to assign to the imageFrame
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:436

setImageFromUrl

setImageFromUrl(imageFrameId: string, url: string): Promise<EditorResponse<null>>
This method will assign an image from url to the correct ImageFrame Make sure the url can be accessed by the editor.

Returns
Parameters
- imageFrameId: string
  
  the id of the imageFrame where an image needs to be assigned to
- url: string
  
  A valid image uri
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:452

setIsVisible

setIsVisible(id: string, value: boolean): Promise<EditorResponse<null>>
This method will set the isVisible property of a specified frame. If set to false the frame will be invisible and vice versa.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated
- value: boolean
  
  True means the frame gets visible, false means the frame gets invisible
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:332

setMaxCopyfitting

setMaxCopyfitting(id: string, value: string): Promise<EditorResponse<null>>
This method will set the max copyFitting property of a specified frame.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated
- value: string
  
  the new max copyFitting value to be set to the frame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:510

setMinCopyfitting

setMinCopyfitting(id: string, value: string): Promise<EditorResponse<null>>
This method will set the min copyFitting property of a specified frame.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated
- value: string
  
  the new min copyFitting value to be set to the frame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:499

setRotation

setRotation(id: string, rotation: string): Promise<EditorResponse<null>>
This method will set the rotation angle of a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- rotation: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:195

setShapeFrameEnableFill

setShapeFrameEnableFill(shapeFrameId: string, enableFill: boolean): Promise<EditorResponse<null>>
This method will set the visibility of the shape fill.

Returns
Parameters
- shapeFrameId: string
  
  the id of the shapeFrame that needs to get updated.
- enableFill: boolean
  
  Whether the shape fill is visible.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:562

setShapeFrameEnableStroke

setShapeFrameEnableStroke(shapeFrameId: string, enableStroke: boolean): Promise<EditorResponse<null>>
This method will set the visibility of the shape stroke.

Returns
Parameters
- shapeFrameId: string
  
  the id of the shapeFrame that needs to get updated.
- enableStroke: boolean
  
  Whether the shape stroke is visible.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:582

setShapeFrameFillColor

setShapeFrameFillColor(shapeFrameId: string, fillColor: ColorUsage): Promise<EditorResponse<null>>
This method will set the shape fill color of a specified shape frame.

Returns
Parameters
- shapeFrameId: string
  
  the id of the shapeFrame that needs to get updated.
- fillColor: ColorUsage
  
  the new shape fill color that you want to set to the shapeFrame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:572

setShapeFrameStrokeColor

setShapeFrameStrokeColor(shapeFrameId: string, strokeColor: ColorUsage): Promise<EditorResponse<null>>
This method will set the shape stroke color of a specified shape frame.

Returns
Parameters
- shapeFrameId: string
  
  the id of the shapeFrame that needs to get updated.
- strokeColor: ColorUsage
  
  the new shape stroke color that you want to set to the shapeFrame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:592

setShapeFrameStrokeWeight

setShapeFrameStrokeWeight(shapeFrameId: string, strokeWeight: number): Promise<EditorResponse<null>>
This method will set the shape stroke weight of a specified shape frame.

Returns
Parameters
- shapeFrameId: string
  
  the id of the shapeFrame that needs to get updated.
- strokeWeight: number
  
  the new shape stroke weight that you want to set to the shapeFrame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:602

setVerticalAlign

setVerticalAlign(id: string, verticalAlign: VerticalAlign): Promise<EditorResponse<null>>
This method will set the vertical alignment property of a specified frame.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated
- verticalAlign: VerticalAlign
  
  the new vertical alignment to be set to the frame.
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:488

setVisibility

setVisibility(id: string, value: boolean): Promise<EditorResponse<null>>
Deprecated
Use setIsVisible instead.

This method will set the visibility property of a specified frame. If set to false the frame will be invisible and vice versa.

Returns
Parameters
- id: string
  
  the id of the frame that needs to get updated
- value: boolean
  
  True means the frame gets visible, false means the frame gets invisible
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:321

setWidth

setWidth(id: string, width: string): Promise<EditorResponse<null>>
This method will set the width of a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- width: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:206

setX

setX(id: string, XValue: string): Promise<EditorResponse<null>>
This method will set the x value of a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- XValue: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:217

setY

setY(id: string, YValue: string): Promise<EditorResponse<null>>
This method will set the y value of a specific frame

Returns
Parameters
- id: string
  
  the id of a specific frame
- YValue: string
  
  the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:228

setZIndex

setZIndex(id: string, method: UpdateZIndexMethod): Promise<EditorResponse<null>>
This method will update the z-index of a frame.

Returns
Parameters
- id: string
  
  the id of the frame you want to change the z-index of
- method: UpdateZIndexMethod
  
  the z-index update method to perform
Returns Promise<EditorResponse<null>>
- Defined in controllers/FrameController.ts:173

Class FrameController

Hierarchy

Index

Methods

Methods

applyCropMode

Returns

Returns Promise<EditorResponse<null>>

create

Returns

Parameters

type: FrameTypeEnum

x: number

y: number

width: number

height: number

Returns Promise<EditorResponse<string>>

createBarcodeFrame

Returns

Parameters

type: BarcodeType

Optional position: { x?: number; y?: number }

Optional x?: number

Optional y?: number

Returns Promise<EditorResponse<string>>

createShapeFrame

Returns

Parameters

type: ShapeType

x: number

y: number

width: number

height: number

Returns Promise<EditorResponse<string>>

duplicateFrames

Returns

Parameters

ids: string[]

Returns Promise<EditorResponse<string>>

enterCropMode

Returns

Parameters

id: string

Returns Promise<EditorResponse<null>>

exitCropMode

Returns

Returns Promise<EditorResponse<null>>

getAll

Returns

Returns Promise<EditorResponse<FrameType[]>>

getAllByPageId

Returns

Parameters

id: string

Returns Promise<EditorResponse<FrameType[]>>

getAllLayoutProperties

Returns

Parameters

id: string

Returns Promise<EditorResponse<FrameLayoutType[]>>

getById

Returns

Parameters

id: string

Returns Promise<EditorResponse<FrameType>>

getByName

Returns

Parameters

name: string

Returns Promise<EditorResponse<FrameType>>

getLayoutProperties

Returns

Parameters

id: string

Optional layoutId: string

Returns Promise<EditorResponse<FrameLayoutType>>

getPropertiesOnSelectedLayout

Returns

Returns Promise<EditorResponse<FrameLayoutType[]>>

getSelected

`Optional` position: { x?: number; y?: number }

`Optional` x?: number

`Optional` y?: number

`Optional` layoutId: string