Layers

Content textarea
Family string
Style string
Size string
Line height string
Letter spacing string
Align horizontal multiselect
- Inherit
- ← Left
- ↔ Center
- → Right
- Justified
Align vertical multiselect
- Inherit
- ↑ Top
- ↕ Center
- ↓ Bottom
Decoration multiselect
- None
- Underline
- Strikethrough
Case multiselect
- As typed
- Uppercase
- Lowercase
- Title case
Resize multiselect
- Auto width
- Auto height
- Fixed
Fill color

Set text (setTextCharacters)

Sets text characters

Properties

Content textarea

Set font name (setFontName)

Sets font name

Properties

Family string
Style string

Set font size (setFontSize)

Sets font size

Properties

Size string

Set line height (setLineHeight)

Sets font name

Properties

Line height string

Set letter spacing (setLetterSpacing)

Sets letter spacing

Properties

Letter spacing string

Set text alignment (setTextAlignment)

Sets text alignment

Properties

Align horizontal multiselect
- Inherit
- ← Left
- ↔ Center
- → Right
- Justified
Align vertical multiselect
- Inherit
- ↑ Top
- ↕ Center
- ↓ Bottom

Set text case (setTextCase)

Sets text case

Properties

Case multiselect
- As typed
- Uppercase
- Lowercase
- Title case

Set text decoration (setTextDecoration)

Sets text decoration

Properties

Decoration multiselect
- None
- Underline
- Strikethrough

Set text resize (setTextAutoResize)

Sets text resize

Properties

Resize multiselect
- Auto width
- Auto height
- Fixed

Properties

Set layer name (setName)

Sets layer name

Properties

Name string

Add fill (addFill)

Adds fill color

Properties

Fill color

Remove fills (removeFills)

Removes all fills

Properties

No properties

Set opacity (setOpacity)

Sets opacity

Properties

Opacity number

Set corner radius (setCornerRadius)

Sets corner radius

Properties

Corner radius number

Set corner smoothing (setCornerSmoothing)

Sets corner smoothing

Properties

Corner smoothing number

Set scale (setScale)

Scale by number

Properties

Scale number

Set point count (setPointCount)

Sets point count

Properties

Point count number

Paste properties (pasteProperties)

Paste properties from the source node

Properties

Source node ID string — The ID of the node to copy properties from

Layout

Set position (setPosition)

Sets X and Y positions

Properties

X number
Y number

Set dimensions (setDimensions)

Sets width and height

Properties

Width number
Height number

Set alignment (setAlignment)

Sets layer alignment

Properties

Align horizontal multiselect
- Inherit
- ← Left
- ↔ Center
- → Right
Align vertical multiselect
- Inherit
- ↑ Top
- ↕ Center
- ↓ Bottom

Set rotation (setRotation)

Sets rotation

Properties

Rotation number

Set constraints (setLayoutConstraints)

Sets layout constraints

Properties

Horizontal multiselect
- Inherit
- ← Left
- → Right
- ↔ Left and right
- – Center
- Scale
Vertical multiselect
- Inherit
- ↑ Top
- ↓ Bottom
- ↕ Top and bottom
- ǀ Center
- Scale

Set auto layout (setAutoLayout)

Sets auto layout

Properties

Direction multiselect
- ↓ Vertical
- → Horizontal
Item spacing number
Horizontal resize multiselect
- Fixed width
- Hug contents
Vertical resize multiselect
- Fixed height
- Hug contents
Horizontal align multiselect
- ← Left
- – Center
- → Right
Vertical align multiselect
- ↑ Top
- ǀ Center
- ↓ Bottom
Item alignment multiselect
- Packed
- Space between
Left padding number
Right padding number
Top padding number
Bottom padding number

Set auto layout resizing (setAutoLayoutResizing)

Sets horizontal and vertical resizing for auto layout children

Properties

