Class FrameConstraintController

Index

Methods

get setAllowedCharacterStyles setAllowedColors setAllowedFontSizes setAllowedParagraphStyles setCrop setHorizontalMovement setResize setRotation setSelectable setTextEditingAllowed setVerticalMovement

Methods

get

get(id: string): Promise<EditorResponse<FrameConstraints>>
This method will retrieve all constraints for a specified frame
Parameters
- id: string
  the id of the frame that we want to know the constraints from
Returns Promise<EditorResponse<FrameConstraints>>
the constraints configuration for the frame
- Defined in sdk/src/controllers/FrameController.ts:1302

setAllowedCharacterStyles

setAllowedCharacterStyles(
id: string,
constraint: IdSetManagedConstraint,
): Promise<EditorResponse<null>>
This method will set the allowed character styles constraint for a specified text frame
Parameters
- id: string
  the id of the frame that needs to get updated
- constraint: IdSetManagedConstraint
  the managed constraint: when allowed is true, only the provided ids may be used; when false, the constraint is turned off (stored value is kept for reactivation)
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1429

setAllowedColors

setAllowedColors(
id: string,
constraint: IdSetManagedConstraint,
): Promise<EditorResponse<null>>
This method will set the allowed colors constraint for a specified text frame
Parameters
- id: string
  the id of the frame that needs to get updated
- constraint: IdSetManagedConstraint
  the managed constraint: when allowed is true, only the provided ids may be used; when false, the constraint is turned off (stored value is kept for reactivation)
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1443

setAllowedFontSizes

setAllowedFontSizes(
id: string,
constraint: FontSizeRangeManagedConstraint,
): Promise<EditorResponse<null>>
This method will set the allowed font sizes constraint for a specified text frame
Parameters
- id: string
  the id of the frame that needs to get updated
- constraint: FontSizeRangeManagedConstraint
  the managed constraint: when allowed is true, restricts font sizes to min and max (inclusive); when false, the constraint is turned off (stored value is kept for reactivation)
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1457

setAllowedParagraphStyles

setAllowedParagraphStyles(
id: string,
constraint: IdSetManagedConstraint,
): Promise<EditorResponse<null>>
This method will set the allowed paragraph styles constraint for a specified text frame
Parameters
- id: string
  the id of the frame that needs to get updated
- constraint: IdSetManagedConstraint
  the managed constraint: when allowed is true, only the provided ids may be used; when false, the constraint is turned off (stored value is kept for reactivation)
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1415

setCrop

setCrop(id: string, allowed: boolean): Promise<EditorResponse<null>>
This method will set the crop constraint for a specified image frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether crop is allowed or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1387

setHorizontalMovement

setHorizontalMovement(
id: string,
allowed: boolean,
): Promise<EditorResponse<null>>
This method will set the horizontal movement constraint for a specified frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether horizontal movement is allowed or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1327

setResize

setResize(
    id: string,
    allowed: boolean,
    proportionLocked?: boolean,
): Promise<EditorResponse<null>>
This method will set the resize constraint for a specified frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether resize is allowed or not
- OptionalproportionLocked: boolean
  whether the frame's proportions are locked or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1370

setRotation

setRotation(id: string, allowed: boolean): Promise<EditorResponse<null>>
This method will set the rotation constraint for a specified frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether rotation is allowed or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1355

setSelectable

setSelectable(id: string, allowed: boolean): Promise<EditorResponse<null>>
This method will set the selectable constraint for a specified frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether the frame is selectable or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1313

setTextEditingAllowed

setTextEditingAllowed(
id: string,
allowed: boolean,
): Promise<EditorResponse<null>>
This method will set the text editing constraint for a specified text frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether text editing is allowed or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1401

setVerticalMovement

setVerticalMovement(id: string, allowed: boolean): Promise<EditorResponse<null>>
This method will set the vertical movement constraint for a specified frame
Parameters
- id: string
  the id of the frame that needs to get updated
- allowed: boolean
  whether vertical movement is allowed or not
Returns Promise<EditorResponse<null>>
- Defined in sdk/src/controllers/FrameController.ts:1341

Class FrameConstraintController

Index

Methods

Methods

get

Parameters

Returns Promise<EditorResponse<FrameConstraints>>

setAllowedCharacterStyles

Parameters

Returns Promise<EditorResponse<null>>

setAllowedColors

Parameters

Returns Promise<EditorResponse<null>>

setAllowedFontSizes

Parameters

Returns Promise<EditorResponse<null>>

setAllowedParagraphStyles

Parameters

Returns Promise<EditorResponse<null>>

setCrop

Parameters

Returns Promise<EditorResponse<null>>

setHorizontalMovement

Parameters

Returns Promise<EditorResponse<null>>

setResize

Parameters

Returns Promise<EditorResponse<null>>

setRotation

Parameters

Returns Promise<EditorResponse<null>>

setSelectable

Parameters

Returns Promise<EditorResponse<null>>

setTextEditingAllowed

Parameters

Returns Promise<EditorResponse<null>>

setVerticalMovement

Parameters

Returns Promise<EditorResponse<null>>

Settings

On This Page