Shared Node Properties

Nodes support a range of properties. Some properties are universal, some are shared between node types, and some are unique to specific node types.

On this page, you can explore properties which are available on multiple nodes. Properties appear in alphabetical order, and you can see which nodes each property is supported on.

absoluteBoundingBox: Rect | null [readonly]

The bounds of the node that does not include rendered properties like drop shadows or strokes. The x and y inside this property represent the absolute position of the node on the page.

absoluteRenderBounds: Rect | null [readonly]

Supported On:

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.

absoluteTransform: Transform [readonly]

The position of a node relative to its containing page as a Transform matrix.

addComponentProperty(propertyName: string, type: ComponentPropertyType, defaultValue: string | boolean, options?: ComponentPropertyOptions): string

Supported On:

Adds a new component property to this node and returns the property name with its unique identifier suffixed. This function supports properties with type 'BOOLEAN', 'TEXT', 'INSTANCE_SWAP' or 'VARIANT'.

appendChild(child: SceneNode): void

Supported On:

Adds a new child to the end of the children array. That is, visually on top of all other children.

absoluteBoundingBox: Rect | null [readonly]

absoluteRenderBounds: Rect | null [readonly]

absoluteTransform: Transform [readonly]

addComponentProperty(propertyName: string, type: ComponentPropertyType, defaultValue: string | boolean, options?: ComponentPropertyOptions): string

appendChild(child: SceneNode): void

attachedConnectors: ConnectorNode[] [readonly]

backgroundStyleId: string

backgrounds: ReadonlyArray<Paint>

blendMode: BlendMode

bottomLeftRadius: number

bottomRightRadius: number

children: ReadonlyArray<SceneNode> [readonly]

clipsContent: boolean

componentPropertyDefinitions: ComponentPropertyDefinitions [readonly]

componentPropertyReferences: { [nodeProperty in 'visible' | 'characters' | 'mainComponent']?: string } | null

constrainProportions: boolean

constraints: Constraints

cornerRadius: number | figma.mixed

cornerSmoothing: number

counterAxisAlignItems: 'MIN' | 'MAX' | 'CENTER' | 'BASELINE'

counterAxisSizingMode: 'FIXED' | 'AUTO'

dashPattern: ReadonlyArray<number>

deleteComponentProperty(propertyName: string): void

description: string

documentationLinks: ReadonlyArray<DocumentationLink>

editComponentProperty(propertyName: string, newValue: { name?: string, defaultValue?: string | boolean, preferredValues?: InstanceSwapPreferredValue[] }): string

effectStyleId: string

effects: ReadonlyArray<Effect>

expanded: boolean

exportAsync(settings?: ExportSettings): Promise<Uint8Array>

exportSettings: ReadonlyArray<ExportSettings>

fillGeometry: VectorPaths

fillStyleId: string | figma.mixed

fills: ReadonlyArray<Paint> | figma.mixed

findAll(callback?: (node: SceneNode) => boolean): SceneNode[]

findAllWithCriteria<T extends NodeType[]>(criteria: { types: T }): Array<{ type: T[number] } & SceneNode>

findChild(callback: (node: SceneNode) => boolean): SceneNode | null

findChildren(callback?: (node: SceneNode) => boolean): SceneNode[]

findOne(callback: (node: SceneNode) => boolean): SceneNode | null

findWidgetNodesByWidgetId(widgetId: string): Array<WidgetNode>

getPluginData(key: string): string

getPluginDataKeys(): string[]

getPublishStatusAsync(): Promise<PublishStatus>

getRelaunchData(): { [command: string]: string }

getSharedPluginData(namespace: string, key: string): string

getSharedPluginDataKeys(namespace: string): string[]

gridStyleId: string

guides: ReadonlyArray<Guide>

handleMirroring: HandleMirroring | figma.mixed

height: number [readonly]

horizontalPadding: number

id: string [readonly]

insertChild(index: number, child: SceneNode): void

isMask: boolean

itemReverseZIndex: boolean

itemSpacing: number

key: string [readonly]

layoutAlign: 'MIN' | 'CENTER' | 'MAX' | 'STRETCH' | 'INHERIT'

layoutGrids: ReadonlyArray<LayoutGrid>

layoutGrow: number

layoutMode: 'NONE' | 'HORIZONTAL' | 'VERTICAL'

layoutPositioning: 'AUTO' | 'ABSOLUTE'

locked: boolean

name: string

numberOfFixedChildren: number

opacity: number

outlineStroke(): VectorNode | null

overflowDirection: OverflowDirection

overlayBackground: OverlayBackground [readonly]

overlayBackgroundInteraction: OverlayBackgroundInteraction [readonly]

overlayPositionType: OverlayPositionType [readonly]

paddingBottom: number

paddingLeft: number

paddingRight: number

paddingTop: number

parent: (BaseNode & ChildrenMixin) | null [readonly]

primaryAxisAlignItems: 'MIN' | 'MAX' | 'CENTER' | 'SPACE_BETWEEN'

primaryAxisSizingMode: 'FIXED' | 'AUTO'

reactions: ReadonlyArray<Reaction>

relativeTransform: Transform