PluginAPI class

Available extensions

PluginAPI$Typings

Annotations

@JS()
@staticInterop
@anonymous

Constructors

PluginAPI.new({String? apiVersion, String? command, EditorType? editorType, Mode? mode, String? pluginId, String? widgetId, String? fileKey, bool? skipInvisibleInstanceChildren, TimerAPI? timer, ViewportAPI? viewport, User? currentUser, List<ActiveUser>? activeUsers, TextReviewAPI? textreview, CodegenAPI? codegen, VSCodeAPI? vscode, DevResourcesAPI? devResources, PaymentsAPI? payments, Uiapi? ui, UtilAPI? util, ConstantsAPI? constants, ClientStorageAPI? clientStorage, ParametersAPI? parameters, VariablesAPI? variables, TeamLibraryAPI? teamLibrary, AnnotationsAPI? annotations, DocumentNode? root, PageNode? currentPage, Symbol? mixed, bool? hasMissingFont, void closePlugin([String?])?, NotificationHandler notify(String, [NotificationOptions?])?, void commitUndo()?, void triggerUndo()?, Future<VersionHistoryResult> saveVersionHistoryAsync(String, [String?])?, void openExternal(String)?, void showUI(String, [ShowUIOptions?])?, Future<Object?> getNodeByIdAsync(String)?, Object? getNodeById(String)?, Future<BaseStyle?> getStyleByIdAsync(String)?, BaseStyle? getStyleById(String)?, Future<void> setCurrentPageAsync(PageNode)?, RectangleNode createRectangle()?, LineNode createLine()?, EllipseNode createEllipse()?, PolygonNode createPolygon()?, StarNode createStar()?, VectorNode createVector()?, TextNode createText()?, FrameNode createFrame()?, ComponentNode createComponent()?, ComponentNode createComponentFromNode(SceneNode)?, PageNode createPage()?, PageNode createPageDivider([String?])?, SliceNode createSlice()?, SlideNode createSlide([num?, num?])?, SlideRowNode createSlideRow([num?])?, StickyNode createSticky()?, ConnectorNode createConnector()?, ShapeWithTextNode createShapeWithText()?, CodeBlockNode createCodeBlock()?, SectionNode createSection()?, TableNode createTable([num?, num?])?, Future<SceneNode> createNodeFromJSXAsync([dynamic])?, BooleanOperationNode createBooleanOperation()?, PaintStyle createPaintStyle()?, TextStyle createTextStyle()?, EffectStyle createEffectStyle()?, GridStyle createGridStyle()?, Future<List<PaintStyle>> getLocalPaintStylesAsync()?, List<PaintStyle> getLocalPaintStyles()?, Future<List<TextStyle>> getLocalTextStylesAsync()?, List<TextStyle> getLocalTextStyles()?, Future<List<EffectStyle>> getLocalEffectStylesAsync()?, List<EffectStyle> getLocalEffectStyles()?, Future<List<GridStyle>> getLocalGridStylesAsync()?, List<GridStyle> getLocalGridStyles()?, dynamic getSelectionColors()?, void moveLocalPaintStyleAfter(PaintStyle, [PaintStyle?])?, void moveLocalTextStyleAfter(TextStyle, [TextStyle?])?, void moveLocalEffectStyleAfter(EffectStyle, [EffectStyle?])?, void moveLocalGridStyleAfter(GridStyle, [GridStyle?])?, void moveLocalPaintFolderAfter(String, [String?])?, void moveLocalTextFolderAfter(String, [String?])?, void moveLocalEffectFolderAfter(String, [String?])?, void moveLocalGridFolderAfter(String, [String?])?, Future<ComponentNode> importComponentByKeyAsync(String)?, Future<ComponentSetNode> importComponentSetByKeyAsync(String)?, Future<BaseStyle> importStyleByKeyAsync(String)?, Future<List<Font>> listAvailableFontsAsync()?, Future<void> loadFontAsync(FontName)?, FrameNode createNodeFromSvg(String)?, Image createImage(Uint8List)?, Future<Image> createImageAsync(String)?, Image? getImageByHash(String)?, Future<Video> createVideoAsync(Uint8List)?, Future<OpaqueNodeMixin> createLinkPreviewAsync(String)?, MediaNode createGif(String)?, ComponentSetNode combineAsVariants(ReadonlyArray<ComponentNode>, Object, [num?])?, GroupNode group(ReadonlyArray<Object>, Object, [num?])?, VectorNode flatten(ReadonlyArray<Object>, [Object?, num?])?, BooleanOperationNode union(ReadonlyArray<Object>, Object, [num?])?, BooleanOperationNode subtract(ReadonlyArray<Object>, Object, [num?])?, BooleanOperationNode intersect(ReadonlyArray<Object>, Object, [num?])?, BooleanOperationNode exclude(ReadonlyArray<Object>, Object, [num?])?, Array<SceneNode> ungroup(Object)?, String base64Encode(Uint8List)?, Uint8List base64Decode(String)?, Future<BaseNodeMixin?> getFileThumbnailNodeAsync()?, BaseNodeMixin? getFileThumbnailNode()?, Future<void> setFileThumbnailNodeAsync([BaseNodeMixin?])?, Future<void> loadAllPagesAsync()?, Array<Array<SlideNode>> getSlideGrid()?, void setSlideGrid(Array<Array<SlideNode>>)?}): factory

