@express-document-sdk
@express-document-sdk
Namespaces
Namespace
Description
Enumerations
Enumeration
Description
This enum represents the supported editor events.
An enum for controlling the behavior of Node.resize.
Indicates list type: see UnorderedListStyleInput and OrderedListStyleInput.
Numbering types used to display ordered lists: 1, A, a, I, i 01, 001.
<InlineAlert slots="text" variant="warning"/>
Visual effects that can be applied to a text node.
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
Represents a text script style.
Classes
Class
Description
ArtboardList represents an ordered list of ArtboardNodes, which are the children of one PageNode. If multiple artboards are present, each represents a keyframe "scene" in the page's animation timeline.
An ArtboardNode represents the topmost container of visual content within a PageNode. When a page contains multiple artboards, each represents a keyframe "scene" in the page's animation timeline.
A "node" represents an object in the scenegraph, the document's visual content tree. This base class includes only the most fundamental nonvisual properties that even nodes near the top of the document structure share (such as PageNode). The more tangible visual content typically extends the richer Node class which extends BaseNode with additional properties.
Represents a bitmap image resource. Use Editor.loadBitmapImage to create a BitmapImage, and then Editor.createImageContainer to display it in the document by creating a MediaContainerNode structure.
Utility methods for working with color values.
A ComplexShapeNode is a complex prepackaged shape that appears as a leaf node in the UI, even if it is composed of multiple separate paths.
Contains the user's current selection state, indicating the content they are focused on.
Entry point for APIs that read or modify the document's content.
An EllipseNode represents an ellipse or circle shape in the scenegraph.
Contains The Express specific APIs related to the current selection state.
Entry point for Express specific APIs that read or modify the document's content.
An ExpressRootNode represents the root node of the document's "scenegraph" artwork tree. The root contains a collection of pages. Each page contains one or more artboards, which in turn hold all the visual content of the document.
Represents the area of the canvas that is currently visible on-screen.
Base class for a Node that can have its own fill and stroke.
Represents a font that is able to be rendered within this document. However, the user may not have edit permissions for all such fonts.
Font the current user has access or licensing permissions to create / edit content with.
Font the current user does not have access or licensing permissions to create / edit content with.
The Fonts class provides methods to work with fonts.
A read-only view of a mask shape.
A GridCellNode represents the media aspect of a grid cell. Unlike MediaContainerNodes, grid cells cannot be translated or rotated directly and can't modify a mask shape. This implementation translates and rotates the media rectangle child when those actions are applied.
A GridLayoutNode represents a grid layout in the scenegraph. Currently, grids contain only images but in the future they may support other types of content as well.
A GroupNode represents a Group object in the scenegraph, which has a collection of generic children as well as a separate, optional vector mask child.
ImageRectangleNode is a rectangular node that displays the image media part of a MediaContainerNode. It can only exist within that container parent. Cropping can be adjusted by changing this rectangle's position/rotation (as well as its maskShape sibling node).
ItemList represents an ordered list of API objects that are all children of the same parent node. It is most frequently encountered as ArtboardNode.children or GroupNode.children.
A LineNode represents a simple vector line in the scenegraph – a single straight-line segment.
A MediaContainerNode is a multi-node construct that displays media (such as images or video) with optional cropping and clipping to a shape mask. The underlying media asset is always rectangular, but the final appearance of this node is determined by the maskShape which is not necessarily a rectangle.
MediaRectangleNode is the base class for a rectangular node that represents the uncropped media within a MediaContainerNode. Specific subclasses such as ImageRectangleNode exist for each media type and may provide additional media-specific APIs. Cropping can be adjusted by changing this rectangle's position/rotation (as well as its maskShape sibling node).
A Node represents an object in the scenegraph, the document's visual content tree. Most tangible visual content is a subclass of Node, but note that some abstract top-level structural nodes (such as PageNode) only extend the more minimal VisualNode or BaseNode. As a general rule, if you can click or drag an object with the select/move tool in the UI, then it extends from Node.
PageList represents an ordered list of PageNodes, all of which are children of the root node of the document's "scenegraph" artwork tree (see ExpressRootNode). A page contains one or more artboards, representing "scenes" in a linear timeline sequence. Those artboards, in turn, contain all the visual content of the document.
A PageNode represents a page in the document, a child of the root node of the document's "scenegraph" artwork tree (see ExpressRootNode). A page contains one or more artboards, which in turn contain all the page's visual content. If multiple artboards are present, each represents a keyframe "scene" in the page's animation timeline.
A PathNode represents a generic vector path shape in the scenegraph. Paths cannot be edited through this API yet, only read.
ReadOnlyItemList represents an ordered list of API objects that are all children of the same parent node.
A RectangleNode represents a rectangle shape in the scenegraph.
Base for ItemLists that restrict how items are added to the list, but freely allow items to be removed and reordered. The ItemList subclass adds more capabilities, however.
A SolidColorShapeNode is a prepackaged shape with a single color property that appears as a leaf node in the UI, even if it is composed of multiple separate paths.
StandaloneTextContentModel represents a complete piece of text content contained within a single StandaloneTextNode.
A StandaloneTextNode represents text that is displayed entirely within one single frame in the scenegraph (in contrast to ThreadedTextNode, where text may flow across several separate display "frames"). The StandaloneTextNode does not directly hold the text content and styles – instead it refers to a TextNodeContentModel.
Base class for a Node that can have its own stroke.
A StrokeShapeNode is prepackaged shape that has a single stroke property and appears as a leaf node in the UI, even if it is composed of multiple separate paths.
TextContentModel is an abstract base class representing a complete piece of text content. Use this model to get or modify the text string and the style ranges applied to it.
Represents a complete piece of text content, which may be contained within a single StandaloneTextNode or split across multiple ThreadedTextNode frames for display. Use this model to get or modify the text string and the style ranges applied to it.
TextNode is an abstract base class representing text displayed in the scenegraph, regardless of whether it's a fully self-contained StandaloneTextNode or one of multiple ThreadedTextNode "frames" in a larger flow. The APIs on TextNode and its TextNodeContentModel allow you to generically work with text without needing to know which subtype you are dealing with.
ThreadedTextContentModel represents a complete piece of text content that is split across multiple ThreadedTextNode frames for display. This subclass provides a mutable allFrames list that supports adding, removing, and reordering text frames.
ReadOnlyItemList represents an ordered list of API objects that are all children of the same parent node.
A ThreadedTextNode represents a text display frame in the scenegraph which is a subset of longer text that flows across multiple such "frames". Because of this, the TextNode does not directly hold the text content and styles – instead it refers to a TextNodeContentModel, which may be shared across multiple ThreadedTextNode frames.
UnknownMediaRectangleNode is a rectangular node that represents the uncropped media within a MediaContainerNode for cases where the media type is not yet supported by this API. Cropping can still be adjusted by changing this rectangle's position/rotation (as well as its maskShape sibling node).
An UnknownNode is a node with limited support and therefore treated as a leaf node.
A "node" represents an object in the scenegraph, the document's visual content tree. This class represents any node that can be visually perceived in the content. Most visual content is a subclass of the richer Node class which extends VisualNode with more properties, but the overall ArtboardNode container only supports the VisualNode APIs (and higher-level more abstract containers like PageNode extend only the minimal BaseNode class).
AddOnData class provides APIs to read, write, remove private metadata to a Node. This metadata is accessible only to the add-on that has set it.
Interfaces
Interface
Description
<InlineAlert slots="text" variant="warning"/>
Text styles that can be applied to any range of characters, even a short span like a single word. (Contrast with ParagraphStyles, which must be applied to an entire paragraph atomically).
Variant of CharacterStyles with all style fields optional, used for applyCharacterStyles(). When using that API, any fields not specified are left unchanged, preserving the text's existing styles.
Variant of CharacterStylesRange with all style fields optional, along with the range of characters they apply to. Used for the characterStyleRanges setter. When invoking the setter, any fields not specified are reset to their defaults.
A set of CharacterStyles along with the range of characters they apply to. Seen in the characterStyleRanges getter.
Represents an RGBA color value.
Interface for any node that contains an entirely generic collection of children. Some ContainerNode classes may host additional children in other specific "slots," such as background or mask layers; and non-ContainerNode classes may also hold children in specified "slots." Use Node.allChildren for read access to children regardless of node type.
Base interface representing any fill in the scenegraph. See FillableNode. Currently, you can only create ColorFills, but you might encounter other fill types when reading scenegraph content.
Represents a solid-color fill.
Interface for FillableNode and any other nodes with a similar
fill property that do not directly inherit from the FillableNode class.<InlineAlert slots="text" variant="warning"/>
Interface for nodes that contain media.
An interface for arbitrary resize operations regardless of whether given a width or height when using Node.resize.
An interface for rescaling the node based on a given width when using Node.resize.
An interface for rescaling the node based on a given height when using Node.resize.
An interface for resizing the node based on a given width when using Node.resize.
An interface for resizing the node based on a given height when using Node.resize.
An interface for the bounds of a Node.
Base paragraph styles that can be applied to an entire paragraph atomically. Excludes list style settings, which differ between the getter-oriented ParagraphStyles interface and the setter-oriented ParagraphStylesRangeInput.
Text styles that must be applied to an entire paragraph atomically. (Contrast with CharacterStyles which can be applied to any range of characters, even a short span like one single word).
A variant of ParagraphStyles with all style fields optional, used for applyParagraphStyles(). When using that API, any fields not specified are left unchanged, preserving the text's existing styles.
A variant of ParagraphStylesRange with all style fields optional, along with the text range they apply to. Used for the paragraphStyleRanges setter. When invoking the setter, any fields not specified are reset to their defaults.
A set of ParagraphStyles along with the text range they apply to. Returned by the paragraphStyleRanges getter.
Interface for specifying an ordered list style, such as a numbered list.
Interface for specifying an unordered list style, such as a bullet list.
Interface for removing a list style.
Interface for nodes with width and height properties.
Interface for StrokableNode and any other nodes with a similar
stroke property that do not directly inherit from the StrokableNode class. (See ArtboardNode, for example).Base interface representing any stroke in the scenegraph. See StrokableNode. Currently, you can only create SolidColorStrokes, but you might encounter other stroke types when reading from scenegraph content.
Represents a solid-color stroke, with optional dashes.
A range of text in a TextContentModel, specified in characters.
Auto-width, aka point text: both width and height are automatically determined based on the content. There is no automatic line wrapping, so the text will all be on one line unless the text contains explicit newlines.
Auto-height text: Width is explicitly set, and text wraps to use as much vertical space as necessary to display the full content.
Area text: both width and height are explicitly set. If text content is too long to fit, the end of the text will be clipped. If text content is short, the frame's bounds will occupy extra height that is just blank space.
Represents a text layout the API does not yet support setting or reading the details of.
<InlineAlert slots="text" variant="warning"/>
<InlineAlert slots="text" variant="warning"/>
An interface for the bounds of a VisualNode.
-
Represents a 2D position.
Represents a range of characters defined by a length (and implicitly started at the end of the previous range).
Geometry for an area text frame in pixels.
Type Aliases
Type Alias
Description
This type represents function signature for the editor event handler callback.
This type represents unique id of each event handler callback that is registered.
Represents a font in the document.
A type union for providing the necessary arguments to Node.resize.
OrderedListStyle represents the style of an ordered list.
UnorderedListStyle represents the style of an unordered list.
SolidColorStroke with 'type' property as optional.