Horizontal resize multiselect
- Fixed width
- Hug contents
- Fill container
Vertical resize multiselect
- Fixed height
- Hug contents
- Fill container

Remove auto layout (removeAutoLayout)

Removes auto layout

Properties

No properties

Strokes

Add stroke (addStroke)

Adds stroke

Properties

Color color
Weight number
Align multiselect
- Inside
- Center
- Outside

Set stroke weight (setStrokeWeight)

Sets stroke weight

Properties

Weight number

Set stroke align (setStrokeAlign)

Sets stroke align

Properties

Align multiselect
- Inside
- Center
- Outside

Set stroke style (setStrokeStyle)

Sets a stroke style

Properties

Name string

Remove strokes (removeStrokes)

Removes all strokes

Properties

No properties

Outline stroke (outlineStroke)

Outlines stroke

Properties

No properties

Effects

Add shadow (addShadowEffect)

Adds shadow effect

Properties

Type multiselect
- Inner shadow
- Drop shadow
X number
Y number
Blur number
Spread number
Color color

Add blur (addBlurEffect)

Adds layer or background blur effect

Properties

Type multiselect
- Layer blur
- Background blur
Blur number

Remove effects (removeEffects)

Removes all effects

Properties

No properties

Styles

Find styles (getStyles)

Get color, effect, or text styles matching property

Properties

Find multiselect
- Colors
- Effects
- Text
In multiselect
- Current file
- Team libraries (unsupported)
Where multiselect
- —
- id
- name
- key
- type
- description
- remote
Condition multiselect
- is
- is not
- has any value
- does not have any value
- contains
- does not contain
- begins with
- ends with
- is greater than
- is greater than or equal to
- is less than
- is less than or equal to
Value string

Get style by ID (getStyleById)

Gets a style by ID

Properties

ID string

Create color style (createColorStyle)

Creates a color style

Properties

Name string
Description string
Fill color

Create text style (createTextStyle)

Creates a text style

Properties

Name string
Description string
Family string
Style string
Size string
Line height string
Letter spacing string
Decoration multiselect
- None
- Underline
- Strikethrough
Case multiselect
- As typed
- Uppercase
- Lowercase
- Title case

Create effect style (createEffectStyle)

Creates an effect style

Properties

Name string
Description string
Type multiselect
- Inner shadow
- Drop shadow
X number
Y number
Blur number
Spread number
Color color

Set color style (setColorStyle)

Sets a color style

Properties

Name string

Set text style (setTextStyle)

Sets a text style

Properties

Name string

Set effect style (setEffectStyle)

Sets an effect style

Properties

Name string

Export

Export (exportToFile)

Exports the parent action to a file

Properties

No properties

Add export setting (addExportSetting)

Adds export setting

Properties

Format multiselect
- PNG
- JPG
- SVG
- PDF
Scale number
Suffix string

Remove export settings (removeExportSettings)

Removes all export settings

Properties

No properties

Prototyping

Add flow starting point (addFlowStartingPoint)

Adds a flow starting point to the parent action

Properties

Name string

Add interaction (addInteraction)

Adds interaction

Properties

Trigger multiselect
- On click
- On drag
- While hovering
- While pressing
Action multiselect
- Navigate to
- Back
- Close overlay
- Open link
Destination ID string
Type multiselect
- Navigate
- Overlay
- Scroll
- Swap
- Change
Animation multiselect
- Instant
- Dissolve
- Smart animate
- Scroll animate
- Move in
- Move out
- Push
- Slide in
- Slide out
Direction multiselect
- ← Left
- → Right
- ↑ Top
- ↓ Bottom
Smart animate boolean
Easing multiselect
- Linear
- Ease in
- Ease out
- Ease in and out
- Ease in back
- Ease out back
- Ease in and out back
- Custom
Duration (ms) number
Preserve scroll boolean
URL string

Events

On selection change (onSelectionChange)

Run actions when the current selection changes

Properties

No properties

On current page change (onCurrentPageChange)

Run actions when the current page changes

Properties

No properties

On drop (onDrop)

Run actions when an object is dropped on the canvas

Properties

No properties

Scripting

Find layers (find)

Finds nodes matching property

Properties

Find multiselect
- All
- One
- Children
- Child
In multiselect
- Entire file
- Current page
- Parent action
Where multiselect
- —
- name
- type
- id
- characters
- width
- height
- x
- y
- visible
- locked
- isMask
- fillStyleId
- strokeStyleId
- effectStyleId
Condition multiselect
- is
- is not
- has any value
- does not have any value
- contains
- does not contain
- begins with
- ends with
- is greater than
- is greater than or equal to
- is less than
- is less than or equal to
Value string

For each (forEach)

Iterate over the items in the parent action or provided array

Properties

Array textarea — The array to iterate over (optional)

If (if)

Runs the child actions if the comparison between the input and value is true

Properties

Input string
Condition multiselect
- is
- is not
- has any value
- does not have any value
- contains
- does not contain
- begins with
- ends with
- is greater than
- is greater than or equal to
- is less than
- is less than or equal to
Value string

Else (else)

Runs the child actions when the parent if action is false

Properties

No properties

Repeat (repeat)

Repeat actions a specified number of times

Properties

Times number

Set variable (setVariable)

Sets a variable

Properties

Name string
Value textarea

Ask for input (askForInput)

Prompt for an input

Properties

Variable string — The name of the variable to store the input in
Prompt string — The text to display when asked for input

Get node by ID (getNodeById)

Gets a node by ID

Properties

ID string

Set property (setProperty)

Sets any property

Properties

Name string — The name of the property to set
Value string — The value of the property to set

Log to console (logToConsole)

Logs to console

Properties

Message textarea

Show message (showMessage)

Shows a message

Properties

Message textarea

Show alert (showAlert)

Shows an alert

Properties

Message textarea

Run script (runScript)

Runs a custom script

Properties

Script textarea

Delay (delay)

Delay

Properties

Milliseconds number

Copy to clipboard (copyToClipboard)

Copies to clipboard

Properties

Content string

Shared plugin data

Set shared plugin data (setSharedPluginData)

Sets shared plugin data

Properties

Key string
Value textarea

Get shared plugin data (getSharedPluginData)

Gets shared plugin data

Properties

Namespace string — The namespace of the shared plugin data
Key string
Variable string — The name of the varaible to store the plugin data in

Thumbnail

Set file thumbnail (setFileThumbnail)

Set the file thumbnail by node ID

Properties

Node ID string

Get file thumbnail (getFileThumbnail)

Gets the file thumbnail

Properties

No properties

Undo

Commit to undo history (commitUndo)

Commits actions to undo history. This does not trigger an undo.

Properties

No properties

Trigger undo (triggerUndo)

Triggers an undo action. Reverts to the last undo state.

Properties

No properties

Web

Fetch URL (fetchURL)

Fetches a URL

Properties

Method multiselect
- GET
- POST
- PUT
- PATCH
- DELETE
URL string
Headers textarea
Body textarea

Open URL (openURL)

Opens a URL

Properties

URL string

FigJam

Create sticky (createSticky)

Creates a sticky in FigJam

Properties

Content textarea

Create shape with text (createShapeWithText)

Creates a shape with text in FigJam

Properties

Shape multiselect
- Square
- Ellipse
- Rounded rectangle
- Diamond
- Triangle
- Downward-pointing triangle
- Right-leaning parallelogram
- Left-leaning parallelogram
Content textarea

Create code block (createCodeBlock)

Creates a code block in FigJam

Properties

Language multiselect
- C++
- CSS
- Go
- GraphQL
- HTML
- JavaScript
- JSON
- Kotlin
- Python
- Ruby
- Rust
- SQL
- Swift
- TypeScript
Code textarea