children
Node[]- An array of nodes that are direct children of this node.
locked
Booleandefault: false- If true, layer is locked and cannot be edited.
background
Paint[]deprecated- Background of the node. This is deprecated, as backgrounds for frames are now in the
fills
field. backgroundColor
Colordeprecated- Background color of the node. This is deprecated, as frames now support more than a solid color as a background. Please use the
fills
field instead. fills
Paint[]default: []- An array of fill paints applied to the node.
strokes
Paint[]default: []- An array of stroke paints applied to the node.
strokeWeight
Number- The weight of strokes on the node.
strokeAlign
StringPosition of stroke relative to vector outline, as a string enum.
INSIDE
: stroke drawn inside the shape boundaryOUTSIDE
: stroke drawn outside the shape boundaryCENTER
: stroke drawn centered along the shape boundary
strokeDashes
Number[]default: []- An array of floating point numbers describing the pattern of dash length and gap lengths that the vector path follows. For example a value of
[1, 2]
indicates that the path has a dash of length 1 followed by a gap of length 2, repeated. cornerRadius
Number- Radius of each corner of the frame if a single radius is set for all corners.
rectangleCornerRadii
Number[]default: same as cornerRadius- Array of length 4 of the radius of each corner of the rectangle, starting in the top left and proceeding clockwise.
cornerSmoothing
Numberdefault: 0- A value that lets you control how "smooth" the corners are. Ranges from 0 to 1. 0 means that the corner is perfectly circular. A value of 0.6 means the corner matches the iOS 7 "squircle" icon shape. Other values produce various other curves. See this post for the gory details!
exportSettings
ExportSettings[]default: []- An array of export settings representing images to export from the node.
blendMode
BlendMode- How this node blends with nodes behind it in the scene (see blend mode section for more details).
preserveRatio
Booleandeprecateddefault: false- Keep height and width constrained to same ratio. Deprecated in favor of
targetAspectRatio
. targetAspectRatio
0- If set, keeps height and width constrained to the target aspect ratio. Unlike
preserveRatio
, also works outside of properties panel resizing actions. constraints
LayoutConstraint- Horizontal and vertical layout constraints for the node.
layoutAlign
StringDetermines if the layer should stretch along the parent's counter axis. This property is only provided for direct children of auto-layout frames.
In previous versions of auto layout, determined how the layer is aligned inside an auto-layout frame. This property is only provided for direct children of auto-layout frames.
In horizontal auto-layout frames, MIN
and MAX
correspond to TOP
and BOTTOM
. In vertical auto-layout frames, MIN
and MAX
correspond to LEFT
and RIGHT
.
interactions
Interaction[]- List of prototype interactions on this node, which includes both the method of interaction with this node in a prototype, and the behavior of that interaction.
transitionNodeID
Stringdefault: null- Node ID of node to transition to in prototyping.
transitionDuration
Numberdefault: null- The duration of the prototyping transition on this node (in milliseconds).
transitionEasing
EasingTypedefault: null- The easing curve used in the prototyping transition on this node.
opacity
Numberdefault: 1- Overall opacity of paint (colors within the paint can also have opacity values which would blend with this).
absoluteBoundingBox
Rectangle- Bounding box of the node in absolute space coordinates.
absoluteRenderBounds
0- The actual bounds of a node accounting for drop shadows, thick strokes, and anything else that may fall outside the node's regular bounding box defined in
x
, y
, width
, and height
. The x
and y
inside this property represent the absolute position of the node on the page. This value will be null
if the node is invisible. size
Vector- Width and height of element. This is different from the width and height of the bounding box in that the absolute bounding box represents the element after scaling and rotation. Only present if
geometry=paths
is passed. minWidth
Number | nulldefault: null- The minWidth of the frame, or null if not set.
maxWidth
Number | nulldefault: null- The maxWidth of the frame, or null if not set.
minHeight
Number | nulldefault: null- The minHeight of the frame, or null if not set.
maxHeight
Number | nulldefault: null- The maxHeight of the frame, or null if not set.
relativeTransform
Transform- The top two rows of a matrix that represents the 2D transform of this node relative to its parent. The bottom row of the matrix is implicitly always
(0, 0, 1)
. Use to transform coordinates in geometry. Only present if geometry=paths
is passed. clipsContent
Boolean- Whether or not this node clips content outside of its bounds.
layoutMode
Stringdefault: NONEWhether this layer uses auto-layout to position its children.
NONE
HORIZONTAL
VERTICAL
GRID
layoutSizingHorizontal
StringThe horizontal sizing setting on this auto-layout frame or frame child.
HUG is only valid on auto-layout frames and text nodes. FILL is only valid on auto-layout frame children.
layoutSizingVertical
StringThe vertical sizing setting on this auto-layout frame or frame child.
HUG is only valid on auto-layout frames and text nodes. FILL is only valid on auto-layout frame children.
layoutWrap
StringWhether this auto-layout frame has wrapping enabled.
primaryAxisSizingMode
Stringdefault: AUTOWhether the primary axis has a fixed length (determined by the user) or an automatic length (determined by the layout engine). This property is only applicable for auto-layout frames.
counterAxisSizingMode
Stringdefault: AUTOWhether the counter axis has a fixed length (determined by the user) or an automatic length (determined by the layout engine). This property is only applicable for auto-layout frames.
primaryAxisAlignItems
Stringdefault: MINDetermines how the auto-layout frame’s children should be aligned in the primary axis direction. This property is only applicable for auto-layout frames.
MIN
CENTER
MAX
SPACE_BETWEEN
counterAxisAlignItems
Stringdefault: MINDetermines how the auto-layout frame’s children should be aligned in the counter axis direction. This property is only applicable for auto-layout frames.
counterAxisAlignContent
Stringdefault: AUTODetermines how the auto-layout frame’s wrapped tracks should be aligned in the counter axis direction. This property is only applicable for auto-layout frames with layoutWrap: "WRAP"
.
gridRowCount
Number- The number of rows in the grid layout. This property is only applicable for auto-layout frames with
layoutMode: "GRID"
. gridColumnCount
Number- The number of columns in the grid layout. This property is only applicable for auto-layout frames with
layoutMode: "GRID"
. gridRowGap
Numberdefault: 0- The distance between rows in the grid layout. This property is only applicable for auto-layout frames with
layoutMode: "GRID"
. gridColumnGap
Numberdefault: 0- The distance between columns in the grid layout. This property is only applicable for auto-layout frames with
layoutMode: "GRID"
. gridColumnsSizing
String- The string for the CSS grid-template-columns property. This property is only applicable for auto-layout frames with
layoutMode: "GRID"
. gridRowsSizing
String- The string for the CSS grid-template-rows property. This property is only applicable for auto-layout frames with
layoutMode: "GRID"
. gridChildHorizontalAlign
Stringdefault: AUTODetermines how a GRID frame's child should be aligned in the horizontal direction within its grid area. This property is only applicable for direct children of frames with layoutMode: "GRID"
.
gridChildVerticalAlign
Stringdefault: AUTODetermines how a GRID frame's child should be aligned in the vertical direction within its grid area. This property is only applicable for direct children of frames with layoutMode: "GRID"
.
gridRowSpan
Numberdefault: 1- The number of rows that a GRID frame's child should span. This property is only applicable for direct children of frames with
layoutMode: "GRID"
. gridColumnSpan
Numberdefault: 1- The number of columns that a GRID frame's child should span. This property is only applicable for direct children of frames with
layoutMode: "GRID"
. gridColumnAnchorIndex
Numberdefault: 0- The index of the column that a GRID frame's child should be anchored to. This property is only applicable for direct children of frames with
layoutMode: "GRID"
. gridRowAnchorIndex
Numberdefault: 0- The index of the row that a GRID frame's child should be anchored to. This property is only applicable for direct children of frames with
layoutMode: "GRID"
. paddingLeft
Numberdefault: 0- The padding between the left border of the frame and its children. This property is only applicable for auto-layout frames.
paddingRight
Numberdefault: 0- The padding between the right border of the frame and its children. This property is only applicable for auto-layout frames.
paddingTop
Numberdefault: 0- The padding between the top border of the frame and its children. This property is only applicable for auto-layout frames.
paddingBottom
Numberdefault: 0- The padding between the bottom border of the frame and its children. This property is only applicable for auto-layout frames.
horizontalPadding
Numberdeprecateddefault: 0- The horizontal padding between the borders of the frame and its children. This property is only applicable for auto-layout frames. Deprecated in favor of setting individual paddings.
verticalPadding
Numberdeprecateddefault: 0- The vertical padding between the borders of the frame and its children. This property is only applicable for auto-layout frames. Deprecated in favor of setting individual paddings.
itemSpacing
Numberdefault: 0- The distance between children of the frame. Can be negative. This property is only applicable for auto-layout frames.
counterAxisSpacing
Numberdefault: 0- The distance between wrapped tracks of an auto-layout frame. This property is only applicable for auto-layout frames with
layoutWrap: "WRAP"
. layoutPositioning
Stringdefault: AUTODetermines whether a layer's size and position should be determined by auto-layout settings or manually adjustable.
itemReverseZIndex
Booleandefault: false- Determines the canvas stacking order of layers in this frame. When true, the first layer will be draw on top. This property is only applicable for auto-layout frames.
strokesIncludedInLayout
Booleandefault: false- Determines whether strokes are included in layout calculations. When true, auto-layout frames behave like css
box-sizing: border-box
. This property is only applicable for auto-layout frames. layoutGrids
LayoutGrid[]default: []- An array of layout grids attached to this node (see layout grids section for more details).
GROUP
nodes do not have this attribute. overflowDirection
Stringdefault: NONEDefines the scrolling behavior of the frame, if there exist contents outside of the frame boundaries. The frame can either scroll vertically, horizontally, or in both directions to the extents of the content contained within it. This behavior can be observed in a prototype.
HORIZONTAL_SCROLLING
VERTICAL_SCROLLING
HORIZONTAL_AND_VERTICAL_SCROLLING
NONE
effects
Effect[]default: []- An array of effects attached to this node (see effects section for more details).
isMask
Booleandefault: false- Does this node mask sibling nodes in front of it?
isMaskOutline
Booleandeprecateddefault: false- Whether the mask ignores fill style (e.g. gradients) and effects. This property is deprecated; please use the
maskType
field instead (isMaskOutline=true
corresponds to maskType="VECTOR"
). maskType
StringIf this layer is a mask, this property describes the operation used to mask the layer's siblings. The value may be one of the following:
ALPHA
: the mask node's alpha channel will be used to determine the opacity of each pixel in the masked result.VECTOR
: if the mask node has visible fill paints, every pixel inside the node's fill regions will be fully visible in the masked result. If the mask has visible stroke paints, every pixel inside the node's stroke regions will be fully visible in the masked result.LUMINANCE
: the luminance value of each pixel of the mask node will be used to determine the opacity of that pixel in the masked result.
styles
Map<String, String>- A mapping of a style_type to style ID (see Style for more details) of styles present on this node. The style ID can be used to look up more information about the style in the top-level styles field.
devStatus
0default: null- Whether the node is marked
Ready for dev
or Completed
. If the node does not have a status, the property is null
. annotations
Annotation[]private betadefault: []- An array of annotations displaying notes and pinned properties of nodes in Dev Mode. Currently a maximum of 1 annotation is supported.