FigmaQuery class

A wrapper that wraps all available query values for the Figma API.

Constructors

FigmaQuery({List<String>? ids, double? scale, String? format, String? version, int? depth, String? geometry, bool? svgIncludeId, bool? svgSimplifyStroke, bool? useAbsoluteBounds, int? pageSize, Map<String, int>? cursor, String? pluginData})

const

Properties

cursor → Map<String, int>?

A map that indicates the starting/ending point from which objects are returned. The cursor value is an internally tracked integer that doesn't correspond to any IDs.

final

depth → int?

Positive integer representing how deep into the document tree to traverse. For example, setting this to 1 returns only Pages, setting it to 2 returns Pages and all top level objects on each page. Not setting this parameter returns all nodes.

final

format → String?

A string enum for the image output format, can be jpg, png, svg, or pdf.

final

geometry → String?

Set to "paths" to export vector data.

final

hashCode → int

The hash code for this object.

no setter, inherited

ids → List<String>?

Comma separated list of nodes that you care about in the document. If specified, only a subset of the document will be returned corresponding to the nodes listed, their children, and everything between the root node and the listed nodes.

final

pageSize → int?

Number of items in a paged list of results. Defaults to 30.

final

params → Map<String, String?>

no setter

pluginData → String?

A comma separated list of plugin IDs and/or the string "shared". Any data present in the document written by those plugins will be included in the result in the pluginData and sharedPluginData properties.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scale → double?

A number between 0.01 and 4, the image scaling factor.

final

svgIncludeId → bool?

Whether to include id attributes for all SVG elements. Default: false.

final

svgSimplifyStroke → bool?

Whether to simplify inside/outside strokes and use stroke attribute if possible instead of

final

useAbsoluteBounds → bool?

Use the full dimensions of the node regardless of whether or not it is cropped or the space around it is empty. Use this to export text nodes without cropping. Default: false.

final

version → String?

A specific version ID to get. Omitting this will get the current version of the file.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited