figma-layer

Methods for creating commonly-used layers and frames within the Figma document.

Source:

Methods

(static) createArrow(arrow) → {object}

Source:

Create an arrow in Figma (VectorNode)

Parameters:
Name Type Description
arrow Object

Arrow properties

Properties
Name Type Description
name string

name of new Arrow
x number

x of new Arrow placement
y number

y of new Arrow placement
height number

height of new Arrow
width number

height of new Arrow
stroke number

stroke of new Arrow
strokeColor string

stroke color of new Arrow
Returns:

VectorNode

Type
object

(static) createCircle(circle) → {object}

Source:

Create a circle (RectangleNode)

Parameters:
Name Type Description
circle Object

Circle properties

Properties
Name Type Description
name string

name of new Circle
x number

x of new Circle placement
y number

y of new Circle placement
size number

size of new Circle
fillColor string

fill (bg) color of new Circle
stroke number

stroke of new Circle
strokeColor string

stroke color of new Circle
Returns:

RectangleNode

Type
object

(static) createFrame(frame) → {object}

Source:

Create a Frame node in Figma

Parameters:
Name Type Description
frame Object

Frame node properties

Properties
Name Type Description
name string

name of new Frame node
x number

x of new Frame node placement
y number

y of new Frame node placement
height number

height of new Frame node
width number

width of new Frame node
fillColor string

fill (bg) color of new Rectangle node. Defaults to pink.
Returns:

FrameNode

Type
object

(static) createLine(line) → {object}

Source:

Create a line in Figma (LineNode)

Parameters:
Name Type Description
line Object

Line properties

Properties
Name Type Description
name string

name of new Line
x number

x of new Line placement
y number

y of new Line placement
height number

height of new Line
width number

height of new Line
fillColor string

fill (bg) color of new Line
Returns:

LineNode

Type
object

(static) createRectangle(rectangle) → {object}

Source:

Create a rectangle in Figma (Rectangle Node)

Parameters:
Name Type Description
rectangle Object

Rectangle node properties

Properties
Name Type Description
name string

name of new Rectangle node
x number

x of new Rectangle node placement
y number

y of new Rectangle node placement
height number

height of new Rectangle node
width number

width of new Rectangle node
fillColor string

fill (bg) color of new Rectangle node
opacity float

opacity of new Rectangle node
radius number

radius of new Rectangle node
radiusMixed array

array of overrides for radius of new Rectangle node
stroke number

stroke of new Rectangle node
strokeColor string

stroke color of new Rectangle node
Returns:

RectangleNode

Type
object

(static) createTransparentFrame(frame) → {object}

Source:

Create a transparent Frame node in Figma

Parameters:
Name Type Description
frame Object

Frame node properties

Properties
Name Type Description
name string

name of new Frame node
x number

x of new Frame node placement
y number

y of new Frame node placement
height number

height of new Frame node
width number

width of new Frame node
Returns:

FrameNode

Type
object