Class FrameController

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

Index

Methods

applyCropMode applyGradientMode applySubjectMode cancelGradientMode create createBarcodeFrame createShapeFrame deselectAll duplicateFrames enterCropMode enterGradientMode enterSubjectMode exitCropMode exitSubjectMode getAll getAllByPageId getAllLayoutProperties getById getByName getConfiguration getLayoutProperties getPropertiesOnSelectedLayout getSelected remove removeFrames removeImageSource rename reorderFrames reset resetAllAssetCropOverrides resetAnchoring resetAssetCropOverride resetAutoGrow resetAutoGrowDirections resetAutoGrowMaxHeight resetAutoGrowMaxWidth resetAutoGrowMinHeight resetAutoGrowMinWidth resetAutoGrowSettingsEnabled resetCropMode resetEnableCopyfitting resetHeight resetImageFrameFitMode resetMaxCopyfitting resetMinCopyfitting resetRotation resetSize resetTransformation resetVisibility resetWidth resetX resetY select selectMultiple setAutoGrowDirections setAutoGrowMaxHeight setAutoGrowMaxWidth setAutoGrowMinHeight setAutoGrowMinWidth setBlendMode setBrandKitGradient setEnableAutoGrow setEnableCopyfitting setFrameConstrainProportions setGradientApplied setHeight setHorizontalAnchor setImageFrameFitMode setImageFrameFitModePosition setImageFromConnector setImageFromUrl setIsVisible setLocalGradient setMaxCopyfitting setMinCopyfitting setRotation setShadowAngleDegrees setShadowBlurRadius setShadowColor setShadowDistance setShadowEnabled setShapeFrameEnableFill setShapeFrameEnableStroke setShapeFrameFillColor setShapeFrameStrokeColor setShapeFrameStrokeWeight setVerticalAlign setVerticalAnchor setVisibility setWidth setX setY setZIndex

Methods

applyCropMode

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

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:697

applyGradientMode

applyGradientMode(): Promise<EditorResponse<null>>
This method will exit gradient mode while saving the applied gradient.

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:753

applySubjectMode

applySubjectMode(): Promise<EditorResponse<null>>
This method will exit subject mode while saving the applied subject area.

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:725

cancelGradientMode

cancelGradientMode(): Promise<EditorResponse<null>>
This method will exit gradient mode without saving the applied gradient.

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:762

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.
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>>
the newly created frame's id
- Defined in sdk/src/controllers/FrameController.ts:409

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'.
Parameters
- type: BarcodeType
  the type of barcode to create
- Optionalposition: { x?: number; y?: number }
  optional position object where you can specify the x, y of the barcode frame
Returns Promise<EditorResponse<string>>
- Defined in sdk/src/controllers/FrameController.ts:436

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.
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>>
the newly created shape frame's id
- Defined in sdk/src/controllers/FrameController.ts:424

deselectAll

deselectAll(): Promise<EditorResponse<null>>
This method will deselect all frames

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:183

duplicateFrames

duplicateFrames(ids: string[]): Promise<EditorResponse<string>>
This method will duplicate a list of frames
Parameters
- ids: string[]
  An array of all ids you want to duplicate
Returns Promise<EditorResponse<string>>
- Defined in sdk/src/controllers/FrameController.ts:446

enterCropMode

enterCropMode(id: string, type?: CropType): Promise<EditorResponse<null>>
This method will make the specified image frame go into cropping mode.
Parameters
- id: string
  the id of a specific image frame
- type: CropType = CropType.frameCrop
  the type of cropping mode to enter. Defaults to frameCrop.
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:688

enterGradientMode

enterGradientMode(id: string): Promise<EditorResponse<null>>
This method will make the specified shape frame go into gradient mode.
Parameters
- id: string
  the id of a specific shape frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:744

enterSubjectMode

enterSubjectMode(id: string): Promise<EditorResponse<null>>
This method will make the specified image frame go into subject mode.
Parameters
- id: string
  the id of a specific image frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:716

exitCropMode

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

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:706

exitSubjectMode

exitSubjectMode(): Promise<EditorResponse<null>>
This method will exit subject mode without saving the applied subject area.

Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:734

getAll

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

Returns Promise<EditorResponse<FrameType[]>>
list of all frames
- Defined in sdk/src/controllers/FrameController.ts:58

getAllByPageId

getAllByPageId(id: string): Promise<EditorResponse<FrameType[]>>
This method returns the list of frames by id
Parameters
- id: string
  the id of a specific page
Returns Promise<EditorResponse<FrameType[]>>
list of all frames by id
- Defined in sdk/src/controllers/FrameController.ts:77

