Interface DocumentApi

Hierarchy

NodeApi<DocumentNode>
- DocumentApi

Index

Properties

Methods

Properties

children

children: CanvasApi[]

file

id

id: string

index

index: number

Optional isFixed

isFixed?: boolean

name

name: string

parent

parent: NodeApi<Node>

pluginData

pluginData: any

props

props: Record<string, string>

sharedPluginData

sharedPluginData: any

type

type: "DOCUMENT"

Optional visible

visible?: boolean

Methods

ancestors

ancestors(): NodeApi<Node>[]

Inherited from NodeApi.ancestors
- Defined in types/figmatik.d.ts:25
Returns NodeApi<Node>[]

find

find(pre: ((node?: NodeApi<Node>) => boolean | void)): undefined | NodeApi<Node>

Inherited from NodeApi.find
- Defined in types/figmatik.d.ts:23
Parameters
- pre: ((node?: NodeApi<Node>) => boolean | void)
  - - (node?: NodeApi<Node>): boolean | void
    - Parameters
      - Optional node: NodeApi<Node>
      Returns boolean | void
Returns undefined | NodeApi<Node>

findAll

findAll(pre: ((node?: NodeApi<Node>) => boolean | void)): NodeApi<Node>[]

Inherited from NodeApi.findAll
- Defined in types/figmatik.d.ts:24
Parameters
- pre: ((node?: NodeApi<Node>) => boolean | void)
  - - (node?: NodeApi<Node>): boolean | void
    - Parameters
      - Optional node: NodeApi<Node>
      Returns boolean | void
Returns NodeApi<Node>[]

iterate

iterate(): Generator<NodeApi<Node>, any, any>

Inherited from NodeApi.iterate
- Defined in types/figmatik.d.ts:22
Returns Generator<NodeApi<Node>, any, any>

walk

walk(cb: ((node?: NodeApi<Node>) => boolean | void)): void

Inherited from NodeApi.walk
- Defined in types/figmatik.d.ts:21
Parameters
- cb: ((node?: NodeApi<Node>) => boolean | void)
  - - (node?: NodeApi<Node>): boolean | void
    - Parameters
      - Optional node: NodeApi<Node>
      Returns boolean | void
Returns void

Generated using TypeDoc