Properties

activeUsers → List<ActiveUser>: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
annotations → AnnotationsAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
apiVersion → String: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
base64Decode ↔ Uint8List Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
base64Encode ↔ String Function(Uint8List): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
clientStorage → ClientStorageAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
closePlugin ↔ void Function([String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
codegen → CodegenAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
combineAsVariants ↔ ComponentSetNode Function(ReadonlyArray<ComponentNode>, Object, [num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
command → String: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
commitUndo ↔ void Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
constants → ConstantsAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
createBooleanOperation ↔ BooleanOperationNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createCodeBlock ↔ CodeBlockNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createComponent ↔ ComponentNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createComponentFromNode ↔ ComponentNode Function(SceneNode): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createConnector ↔ ConnectorNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createEffectStyle ↔ EffectStyle Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createEllipse ↔ EllipseNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createFrame ↔ FrameNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createGif ↔ MediaNode Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createGridStyle ↔ GridStyle Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createImage ↔ Image Function(Uint8List): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createImageAsync ↔ Future<Image> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createLine ↔ LineNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createLinkPreviewAsync ↔ Future<OpaqueNodeMixin> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createNodeFromJSXAsync ↔ Future<SceneNode> Function([dynamic]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createNodeFromSvg ↔ FrameNode Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createPage ↔ PageNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createPageDivider ↔ PageNode Function([String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createPaintStyle ↔ PaintStyle Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createPolygon ↔ PolygonNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createRectangle ↔ RectangleNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createSection ↔ SectionNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createShapeWithText ↔ ShapeWithTextNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createSlice ↔ SliceNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createSlide ↔ SlideNode Function([num?, num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createSlideRow ↔ SlideRowNode Function([num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createStar ↔ StarNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createSticky ↔ StickyNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createTable ↔ TableNode Function([num?, num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createText ↔ TextNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createTextStyle ↔ TextStyle Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createVector ↔ VectorNode Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
createVideoAsync ↔ Future<Video> Function(Uint8List): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
currentPage ↔ PageNode: Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
currentUser → User?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
devResources → DevResourcesAPI?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
editorType → EditorType: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
exclude ↔ BooleanOperationNode Function(ReadonlyArray<Object>, Object, [num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
fileKey → String?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
flatten ↔ VectorNode Function(ReadonlyArray<Object>, [Object?, num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getFileThumbnailNode ↔ BaseNodeMixin? Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getFileThumbnailNodeAsync ↔ Future<BaseNodeMixin?> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getImageByHash ↔ Image? Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalEffectStyles ↔ List<EffectStyle> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalEffectStylesAsync ↔ Future<List<EffectStyle>> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalGridStyles ↔ List<GridStyle> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalGridStylesAsync ↔ Future<List<GridStyle>> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalPaintStyles ↔ List<PaintStyle> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalPaintStylesAsync ↔ Future<List<PaintStyle>> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalTextStyles ↔ List<TextStyle> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getLocalTextStylesAsync ↔ Future<List<TextStyle>> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getNodeById ↔ Object? Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getNodeByIdAsync ↔ Future<Object?> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getSelectionColors ↔ dynamic Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getSlideGrid ↔ Array<Array<SlideNode>> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getStyleById ↔ BaseStyle? Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
getStyleByIdAsync ↔ Future<BaseStyle?> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
group ↔ GroupNode Function(ReadonlyArray<Object>, Object, [num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
hasMissingFont → bool: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
importComponentByKeyAsync ↔ Future<ComponentNode> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
importComponentSetByKeyAsync ↔ Future<ComponentSetNode> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
importStyleByKeyAsync ↔ Future<BaseStyle> Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
intersect ↔ BooleanOperationNode Function(ReadonlyArray<Object>, Object, [num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
listAvailableFontsAsync ↔ Future<List<Font>> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
loadAllPagesAsync ↔ Future<void> Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
loadFontAsync ↔ Future<void> Function(FontName): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
mixed → Symbol: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
mode → Mode: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
moveLocalEffectFolderAfter ↔ void Function(String, [String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalEffectStyleAfter ↔ void Function(EffectStyle, [EffectStyle?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalGridFolderAfter ↔ void Function(String, [String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalGridStyleAfter ↔ void Function(GridStyle, [GridStyle?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalPaintFolderAfter ↔ void Function(String, [String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalPaintStyleAfter ↔ void Function(PaintStyle, [PaintStyle?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalTextFolderAfter ↔ void Function(String, [String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
moveLocalTextStyleAfter ↔ void Function(TextStyle, [TextStyle?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
notify ↔ NotificationHandler Function(String, [NotificationOptions?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
off → ({void Function(ArgFreeEventType type, void callback()) $1, void Function(String type, void callback(Object)) $2, void Function(String type, bool callback(DropEvent)) $3, void Function(String type, void callback(DocumentChangeEvent)) $4, void Function(String type, void callback(SlidesViewChangeEvent)) $5, void Function(String type, FutureOr<List<TextReviewRange>> callback(TextReviewEvent)) $6, void Function(String type, void callback(StyleChangeEvent)) $7}): Available on PluginAPI, provided by the PluginAPI$Typings extension
Overload accessor: $1, $2, $3, $4, $5, $6, $7
no setter
on → ({void Function(ArgFreeEventType type, void callback()) $1, void Function(String type, void callback(Object)) $2, void Function(String type, bool callback(DropEvent)) $3, void Function(String type, void callback(DocumentChangeEvent)) $4, void Function(String type, void callback(SlidesViewChangeEvent)) $5, void Function(String type, FutureOr<List<TextReviewRange>> callback(TextReviewEvent)) $6, void Function(String type, void callback(StyleChangeEvent)) $7}): Available on PluginAPI, provided by the PluginAPI$Typings extension
Overload accessor: $1, $2, $3, $4, $5, $6, $7
no setter
once → ({void Function(ArgFreeEventType type, void callback()) $1, void Function(String type, void callback(Object)) $2, void Function(String type, bool callback(DropEvent)) $3, void Function(String type, void callback(DocumentChangeEvent)) $4, void Function(String type, void callback(SlidesViewChangeEvent)) $5, void Function(String type, FutureOr<List<TextReviewRange>> callback(TextReviewEvent)) $6, void Function(String type, void callback(StyleChangeEvent)) $7}): Available on PluginAPI, provided by the PluginAPI$Typings extension
Overload accessor: $1, $2, $3, $4, $5, $6, $7
no setter
openExternal ↔ void Function(String): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
parameters → ParametersAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
payments → PaymentsAPI?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
pluginId → String?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
root → DocumentNode: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
saveVersionHistoryAsync ↔ Future<VersionHistoryResult> Function(String, [String?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
setCurrentPageAsync ↔ Future<void> Function(PageNode): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
setFileThumbnailNodeAsync ↔ Future<void> Function([BaseNodeMixin?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
setSlideGrid ↔ void Function(Array<Array<SlideNode>>): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
showUI ↔ void Function(String, [ShowUIOptions?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
skipInvisibleInstanceChildren ↔ bool: Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
subtract ↔ BooleanOperationNode Function(ReadonlyArray<Object>, Object, [num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
teamLibrary → TeamLibraryAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
textreview → TextReviewAPI?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
timer → TimerAPI?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
triggerUndo ↔ void Function(): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
ui → Uiapi: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
ungroup ↔ Array<SceneNode> Function(Object): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
union ↔ BooleanOperationNode Function(ReadonlyArray<Object>, Object, [num?]): Available on PluginAPI, provided by the PluginAPI$Typings extension

getter/setter pair
util → UtilAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
variables → VariablesAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
viewport → ViewportAPI: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
vscode → VSCodeAPI?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter
widgetId → String?: Available on PluginAPI, provided by the PluginAPI$Typings extension

no setter

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

Static Properties

apiVersion → String: no setter

PluginAPI class

Constructors

Properties

Methods

Operators

Static Properties

figma_plugin_typings library