getAllLayoutProperties

getAllLayoutProperties(id: string): Promise<EditorResponse<FrameLayoutType[]>>
This method returns a list of frame properties for a given layout
Parameters
- id: string
  the id of a specific layout
Returns Promise<EditorResponse<FrameLayoutType[]>>
list of frame layout properties
- Defined in sdk/src/controllers/FrameController.ts:131

getById

getById(id: string): Promise<EditorResponse<FrameType>>
This method returns a frame by its id
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<FrameType>>
frame properties
- Defined in sdk/src/controllers/FrameController.ts:97

getByName

getByName(name: string): Promise<EditorResponse<FrameType>>
This method returns a frame by its name
Parameters
- name: string
  the name of a specific frame
Returns Promise<EditorResponse<FrameType>>
frame properties
- Defined in sdk/src/controllers/FrameController.ts:87

getConfiguration

getConfiguration(id: string): Promise<EditorResponse<FrameConfiguration>>
This method will get the frame configuration for a specified frame.

A frame configuration is a set of rules that define what is allowed to do with a given behavior of a frame.

e.g. list of allowed frame targets for a specific anchor
Parameters
- id: string
  the id of the frame to get the frame configuration for
Returns Promise<EditorResponse<FrameConfiguration>>
the frame's configuration
- Defined in sdk/src/controllers/FrameController.ts:1146

getLayoutProperties

getLayoutProperties(
id: string,
layoutId?: string,
): Promise<EditorResponse<FrameLayoutType>>
This method returns frame layout properties for a given frame and layout
Parameters
- id: string
  the id of a specific frame
- OptionallayoutId: string
  the id of a specific layout
Returns Promise<EditorResponse<FrameLayoutType>>
frame layout properties
- Defined in sdk/src/controllers/FrameController.ts:119

getPropertiesOnSelectedLayout

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

Returns Promise<EditorResponse<FrameLayoutType[]>>
all frame properties on current layout
- Defined in sdk/src/controllers/FrameController.ts:106

getSelected

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

Returns Promise<EditorResponse<FrameType[]>>
list of all selected frames
- Defined in sdk/src/controllers/FrameController.ts:67

remove

remove(id: string): Promise<EditorResponse<null>>
This method will remove a specific frame using the Id.
Parameters
- id: string
  the id of the frame that needs to be deleted
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:384

removeFrames

removeFrames(ids: string[]): Promise<EditorResponse<null>>
This method will remove frames with the given ids.
Parameters
- ids: string[]
  an array of ids of the frames to be removed.
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:394

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 sdk/src/controllers/FrameController.ts:467

rename

rename(id: string, name: string): Promise<EditorResponse<null>>
This method will update the name of a specific frame
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 sdk/src/controllers/FrameController.ts:271

reorderFrames

reorderFrames(order: number, ids: string[]): Promise<EditorResponse<null>>
This method changes the order of frames in the z-index list.
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 sdk/src/controllers/FrameController.ts:194

reset

reset(id: string): Promise<EditorResponse<null>>
This method will reset properties of a specific frame to their original values
Parameters
- id: string
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:281

resetAllAssetCropOverrides

resetAllAssetCropOverrides(id: string): Promise<EditorResponse<null>>
This method will reset all crop overrides for the specified frame
Parameters
- id: string
  the id of the frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1166

resetAnchoring

resetAnchoring(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:1120

resetAssetCropOverride

resetAssetCropOverride(id: string): Promise<EditorResponse<null>>
This method will set the crop override for the current asset for the specified frame
Parameters
- id: string
  the id of the frame that holds the override to reset
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1156

resetAutoGrow

resetAutoGrow(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:974

resetAutoGrowDirections

resetAutoGrowDirections(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:957

resetAutoGrowMaxHeight

resetAutoGrowMaxHeight(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:940

resetAutoGrowMaxWidth

resetAutoGrowMaxWidth(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:906

resetAutoGrowMinHeight

resetAutoGrowMinHeight(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:923

resetAutoGrowMinWidth

resetAutoGrowMinWidth(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:889

resetAutoGrowSettingsEnabled

resetAutoGrowSettingsEnabled(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use resetTransformation instead
- Defined in sdk/src/controllers/FrameController.ts:872

resetCropMode

resetCropMode(_id: string): Promise<EditorResponse<null>>
Parameters
- _id: string
Returns Promise<EditorResponse<null>>
Deprecated
This method no longer has any effect. Use 'setImageFrameFitMode' or 'resetImageFrameFitMode' instead
- Defined in sdk/src/controllers/FrameController.ts:771

resetEnableCopyfitting

resetEnableCopyfitting(id: string): Promise<EditorResponse<null>>
This method will reset the frame enableCopyfitting to the frame's original value
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:616

resetHeight

resetHeight(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:340

resetImageFrameFitMode

resetImageFrameFitMode(id: string): Promise<EditorResponse<null>>
This method will reset the fitMode, position and crop properties of a specific frame to its original value
Parameters
- id: string
  the id of the frame that needs to get reset
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:350

resetMaxCopyfitting

resetMaxCopyfitting(id: string): Promise<EditorResponse<null>>
This method will reset the frame maxCopyfitting to the frame's original value
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:606

resetMinCopyfitting

resetMinCopyfitting(id: string): Promise<EditorResponse<null>>
This method will reset the frame minCopyfitting to the frame's original value
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:596

resetRotation

resetRotation(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:316

resetSize

resetSize(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:154

resetTransformation

resetTransformation(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:142

resetVisibility

resetVisibility(id: string): Promise<EditorResponse<null>>
This method will reset the isVisible property of a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1130

resetWidth

resetWidth(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:328

resetX

resetX(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:292

resetY

resetY(id: string): Promise<EditorResponse<null>>
This method will reset the frame's transformation properties (x, y, width, height, rotation, anchors) to the frame's to be inherited from the parent layout
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
Deprecated
Use 'resetTransformation' instead
- Defined in sdk/src/controllers/FrameController.ts:304

select

select(id: string): Promise<EditorResponse<null>>
This method will select a specific frame
Parameters
- id: string
  the id of a specific frame
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:164

selectMultiple

selectMultiple(ids: string[]): Promise<EditorResponse<null>>
This method will select multipleFrames
Parameters
- ids: string[]
  An array of all ids you want to select
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:174

setAutoGrowDirections

setAutoGrowDirections(
id: string,
value: AutoGrowDirection[],
): Promise<EditorResponse<null>>
This method will set the auto grow directions for auto-grow of a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: AutoGrowDirection[]
  the new directions value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:860

setAutoGrowMaxHeight

setAutoGrowMaxHeight(
id: string,
value: null | string,
): Promise<EditorResponse<null>>
This method will set the maxHeight for auto-grow of a specified frame. Set to null to remove the value.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: null | string
  the new maxHeight value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:846

setAutoGrowMaxWidth

setAutoGrowMaxWidth(
id: string,
value: null | string,
): Promise<EditorResponse<null>>
This method will set the maxWidth for auto-grow of a specified frame. Set to null to remove the value.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: null | string
  the new maxWidth value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:818

setAutoGrowMinHeight

setAutoGrowMinHeight(
id: string,
value: null | string,
): Promise<EditorResponse<null>>
This method will set the minHeight for auto-grow of a specified frame. Set to null to remove the value.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: null | string
  the new minHeight value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:832

setAutoGrowMinWidth

setAutoGrowMinWidth(
id: string,
value: null | string,
): Promise<EditorResponse<null>>
This method will set the minWidth for auto-grow of a specified frame. Set to null to remove the value.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: null | string
  the new minWidth value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:804

setBlendMode

setBlendMode(id: string, blendMode: BlendMode): Promise<EditorResponse<null>>
This method will set the blend mode of a specified frame
Parameters
- id: string
  the id of a specific frame
- blendMode: BlendMode
  the blend mode
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:677

setBrandKitGradient

setBrandKitGradient(id: string, value: string): Promise<EditorResponse<null>>
This method will update (or set) the frame to use the provided brand kit gradient
Parameters
- id: string
  the id of the frame that needs to get updated
- value: string
  the id of an existing brandkit gradient
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1205

setEnableAutoGrow

setEnableAutoGrow(id: string, value: boolean): Promise<EditorResponse<null>>
This method will enable auto grow on a specified frame.
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 sdk/src/controllers/FrameController.ts:790

setEnableCopyfitting

setEnableCopyfitting(id: string, value: boolean): Promise<EditorResponse<null>>
This method will enable copyFitting on a specified frame.
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 sdk/src/controllers/FrameController.ts:586

setFrameConstrainProportions

setFrameConstrainProportions(
_id: string,
_constrainProportions: boolean,
): Promise<EditorResponse<null>>
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>>
Deprecated
the constrain proportions setter is not supported anymore.

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.
- Defined in sdk/src/controllers/FrameController.ts:534

setGradientApplied

setGradientApplied(id: string, value: boolean): Promise<EditorResponse<null>>
This method will enable/disable gradient on a specified frame.
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 sdk/src/controllers/FrameController.ts:1177

setHeight

setHeight(id: string, height: string): Promise<EditorResponse<null>>
This method will set the height of a specific frame
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 sdk/src/controllers/FrameController.ts:216

setHorizontalAnchor

setHorizontalAnchor(
    id: string,
    anchorType: FrameAnchorType,
    anchorTarget: AnchorTarget,
    endAnchorTarget?: null | AnchorTarget,
): Promise<EditorResponse<null>>
Experimental
This method will set the horizontal anchor to target frame on a specified frame.
Parameters
- id: string
  the id of the frame that needs to get a frame anchor set
- anchorType: FrameAnchorType
  the type of positioning to be set to the frame
- anchorTarget: AnchorTarget
  the target frame to which it is anchored
- OptionalendAnchorTarget: null | AnchorTarget
  the target (end) frame to which it can be anchored
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1104

setImageFrameFitMode

setImageFrameFitMode(
imageFrameId: string,
fitMode: FitMode,
): Promise<EditorResponse<null>>
This method will set the fitMode property of a specified image frame.
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 sdk/src/controllers/FrameController.ts:505

setImageFrameFitModePosition

setImageFrameFitModePosition(
imageFrameId: string,
position: FitModePosition,
): Promise<EditorResponse<null>>
This method will set the fit mode position property of a specified image frame.
Parameters
- imageFrameId: string
  the id of the imageFrame that needs to get updated.
- position: FitModePosition
  the new position that you want to set to the imageFrame.
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:516

setImageFromConnector

setImageFromConnector(
    imageFrameId: string,
    connectorId: string,
    assetId: string,
): Promise<EditorResponse<null>>
This method will assign an image from a mediaConnector to the correct ImageFrame
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 sdk/src/controllers/FrameController.ts:478

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.
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 sdk/src/controllers/FrameController.ts:494

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.
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 sdk/src/controllers/FrameController.ts:374

setLocalGradient

setLocalGradient(
id: string,
value: LinearGradientDefinition,
): Promise<EditorResponse<null>>
This method will update (or set) the local gradient on a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: LinearGradientDefinition
  the new value to be set to the frame.
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1191

setMaxCopyfitting

setMaxCopyfitting(id: string, value: string): Promise<EditorResponse<null>>
This method will set the max copyFitting property of a specified frame.
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 sdk/src/controllers/FrameController.ts:575

setMinCopyfitting

setMinCopyfitting(id: string, value: string): Promise<EditorResponse<null>>
This method will set the min copyFitting property of a specified frame.
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 sdk/src/controllers/FrameController.ts:564

setRotation

setRotation(id: string, rotation: string): Promise<EditorResponse<null>>
This method will set the rotation angle of a specific frame
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 sdk/src/controllers/FrameController.ts:227

setShadowAngleDegrees

setShadowAngleDegrees(id: string, value: number): Promise<EditorResponse<null>>
This method will set the angle in degrees for shadow of a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: number
  the new angle value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1021

setShadowBlurRadius

setShadowBlurRadius(id: string, value: number): Promise<EditorResponse<null>>
This method will set the blur radius for shadow of a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: number
  the new blur radius value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1035

setShadowColor

setShadowColor(id: string, value: ColorUsage): Promise<EditorResponse<null>>
This method will set the color for shadow of a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: ColorUsage
  the new color value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1049

setShadowDistance

setShadowDistance(id: string, value: string): Promise<EditorResponse<null>>
This method will set the distance for shadow of a specified frame.
Parameters
- id: string
  the id of the frame that needs to get updated
- value: string
  the new distance value to be set
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1007

setShadowEnabled

setShadowEnabled(id: string, value: boolean): Promise<EditorResponse<null>>
This method will enable shadow on a specified frame.
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 sdk/src/controllers/FrameController.ts:993

setShapeFrameEnableFill

setShapeFrameEnableFill(
shapeFrameId: string,
enableFill: boolean,
): Promise<EditorResponse<null>>
This method will set the visibility of the shape fill.
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 sdk/src/controllers/FrameController.ts:627

setShapeFrameEnableStroke

setShapeFrameEnableStroke(
shapeFrameId: string,
enableStroke: boolean,
): Promise<EditorResponse<null>>
This method will set the visibility of the shape stroke.
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 sdk/src/controllers/FrameController.ts:647

setShapeFrameFillColor

setShapeFrameFillColor(
shapeFrameId: string,
fillColor: ColorUsage,
): Promise<EditorResponse<null>>
This method will set the shape fill color of a specified shape frame.
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 sdk/src/controllers/FrameController.ts:637

setShapeFrameStrokeColor

setShapeFrameStrokeColor(
shapeFrameId: string,
strokeColor: ColorUsage,
): Promise<EditorResponse<null>>
This method will set the shape stroke color of a specified shape frame.
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 sdk/src/controllers/FrameController.ts:657

setShapeFrameStrokeWeight

setShapeFrameStrokeWeight(
shapeFrameId: string,
strokeWeight: number,
): Promise<EditorResponse<null>>
This method will set the shape stroke weight of a specified shape frame.
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 sdk/src/controllers/FrameController.ts:667

setVerticalAlign

setVerticalAlign(
id: string,
verticalAlign: VerticalAlign,
): Promise<EditorResponse<null>>
This method will set the vertical alignment property of a specified frame.
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 sdk/src/controllers/FrameController.ts:553

setVerticalAnchor

setVerticalAnchor(
    id: string,
    anchorType: FrameAnchorType,
    anchorTarget: AnchorTarget,
    endAnchorTarget?: null | AnchorTarget,
): Promise<EditorResponse<null>>
Experimental
This method will set the vertical anchor to target frame on a specified frame.
Parameters
- id: string
  the id of the frame that needs to get a frame anchor set
- anchorType: FrameAnchorType
  the type of positioning to be set to the frame
- anchorTarget: AnchorTarget
  the target frame to which it is anchored
- OptionalendAnchorTarget: null | AnchorTarget
  the target (end) frame to which it can be anchored
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1086

setVisibility

setVisibility(id: string, value: boolean): Promise<EditorResponse<null>>
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>>
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.
- Defined in sdk/src/controllers/FrameController.ts:363

setWidth

setWidth(id: string, width: string): Promise<EditorResponse<null>>
This method will set the width of a specific frame
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 sdk/src/controllers/FrameController.ts:238

setX

setX(id: string, XValue: string): Promise<EditorResponse<null>>
This method will set the x value of a specific frame
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 sdk/src/controllers/FrameController.ts:249

setY

setY(id: string, YValue: string): Promise<EditorResponse<null>>
This method will set the y value of a specific frame
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 sdk/src/controllers/FrameController.ts:260

setZIndex

setZIndex(id: string, method: UpdateZIndexMethod): Promise<EditorResponse<null>>
This method will update the z-index of a frame.
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 sdk/src/controllers/FrameController.ts:205

Class FrameController

Index

Methods

Methods

applyCropMode

Returns Promise<EditorResponse<null>>

applyGradientMode

Returns Promise<EditorResponse<null>>

applySubjectMode

Returns Promise<EditorResponse<null>>

cancelGradientMode

Returns Promise<EditorResponse<null>>

create

Parameters

Returns Promise<EditorResponse<string>>

createBarcodeFrame

Parameters

Returns Promise<EditorResponse<string>>

createShapeFrame

Parameters

Returns Promise<EditorResponse<string>>

deselectAll

Returns Promise<EditorResponse<null>>

duplicateFrames

Parameters

Returns Promise<EditorResponse<string>>

enterCropMode

Parameters

Returns Promise<EditorResponse<null>>

enterGradientMode

Parameters

Returns Promise<EditorResponse<null>>

enterSubjectMode

Parameters

Returns Promise<EditorResponse<null>>

exitCropMode

Returns Promise<EditorResponse<null>>

exitSubjectMode

Returns Promise<EditorResponse<null>>

getAll

Returns Promise<EditorResponse<FrameType[]>>

getAllByPageId

Parameters

Returns Promise<EditorResponse<FrameType[]>>

getAllLayoutProperties

Parameters

Returns Promise<EditorResponse<FrameLayoutType[]>>

getById

Parameters

Returns Promise<EditorResponse<FrameType>>

getByName

Parameters

Returns Promise<EditorResponse<FrameType>>

getConfiguration

Parameters

Returns Promise<EditorResponse<FrameConfiguration>>

getLayoutProperties

Parameters

Returns Promise<EditorResponse<FrameLayoutType>>

getPropertiesOnSelectedLayout

Returns Promise<EditorResponse<FrameLayoutType[]>>

getSelected

Returns Promise<EditorResponse<FrameType[]>>

remove

Parameters

Returns Promise<EditorResponse<null>>

removeFrames

Parameters

Returns Promise<EditorResponse<null>>

removeImageSource

Parameters

Returns Promise<EditorResponse<null>>

rename

Parameters

Returns Promise<EditorResponse<null>>

reorderFrames

Parameters

Returns Promise<EditorResponse<null>>

reset

Parameters