diff --git a/src/pages/references/changelog.md b/src/pages/references/changelog.md index 59b732e84..50035a3ac 100644 --- a/src/pages/references/changelog.md +++ b/src/pages/references/changelog.md @@ -25,6 +25,45 @@ contributors: # Changelog +## 2025-10-08 + +### Added + +- **Experimental** [`rescaleProportionalToHeight()`](../references/document-sandbox/document-apis/classes/Node.md#rescaleproportionaltoheight) method - Proportional height scaling for all node types +- **Experimental** [`rescaleProportionalToWidth()`](../references/document-sandbox/document-apis/classes/Node.md#rescaleproportionaltowidth) method - Proportional width scaling for all node types +- **Experimental** [`resizeToCover()`](../references/document-sandbox/document-apis/classes/Node.md#resizetocover) method - Resize nodes to cover specified dimensions +- **Experimental** [`resizeToFitWithin()`](../references/document-sandbox/document-apis/classes/Node.md#resizetofitwithin) method - Resize nodes to fit within specified dimensions +- **Experimental** [`appendText()`](../references/document-sandbox/document-apis/classes/TextContentModel.md#appendtext) method - Append text to existing content +- **Experimental** [`deleteText()`](../references/document-sandbox/document-apis/classes/TextContentModel.md#deletetext) method - Delete text ranges from content +- **Experimental** [`insertText()`](../references/document-sandbox/document-apis/classes/TextContentModel.md#inserttext) method - Insert text at specific positions +- **Experimental** [`replaceText()`](../references/document-sandbox/document-apis/classes/TextContentModel.md#replacetext) method - Replace text ranges with new content +- **Experimental** [`hasUnavailableFonts()`](../references/document-sandbox/document-apis/classes/TextContentModel.md#hasunavailablefonts) method - Check for unavailable fonts in text content +- **Experimental** [`id`](../references/document-sandbox/document-apis/classes/TextContentModel.md#id) property - Unique identifier for text content models +- **Experimental** [`TextStyleSource`](../references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md) enumeration - Options for text style source matching + +### Updated + +- [`cloneInPlace()`](../references/document-sandbox/document-apis/classes/Node.md#cloneinplace) method **promoted from experimental to stable** - Available on all node types for creating copies with subtrees +- [`paragraphStyleRanges`](../references/document-sandbox/document-apis/classes/TextContentModel.md#paragraphstyleranges) property **promoted from experimental to stable** - Get/set paragraph-level styles with ranges +- [`applyParagraphStyles()`](../references/document-sandbox/document-apis/classes/TextContentModel.md#applyparagraphstyles) method **promoted from experimental to stable** - Apply styles to specific paragraph ranges +- [`layout`](../references/document-sandbox/document-apis/classes/StandaloneTextNode.md#layout) property **promoted from experimental to stable** - Control text layout modes for standalone text +- [`layout`](../references/document-sandbox/document-apis/classes/ThreadedTextNode.md#layout) property **promoted from experimental to stable** - Control text layout modes for threaded text +- [`AreaTextLayout`](../references/document-sandbox/document-apis/interfaces/AreaTextLayout.md) interface **promoted from experimental to stable** - Fixed width and height text layout configuration +- [`AutoHeightTextLayout`](../references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md) interface **promoted from experimental to stable** - Auto-height text layout configuration +- [`AutoWidthTextLayout`](../references/document-sandbox/document-apis/interfaces/AutoWidthTextLayout.md) interface **promoted from experimental to stable** - Auto-width text layout configuration +- [`UnsupportedTextLayout`](../references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md) interface **promoted from experimental to stable** - Representation of unsupported text layouts +- [`ParagraphStyles`](../references/document-sandbox/document-apis/interfaces/ParagraphStyles.md) interface **promoted from experimental to stable** - Complete paragraph style definitions +- [`ParagraphStylesInput`](../references/document-sandbox/document-apis/interfaces/ParagraphStylesInput.md) interface **promoted from experimental to stable** - Input interface for paragraph styles +- [`ParagraphStylesRange`](../references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md) interface **promoted from experimental to stable** - Paragraph styles with text ranges +- [`ParagraphStylesRangeInput`](../references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md) interface **promoted from experimental to stable** - Input interface for paragraph style ranges +- [`BaseParagraphStyles`](../references/document-sandbox/document-apis/interfaces/BaseParagraphStyles.md) interface **promoted from experimental to stable** - Base paragraph style properties +- [`OrderedListStyleInput`](../references/document-sandbox/document-apis/interfaces/OrderedListStyleInput.md) interface **promoted from experimental to stable** - Configuration for ordered lists +- [`UnorderedListStyleInput`](../references/document-sandbox/document-apis/interfaces/UnorderedListStyleInput.md) interface **promoted from experimental to stable** - Configuration for unordered lists +- [`OrderedListStyle`](../references/document-sandbox/document-apis/type-aliases/OrderedListStyle.md) type **promoted from experimental to stable** - Type definition for ordered list styles +- [`UnorderedListStyle`](../references/document-sandbox/document-apis/type-aliases/UnorderedListStyle.md) type **promoted from experimental to stable** - Type definition for unordered list styles +- [`OrderedListNumbering`](../references/document-sandbox/document-apis/namespaces/Constants/enumerations/OrderedListNumbering.md) enumeration **promoted from experimental to stable** - Numbering types for ordered lists +- [`ParagraphListType`](../references/document-sandbox/document-apis/namespaces/Constants/enumerations/ParagraphListType.md) enumeration **promoted from experimental to stable** - List type enumeration with `none` value added + ## 2025-10-02 ### Added diff --git a/src/pages/references/document-sandbox/document-apis/classes/AddOnData.md b/src/pages/references/document-sandbox/document-apis/classes/AddOnData.md index 402b4a34b..7f46b57ce 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/AddOnData.md +++ b/src/pages/references/document-sandbox/document-apis/classes/AddOnData.md @@ -18,8 +18,8 @@ This metadata is accessible only to the add-on that has set it. an object with the remaining quota for private metadata on the node for this add-on. The object contains the following properties: -- sizeInBytes: The remaining quota size in bytes (maximum 3KB). -- numKeys: The remaining quota for the number of keys (maximum 20 keys). +- `sizeInBytes`: The remaining quota size in bytes (maximum 3KB). +- `numKeys`: The remaining quota for the number of keys (maximum 20 keys). ##### numKeys diff --git a/src/pages/references/document-sandbox/document-apis/classes/ArtboardList.md b/src/pages/references/document-sandbox/document-apis/classes/ArtboardList.md index bf945ad3a..5e5120630 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ArtboardList.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ArtboardList.md @@ -2,8 +2,8 @@ # Class: ArtboardList -ArtboardList represents an ordered list of ArtboardNodes arranged in a timeline sequence, where they are called "scenes." -All items in the list are children of a single [PageNode](PageNode.md). +ArtboardList represents an ordered list of ArtboardNodes, which are the children of one [PageNode](PageNode.md). If multiple +artboards are present, each represents a keyframe "scene" in the page's animation timeline. ArtboardList also provides APIs for adding/removing artboards from the page. ArtboardList is never empty: it is illegal to remove the last remaining artboard from the list. diff --git a/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md b/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md index fd948cc3e..c981e0dfe 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md @@ -2,14 +2,11 @@ # Class: ArtboardNode -An ArtboardNode represents an artboard object in the scenegraph. All user visual content must be contained on an artboard. -Artboards are always contained on a [PageNode](PageNode.md); when a page contains multiple artboards, the artboards represent -"scenes" in a linear timeline sequence. +An ArtboardNode represents the topmost container of visual content within a [PageNode](PageNode.md). When a page contains +multiple artboards, each represents a keyframe "scene" in the page's animation timeline. To create a new artboard, see [ArtboardList.addArtboard](ArtboardList.md#addartboard). -Please note that creating and deleting an artboard in a single frame will crash the editor. - ## Extends - [`VisualNode`](VisualNode.md) @@ -42,7 +39,7 @@ GroupNode also provide a mutable [ContainerNode.children](../interfaces/Containe hold children in various discrete "slots"; this `allChildren` list includes *all* such children and reflects their overall display z-order. -The children of an Artboard are always other Node classes (never the more minimal BaseNode). +The children of an Artboard are all subclasses of Node (not just the more minimal BaseNode or VisualNode). #### Returns @@ -83,7 +80,9 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c • `get` **children**(): [`ItemList`](ItemList.md)<[`Node`](Node.md)\> -The node's children. Use the methods on this ItemList object to get, add, and remove children. +The artboards's regular children (does not include any "background layer" content if present; use [allChildren](ArtboardNode.md#allchildren) +for a read-only view that includes background content). Use the methods on this `children` ItemList object to get, +add, and remove regular children. #### Returns diff --git a/src/pages/references/document-sandbox/document-apis/classes/BitmapImage.md b/src/pages/references/document-sandbox/document-apis/classes/BitmapImage.md index 1a0ed5598..fd7094de7 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/BitmapImage.md +++ b/src/pages/references/document-sandbox/document-apis/classes/BitmapImage.md @@ -2,8 +2,7 @@ # Class: BitmapImage -Represents a bitmap image resource. Use [Editor.loadBitmapImage](Editor.md#loadbitmapimage) to create a BitmapImage, and then [Editor.createImageContainer](Editor.md#createimagecontainer) -to display it in the document by creating a MediaContainerNode structure. +Represents a bitmap image resource. Use [Editor.loadBitmapImage](Editor.md#loadbitmapimage) to create a BitmapImage, and then [Editor.createImageContainer](Editor.md#createimagecontainer) to display it in the document by creating a MediaContainerNode structure. ## Accessors diff --git a/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md b/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md index df106a680..2f7f9aa2b 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md @@ -338,10 +338,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`ComplexShapeNode`](ComplexShapeNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/Context.md b/src/pages/references/document-sandbox/document-apis/classes/Context.md index a06d5499e..652ce8413 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Context.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Context.md @@ -15,6 +15,7 @@ Contains the user's current selection state, indicating the content they are foc [`PageNode`](PageNode.md) The currently viewed page. +To change the current page, call [Viewport.bringIntoView](Viewport.md#bringintoview) with an artboard or other content on that page. --- @@ -68,7 +69,8 @@ Only node(s) that meet the following criteria can be selected: readonly [`Node`](Node.md)[] -the current selection. Nodes that are locked or otherwise non-editable are never included in the selection. +the current selection. Nodes that are locked or otherwise non-editable are never included in the regular +selection (see [selectionIncludingNonEditable](Context.md#selectionincludingnoneditable) to get any locked nodes the user may have clicked). --- @@ -115,6 +117,7 @@ Callback that was previously registered will be removed and will no more be invo Registers a handler for editor events such as selection change. The registered callback will be invoked when the specified event occurs. + Note: Do not attempt to make changes to the document in response to a selection change callback because it may destabilize the application. #### Parameters diff --git a/src/pages/references/document-sandbox/document-apis/classes/Editor.md b/src/pages/references/document-sandbox/document-apis/classes/Editor.md index 1dcaa332b..4e0a9330f 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Editor.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Editor.md @@ -69,15 +69,17 @@ This local client will act as having unsaved changes until the upload has finish #### Parameters -• **bitmapData**: [`BitmapImage`](BitmapImage.md) +• **bitmapData**: `BitmapImage` BitmapImage resource (e.g. returned from [loadBitmapImage](Editor.md#loadbitmapimage)). • **options**= `{}` -Additional configuration: - initialSize - Size the image is displayed at. Must have the same aspect ratio as bitmapData. Defaults to the -size the image would be created at by a UI drag-drop gesture (typically the image's full size, but scaled down -if needed to stay below an application-defined size cap). +Additional configuration: + +- `initialSize` - Size the image is displayed at. Must have the same aspect ratio as `bitmapData`. Defaults to the + size the image would be created at by a UI drag-drop gesture (typically the image's full size, but scaled down + if needed to stay below an application-defined size cap). • **options.initialSize?**: [`RectangleGeometry`](../interfaces/RectangleGeometry.md) @@ -115,6 +117,11 @@ Note that the path data will be normalized, and therefore the `path` getter may For example, "M 10 80 Q 52.5 10, 95 80 T 180 80" becomes "M 10 80 C 38.33 33.33 66.67 33.33 95 80...". Throws if the input is empty or is not legal SVG path syntax. + + +Note: the visual top-left corner of a path may not be its local (0,0) origin point, so it's easiest to position +a newly created path using [Node.setPositionInParent](Node.md#setpositioninparent) rather than setting [Node.translation](Node.md#translation) directly. + #### Returns [`PathNode`](PathNode.md) @@ -171,6 +178,8 @@ the initial string to show. a text node with default styles. Creates auto-width text, so the node's width will automatically adjust to accommodate the given text content. + + Note: the registration point of this text node is not guaranteed to be at the top-left of the bounding box of its insertion parent. Recommend using `setPositionInParent` over `translation` to set the position. @@ -178,7 +187,7 @@ insertion parent. Recommend using `setPositionInParent` over `translation` to se ### loadBitmapImage() -• **loadBitmapImage**(`bitmapData`): `Promise`<[`BitmapImage`](BitmapImage.md)\> +• **loadBitmapImage**(`bitmapData`): `Promise`<`BitmapImage`\> Creates a bitmap image resource in the document, which can be displayed in the scenegraph by passing it to [createImageContainer](Editor.md#createimagecontainer) to create a MediaContainerNode. The same BitmapImage can be used to create multiple MediaContainerNodes. @@ -198,7 +207,7 @@ Encoded image data in PNG or JPEG format. #### Returns -`Promise`<[`BitmapImage`](BitmapImage.md)\> +`Promise`<`BitmapImage`\> --- diff --git a/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md b/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md index 597f449b1..a0af62aa2 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md @@ -381,10 +381,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`EllipseNode`](EllipseNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/ExpressRootNode.md b/src/pages/references/document-sandbox/document-apis/classes/ExpressRootNode.md index e5e52fbe2..36c244281 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ExpressRootNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ExpressRootNode.md @@ -3,8 +3,7 @@ # Class: ExpressRootNode An ExpressRootNode represents the root node of the document's "scenegraph" artwork tree. The root contains a collection -of [pages](ExpressRootNode.md#pages). Each page contains one or more artboards, arranged in a timeline sequence. All the visual content of -the document lies within those artboards. +of [pages](ExpressRootNode.md#pages). Each page contains one or more artboards, which in turn hold all the visual content of the document. The parent of ExpressRootNode is undefined, since it is the root of the document tree. diff --git a/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md b/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md index a29014a41..21b8c098d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md @@ -348,10 +348,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`FillableNode`](FillableNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md b/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md index e6573d5f2..cefac9e92 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md @@ -331,10 +331,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): `never` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Always throws as it's not possible to clone a single grid slot. Use the parent grid container instead. @@ -403,9 +399,9 @@ or top/bottom edges. Currently only supports images as the new media, but previo #### Parameters -• **media**: [`BitmapImage`](BitmapImage.md) +• **media**: `BitmapImage` -New content to display. Currently must be a [BitmapImage](BitmapImage.md). +New content to display. Currently must be a BitmapImage. #### Returns diff --git a/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md b/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md index e4fc4410e..8791e4060 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md @@ -2,8 +2,8 @@ # Class: GridLayoutNode -A GridLayoutNode represents a grid layout in the scenegraph. The GridLayoutNode is used to create -a layout grid that other content can be placed into. +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. APIs to create a new grid layout are not yet available. @@ -33,9 +33,8 @@ Get [AddOnData](AddOnData.md) reference for managing the private metadata on thi • `get` **allChildren**(): `Readonly`<`Iterable`<[`GridCellNode`](GridCellNode.md), `any`, `any`\>\> -The Grid's regular children. Does not include rectangles and skips over media constainer nodes to return fill grandchildren. -Grid Cells are ordered by the y and then x position of their top left corner, i.e. left to right and top to bottom. -The children cannot be added or removed. +The GridLayout's child nodes. Nodes are returned in order sorted by the y and then x position of their top left +corner, i.e. left to right and top to bottom. These children cannot be added or removed. #### Returns @@ -113,7 +112,7 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c • `set` **fill**(`fill`): `void` -The background fill of the GridLayout. +The background fill of the GridLayout. GridLayouts must always have a fill. #### Parameters @@ -129,7 +128,7 @@ The background fill of the GridLayout. • `get` **height**(): `number` -The height of the node. +The height of the entire GridLayout node. Must be at least MIN_DIMENSION. • `set` **height**(`value`): `void` @@ -318,7 +317,7 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s • `get` **width**(): `number` -The width of the node. +The width of the entire GridLayout node. Must be at least MIN_DIMENSION. • `set` **width**(`value`): `void` @@ -359,10 +358,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`GridLayoutNode`](GridLayoutNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md b/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md index 5837eaf38..8b51ebd6b 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md @@ -96,6 +96,8 @@ The top-left corner of the bounding box corresponds to the visual top-left corne `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: If this group has a maskShape, group's bounds are always identical to the maskShape's, regardless of the group's other content. @@ -117,8 +119,8 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c • `get` **children**(): [`ItemList`](ItemList.md)<[`Node`](Node.md)\> -The Group's regular children. Does not include the maskShape if one is present. -Use the methods on this ItemList object to get, add, and remove children. +The Group's regular children. Does not include the [maskShape](GroupNode.md#maskshape) if one is present. +Use the methods on this ItemList object to get, add, and remove regular children. #### Returns @@ -350,10 +352,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`GroupNode`](GroupNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md b/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md index adb215dc9..6b045089a 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md @@ -163,6 +163,10 @@ expectations before doing so. Get [AddOnData](AddOnData.md) reference for managing private metadata attached to the media resource displayed by this node. The same media resource may be reused in multiple places in the document, and all share the same AddOnData state. + + +Note: This support is not present for PSD (Photoshop Document) / AI (Adobe Illustrator) assets. An error will be thrown in that case. + #### Returns [`AddOnData`](AddOnData.md) @@ -345,10 +349,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): `never` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Always throws as it's not possible to clone just the media rectangle alone. Clone the entire parent MediaContainerNode instead. diff --git a/src/pages/references/document-sandbox/document-apis/classes/ItemList.md b/src/pages/references/document-sandbox/document-apis/classes/ItemList.md index 63fc3cce7..888bd1ce9 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ItemList.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ItemList.md @@ -2,13 +2,13 @@ # Class: ItemList -ItemList represents an ordered list of API objects, representing items that are all children of the -same parent node. (The reverse is not necessarily true, however: this list might not include all -children that exist in the parent node. See [Node.allChildren](Node.md#allchildren) for details). +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](ArtboardNode.md#children) or [GroupNode.children](GroupNode.md#children). ItemList also provides APIs for manipulating the list by adding items to the parent or removing items from the parent. -This class is used in different places for various types of items, including Nodes, Fills, and Strokes. +Note that some parent nodes may have additional children that are *not* present in the main `children` ItemList +(e.g. [GroupNode.maskShape](GroupNode.md#maskshape)). Use the read-only [Node.allChildren](Node.md#allchildren) for a combined view of all children. ## Extends @@ -16,7 +16,7 @@ This class is used in different places for various types of items, including Nod ## Type parameters -• **T** _extends_ [`ListItem`](../interfaces/ListItem.md) +• **T** *extends* [`ListItem`](../interfaces/ListItem.md) ## Accessors @@ -77,7 +77,7 @@ Iterates over all the items in this list. Mutations that occur mid-iteration are • **append**(...`items`): `void` Add one or more items to the end of the list. The last argument will become the last item in this list. Items are -removed from their previous parent, if any – or if an item is already in _this_ list, its index is simply changed. +removed from their previous parent, if any – or if an item is already in *this* list, its index is simply changed. #### Parameters @@ -87,10 +87,6 @@ removed from their previous parent, if any – or if an item is already in _this `void` -#### Throws - -- if item has a different parent and item is a [ThreadedTextNode](ThreadedTextNode.md), or if item's children subtree contains a [ThreadedTextNode](ThreadedTextNode.md). - --- ### clear() @@ -133,7 +129,7 @@ index number, or -1 if item isn't in this list. Insert `newItem` so it is immediately after `after` in this list: places `newItem` at the index one higher than `after`, shifting all later items to higher indices (the index of `after` remains unchanged). `newItem` is removed from its previous parent, -if any – or if it's already in _this_ list, its index is simply changed. No-op if both arguments are the same item. +if any – or if it's already in *this* list, its index is simply changed. No-op if both arguments are the same item. #### Parameters @@ -145,10 +141,6 @@ if any – or if it's already in _this_ list, its index is simply changed. No-op `void` -#### Throws - -- if newItem has a different parent and it is a [ThreadedTextNode](ThreadedTextNode.md), or if newItem's children subtree contains a [ThreadedTextNode](ThreadedTextNode.md). - --- ### insertBefore() @@ -157,7 +149,7 @@ if any – or if it's already in _this_ list, its index is simply changed. No-op Insert `newItem` so it is immediately before `before` in this list: places `newItem` at the index that `before` used to occupy, shifting `before` and all later items to higher indices. `newItem` is removed from its previous parent, -if any – or if it's already in _this_ list, its index is simply changed. No-op if both arguments are the same item. +if any – or if it's already in *this* list, its index is simply changed. No-op if both arguments are the same item. #### Parameters @@ -169,10 +161,6 @@ if any – or if it's already in _this_ list, its index is simply changed. No-op `void` -#### Throws - -- if newItem has a different parent and it is a [ThreadedTextNode](ThreadedTextNode.md), or if newItem's children subtree contains a [ThreadedTextNode](ThreadedTextNode.md). - --- ### item() @@ -282,7 +270,7 @@ If any of the items are not in the list, or if it is illegal to remove any of th • **replace**(`oldItem`, `newItem`): `void` Replace `oldItem` with `newItem` in this list. Throws if `oldItem` is not a member of this list. -`newItem` is removed from its previous parent, if any – or if it's already in _this_ list, its index is simply +`newItem` is removed from its previous parent, if any – or if it's already in *this* list, its index is simply changed. No-op if both arguments are the same item. #### Parameters @@ -295,10 +283,6 @@ changed. No-op if both arguments are the same item. `void` -#### Throws - -- if newItem has a different parent and newItem is a [ThreadedTextNode](ThreadedTextNode.md), or if newItem's children subtree contains a [ThreadedTextNode](ThreadedTextNode.md). - --- ### toArray() diff --git a/src/pages/references/document-sandbox/document-apis/classes/LineNode.md b/src/pages/references/document-sandbox/document-apis/classes/LineNode.md index 1c258dcd9..28fc80846 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/LineNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/LineNode.md @@ -447,10 +447,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`LineNode`](LineNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md b/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md index 7da444405..7b7c9705d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md @@ -336,10 +336,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`MediaContainerNode`](MediaContainerNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. @@ -409,9 +405,9 @@ or top/bottom edges. Currently only supports images as the new media, but previo #### Parameters -• **media**: [`BitmapImage`](BitmapImage.md) +• **media**: `BitmapImage` -New content to display. Currently must be a [BitmapImage](BitmapImage.md). +New content to display. Currently must be a BitmapImage. #### Returns diff --git a/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md b/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md index 34e0dd5f5..3e92c5053 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md @@ -170,6 +170,10 @@ expectations before doing so. Get [AddOnData](AddOnData.md) reference for managing private metadata attached to the media resource displayed by this node. The same media resource may be reused in multiple places in the document, and all share the same AddOnData state. + + +Note: This support is not present for PSD (Photoshop Document) / AI (Adobe Illustrator) assets. An error will be thrown in that case. + #### Returns [`AddOnData`](AddOnData.md) @@ -352,10 +356,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): `never` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Always throws as it's not possible to clone just the media rectangle alone. Clone the entire parent MediaContainerNode instead. diff --git a/src/pages/references/document-sandbox/document-apis/classes/Node.md b/src/pages/references/document-sandbox/document-apis/classes/Node.md index 5f86513c6..0d4664fbe 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Node.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Node.md @@ -320,10 +320,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`Node`](Node.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/PageNode.md b/src/pages/references/document-sandbox/document-apis/classes/PageNode.md index 19bf93013..294f9ba8e 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/PageNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/PageNode.md @@ -3,8 +3,8 @@ # Class: PageNode A PageNode represents a page in the document, a child of the root node of the document's "scenegraph" artwork tree -(see [ExpressRootNode](ExpressRootNode.md)). 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. +(see [ExpressRootNode](ExpressRootNode.md)). 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. To create new pages, see [PageList.addPage](PageList.md#addpage). @@ -52,7 +52,8 @@ to guarantee all their children are full-fledged Node instances. • `get` **artboards**(): [`ArtboardList`](ArtboardList.md) -The artboards or "scenes" of a page, ordered by timeline sequence. +The artboards or "scenes," which hold the page's visual contents. If multiple artboards are present, this list +represents an ordered keyframe sequence in the page's animation timeline. To create new artboards, see [ArtboardList.addArtboard](ArtboardList.md#addartboard). #### Returns @@ -70,6 +71,7 @@ The height of the node. All Artboards within a page share the same dimensions, so changing this value will also automatically adjust the size of every child [ArtboardNode](ArtboardNode.md). + Note: changing the page's size does not adjust the size or position of any of visual content inside any child [ArtboardNode](ArtboardNode.md). Callers should use their own layout logic to update the content for the new bounds as desired. For example, making the size smaller could result in content being clipped and hard to access if it is @@ -158,6 +160,7 @@ The width of the node. All Artboards within a page share the same dimensions, so changing this value will also automatically adjust the size of every child [ArtboardNode](ArtboardNode.md). + Note: changing the page's size does not adjust the size or position of any of visual content inside any child [ArtboardNode](ArtboardNode.md). Callers should use their own layout logic to update the content for the new bounds as desired. For example, making the size smaller could result in content being clipped and hard to access if it is diff --git a/src/pages/references/document-sandbox/document-apis/classes/PathNode.md b/src/pages/references/document-sandbox/document-apis/classes/PathNode.md index 72c95faf1..7bd558fa9 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/PathNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/PathNode.md @@ -7,6 +7,11 @@ yet, only read. To create new paths, see [Editor.createPath](Editor.md#createpath). + + +Note: the visual top-left corner of a path may not be its local (0,0) origin point, so it's easiest to position +a path using [Node.setPositionInParent](Node.md#setpositioninparent) rather than setting its [Node.translation](Node.md#translation) directly. + ## Extends - [`FillableNode`](FillableNode.md) @@ -373,10 +378,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`PathNode`](PathNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md b/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md index b9a9fa6f2..874e7a11a 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md @@ -2,11 +2,10 @@ # Class: ReadOnlyItemList -ReadOnlyItemList represents an ordered list of API objects, representing items that are all children of the -same parent node. (The reverse is not necessarily true, however: this list might not include all -children that exist in the parent node. See [Node.allChildren](Node.md#allchildren) for details). +ReadOnlyItemList represents an ordered list of API objects that are all children of the same parent node. -Items in a bare ReadOnlyItemList cannot be added, removed, or reordered. Subclasses like ItemList may add these capabilities, however. +Items in a bare ReadOnlyItemList cannot be added, removed, or reordered. The [ItemList](ItemList.md) subclass adds more +capabilities, and is most frequently encountered as [ArtboardNode.children](ArtboardNode.md#children) or [GroupNode.children](GroupNode.md#children). ## Extended by diff --git a/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md b/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md index 3b48a6302..751647e48 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md @@ -473,10 +473,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`RectangleNode`](RectangleNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md b/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md index 59e7c3a2b..95961f197 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md +++ b/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md @@ -2,9 +2,8 @@ # Class: RestrictedItemList -Base for ItemLists that have restricted behavior on how items are added to the list, -but allow items to be removed and reordered. Subclasses like ItemList may add more -capabilities, however. +Base for ItemLists that restrict how items are added to the list, but freely allow items to be removed and +reordered. The [ItemList](ItemList.md) subclass adds more capabilities, however. ## Extends diff --git a/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md b/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md index 56e2041b4..4a84ddbfc 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md @@ -318,10 +318,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`SolidColorShapeNode`](SolidColorShapeNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md b/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md index 09986806f..f47a0e270 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md @@ -2,10 +2,11 @@ # Class: StandaloneTextNode -A StandaloneTextNode represents a text display frame in the scenegraph. It displays an entire piece of text. +A StandaloneTextNode represents text that is displayed *entirely* within one single frame in the scenegraph (in +contrast to [ThreadedTextNode](ThreadedTextNode.md), 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](TextNodeContentModel.md). -To create new a single-frame piece of text, see [Editor.createText](Editor.md#createtext). +To create a new StandaloneTextNode, see [Editor.createText](Editor.md#createtext). ## Extends @@ -75,6 +76,8 @@ even for an orphan node with no parent. `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -95,9 +98,16 @@ The top-left corner of the bounding box corresponds to the visual top-left corne `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + + +Note: the visual top-left corner of this box is usually not (0,0). Always use `boundsLocal` or [topLeftLocal](TextNode.md#topleftlocal) +instead of assuming (0,0). + --- ### centerPointLocal @@ -110,6 +120,8 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c `Readonly`<[`Point`](../interfaces/Point.md)\> + + Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -123,6 +135,8 @@ The model containing the complete text string and its styles, only part of which this specific TextNode "frame." The full text content flow may be split across multiple frames, and/or it may be clipped if a fixed-size frame using [AreaTextLayout](../interfaces/AreaTextLayout.md) does not fit all the (remaining) text. + + Note: When traversing the scenegraph in search of text content, bear in mind that multiple TextNodes may refer to the same single [TextNodeContentModel](TextNodeContentModel.md); this can give the impression that the same text is duplicated multiple times when it is not. Use [TextNodeContentModel](TextNodeContentModel.md).id to determine whether a given piece of text content is unique or if it's already been @@ -151,27 +165,16 @@ moved to a different part of the document. • `get` **layout**(): `Readonly`<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\> - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - • `set` **layout**(`layout`): `void` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - -Sets the layout mode of the TextNode "frame." - -[AreaTextLayout](../interfaces/AreaTextLayout.md) is not supported by single-frame text. +Sets the layout mode of this TextNode "frame" which the text content is displayed within. +[AreaTextLayout](../interfaces/AreaTextLayout.md) is not supported by standalone text. #### Throws -if changing text layout to/from [TextLayout.magicFit](../enumerations/TextLayout.md#magicfit) or [TextLayout.circular](../enumerations/TextLayout.md#circular) layout when the text contains font(s) unavailable to the current user. - -#### Throws - -if [StandaloneTextNode](StandaloneTextNode.md) is not a part of a multi-frame text content flow and the layout is [AreaTextLayout](../interfaces/AreaTextLayout.md). +if changing text layout to/from [TextLayout.magicFit](../enumerations/TextLayout.md#magicfit) or [TextLayout.circular](../enumerations/TextLayout.md#circular) +layout when the text contains fonts that are unavailable to the current user, because these layouts change +capitalization and thus alter which glyphs are displayed. #### Parameters @@ -344,9 +347,15 @@ boundsInParent. `Readonly`<[`Point`](../interfaces/Point.md)\> + + Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + + +Note: this value is usually not (0,0) due to the way text layout is defined. + --- ### transformMatrix @@ -438,6 +447,8 @@ relative to one another (the target node need not be an ancestor of this node, n `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this method only when the node is placed on a page. @@ -451,10 +462,6 @@ page. It is recommended to use this method only when the node is placed on a pag • **cloneInPlace**(): [`StandaloneTextNode`](StandaloneTextNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md b/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md index ebaedcbd2..fe5804588 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md @@ -329,10 +329,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`StrokableNode`](StrokableNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md b/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md index 4e4609cbb..d75295f68 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md @@ -320,10 +320,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`StrokeShapeNode`](StrokeShapeNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/TextContentModel.md b/src/pages/references/document-sandbox/document-apis/classes/TextContentModel.md index 1a1776810..27e922f7b 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/TextContentModel.md +++ b/src/pages/references/document-sandbox/document-apis/classes/TextContentModel.md @@ -15,10 +15,15 @@ Use this model to get or modify the text string and the style ranges applied to • `get` **characterStyleRanges**(): readonly [`CharacterStylesRange`](../interfaces/CharacterStylesRange.md)[] -The character styles are applied to different ranges of this text content. When setting character styles, any style -properties that are not provided are reset to their defaults (contrast to [applyCharacterStyles](TextContentModel.md#applycharacterstyles) which -preserves the text's existing styles for any fields not specified). When *getting* styles, all fields are always -provided. +The character styles that are applied to different ranges of this text content. Each range starts immediately after +the previous one: they are always contiguous, and never overlap. + +When *setting* character styles, any style properties that are not provided are reset to their defaults (contrast to +[applyCharacterStyles](TextContentModel.md#applycharacterstyles) which preserves the text's existing styles for any fields not specified). If the ranges +do not cover the full length of the text, the last range is extended to cover all the remaining text. +When *getting* styles, all fields are always provided. + + Note: existing fonts used in the document, returned by this getter, are not guaranteed to be ones the current user has rights to edit with. The *setter* only accepts the AvailableFont type which has been verified to be usable. @@ -60,18 +65,10 @@ Comparing two models using `===` will always fail. • `get` **paragraphStyleRanges**(): readonly [`ParagraphStylesRange`](../interfaces/ParagraphStylesRange.md)[] - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - The styles applied to different paragraphs of this text content. • `set` **paragraphStyleRanges**(`styles`): `void` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Apply styles to different paragraphs of this text content. Any style properties that are not provided are reset to their defaults. When **getting** styles, all properties are always provided. @@ -81,7 +78,7 @@ entire paragraph. #### Throws -if the text content contains fonts unavailable to the current user and an ordered-list style is being applied. +If applying an ordered-list style when the text contains fonts that are unavailable to the current user. #### Parameters @@ -99,6 +96,11 @@ readonly [`ParagraphStylesRange`](../interfaces/ParagraphStylesRange.md)[] The complete text string, which may span multiple [ThreadedTextNode](ThreadedTextNode.md) "frames" in the scenegraph. +#### Throws + +The setter throws if the existing text contains fonts unavailable to the current user. +See [hasUnavailableFonts](TextContentModel.md#hasunavailablefonts). + • `set` **text**(`textContent`): `void` #### Parameters @@ -146,6 +148,9 @@ unchanged. Does not modify any styles in the text outside this range. Contrast t setter, which specifies new style range(s) for the entire text at once, and resets any unspecified properties back to default styles. +Explicitly specifying `link: ""` will remove any hyperlinks present in the existing text. If the `link` style +property is not specified at all, existing links are preserved. + #### Parameters • **styles**: [`CharacterStylesInput`](../interfaces/CharacterStylesInput.md) @@ -155,9 +160,7 @@ The styles to apply. • **range?**: [`TextRange`](../interfaces/TextRange.md) The start and length of the character sequence to which the styles should be applied. -The styles will be applied to the entire text content flow if not specified. -If the specified range doesn't align well with the paragraph boundaries, the range will be expanded to cover the -entire paragraphs, it overlaps. +If no range is specified, styles will be applied to the entire text content flow. #### Returns @@ -169,10 +172,6 @@ entire paragraphs, it overlaps. • **applyParagraphStyles**(`styles`, `range`?): `void` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Apply one or more styles to the paragraphs in the given range, leaving any style properties that were not specified unchanged. Does not modify any styles in the text outside this range. Contrast to the [paragraphStyleRanges](TextContentModel.md#paragraphstyleranges) setter, which specifies new style range(s) for the entire text at once, and resets any unspecified properties back to @@ -186,13 +185,18 @@ The styles to apply. • **range?**: [`TextRange`](../interfaces/TextRange.md) -The start and length of character sequence to which the styles should be applied. -If not specified the styles will be applied to the entire piece of text content flow. +The start and length of character sequence to which the styles should be applied. Styles apply to any +paragraphs that even partially overlap this range. +If range is not specified, the styles will be applied to the entire text content flow. #### Returns `void` +#### Throws + +If applying an ordered-list style when the text contains fonts that are unavailable to the current user. + --- ### deleteText() diff --git a/src/pages/references/document-sandbox/document-apis/classes/TextNode.md b/src/pages/references/document-sandbox/document-apis/classes/TextNode.md index ff70e8f75..6f2aa6514 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/TextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/TextNode.md @@ -3,9 +3,14 @@ # Class: `abstract` TextNode TextNode is an abstract base class representing text displayed in the scenegraph, regardless of whether it's a fully -self-contained [StandaloneTextNode](StandaloneTextNode.md) or one [ThreadedTextNode](ThreadedTextNode.md) "frame" of multiple in a larger flow. The +self-contained [StandaloneTextNode](StandaloneTextNode.md) or one of multiple [ThreadedTextNode](ThreadedTextNode.md) "frames" in a larger flow. The APIs on TextNode and its [TextNodeContentModel](TextNodeContentModel.md) allow you to generically work with text without needing to know -which of those subtypes you are dealing with. +which subtype you are dealing with. + + + +Note: the visual top-left corner of text is not located at its local (0,0) origin point, so it's easiest to position +text using [Node.setPositionInParent](Node.md#setpositioninparent) rather than setting its [Node.translation](Node.md#translation) directly. ## Extends @@ -80,6 +85,8 @@ even for an orphan node with no parent. `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -100,9 +107,14 @@ The top-left corner of the bounding box corresponds to the visual top-left corne `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + +Note: the visual top-left corner of this box is usually not (0,0). Always use `boundsLocal` or [topLeftLocal](TextNode.md#topleftlocal) +instead of assuming (0,0). + --- ### centerPointLocal @@ -115,6 +127,7 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -128,6 +141,7 @@ The model containing the complete text string and its styles, only part of which this specific TextNode "frame." The full text content flow may be split across multiple frames, and/or it may be clipped if a fixed-size frame using [AreaTextLayout](../interfaces/AreaTextLayout.md) does not fit all the (remaining) text. + Note: When traversing the scenegraph in search of text content, bear in mind that multiple TextNodes may refer to the same single [TextNodeContentModel](TextNodeContentModel.md); this can give the impression that the same text is duplicated multiple times when it is not. Use [TextNodeContentModel](TextNodeContentModel.md).id to determine whether a given piece of text content is unique or if it's already been @@ -156,10 +170,6 @@ moved to a different part of the document. • `get` **layout**(): `Readonly`<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`AreaTextLayout`](../interfaces/AreaTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\> - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - #### Returns `Readonly`<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`AreaTextLayout`](../interfaces/AreaTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\> @@ -327,9 +337,13 @@ boundsInParent. `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + +Note: this value is usually not (0,0) due to the way text layout is defined. + --- ### transformMatrix @@ -421,6 +435,7 @@ relative to one another (the target node need not be an ancestor of this node, n `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this method only when the node is placed on a page. @@ -434,10 +449,6 @@ page. It is recommended to use this method only when the node is placed on a pag • **cloneInPlace**(): [`TextNode`](TextNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/TextNodeContentModel.md b/src/pages/references/document-sandbox/document-apis/classes/TextNodeContentModel.md index 632b662d8..fefaa3046 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/TextNodeContentModel.md +++ b/src/pages/references/document-sandbox/document-apis/classes/TextNodeContentModel.md @@ -16,11 +16,13 @@ Use this model to get or modify the text string and the style ranges applied to • `get` **allTextNodes**(): `Readonly`<`Iterable`<[`TextNode`](TextNode.md), `any`, `any`\>\> -Get ordered list of all [TextNode](TextNode.md)s that display this text content in the scenegraph. The text content -starts in the first [ThreadedTextNode](ThreadedTextNode.md) "frame", and then flows into the second node once it has filled the first one. The ending of the -text content may not be visible at all, if the last [ThreadedTextNode](ThreadedTextNode.md) "frame" is not large enough to accommodate it. +Get ordered list of all [TextNode](TextNode.md)s that display this text content in the scenegraph. This might be a single +[StandaloneTextNode](StandaloneTextNode.md) *or* a list of one or more [ThreadedTextNode](ThreadedTextNode.md)s. In the case of threaded text, the +text content starts in the first [ThreadedTextNode](ThreadedTextNode.md) "frame", and then flows into the second node once it has +filled the first one. The ending of the text content may not be visible at all, if the last "frame" is not large +enough to accommodate it. -If there are multiple [ThreadedTextNode](ThreadedTextNode.md)s, all of them must be configured to use [AreaTextLayout](../interfaces/AreaTextLayout.md). +All linked ThreadedTextNodes that share a single TextContentModel must remain together within the same artboard. #### Returns @@ -32,10 +34,15 @@ If there are multiple [ThreadedTextNode](ThreadedTextNode.md)s, all of them must • `get` **characterStyleRanges**(): readonly [`CharacterStylesRange`](../interfaces/CharacterStylesRange.md)[] -The character styles are applied to different ranges of this text content. When setting character styles, any style -properties that are not provided are reset to their defaults (contrast to [applyCharacterStyles](TextContentModel.md#applycharacterstyles) which -preserves the text's existing styles for any fields not specified). When *getting* styles, all fields are always -provided. +The character styles that are applied to different ranges of this text content. Each range starts immediately after +the previous one: they are always contiguous, and never overlap. + +When *setting* character styles, any style properties that are not provided are reset to their defaults (contrast to +[applyCharacterStyles](TextContentModel.md#applycharacterstyles) which preserves the text's existing styles for any fields not specified). If the ranges +do not cover the full length of the text, the last range is extended to cover all the remaining text. +When *getting* styles, all fields are always provided. + + Note: existing fonts used in the document, returned by this getter, are not guaranteed to be ones the current user has rights to edit with. The *setter* only accepts the AvailableFont type which has been verified to be usable. @@ -77,18 +84,10 @@ Comparing two models using `===` will always fail. • `get` **paragraphStyleRanges**(): readonly [`ParagraphStylesRange`](../interfaces/ParagraphStylesRange.md)[] - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - The styles applied to different paragraphs of this text content. • `set` **paragraphStyleRanges**(`styles`): `void` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Apply styles to different paragraphs of this text content. Any style properties that are not provided are reset to their defaults. When **getting** styles, all properties are always provided. @@ -98,7 +97,7 @@ entire paragraph. #### Throws -if the text content contains fonts unavailable to the current user and an ordered-list style is being applied. +If applying an ordered-list style when the text contains fonts that are unavailable to the current user. #### Parameters @@ -116,6 +115,11 @@ readonly [`ParagraphStylesRange`](../interfaces/ParagraphStylesRange.md)[] The complete text string, which may span multiple [ThreadedTextNode](ThreadedTextNode.md) "frames" in the scenegraph. +#### Throws + +The setter throws if the existing text contains fonts unavailable to the current user. +See [hasUnavailableFonts](TextContentModel.md#hasunavailablefonts). + • `set` **text**(`textContent`): `void` #### Parameters @@ -167,6 +171,9 @@ unchanged. Does not modify any styles in the text outside this range. Contrast t setter, which specifies new style range(s) for the entire text at once, and resets any unspecified properties back to default styles. +Explicitly specifying `link: ""` will remove any hyperlinks present in the existing text. If the `link` style +property is not specified at all, existing links are preserved. + #### Parameters • **styles**: [`CharacterStylesInput`](../interfaces/CharacterStylesInput.md) @@ -176,9 +183,7 @@ The styles to apply. • **range?**: [`TextRange`](../interfaces/TextRange.md) The start and length of the character sequence to which the styles should be applied. -The styles will be applied to the entire text content flow if not specified. -If the specified range doesn't align well with the paragraph boundaries, the range will be expanded to cover the -entire paragraphs, it overlaps. +If no range is specified, styles will be applied to the entire text content flow. #### Returns @@ -194,10 +199,6 @@ entire paragraphs, it overlaps. • **applyParagraphStyles**(`styles`, `range`?): `void` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Apply one or more styles to the paragraphs in the given range, leaving any style properties that were not specified unchanged. Does not modify any styles in the text outside this range. Contrast to the [paragraphStyleRanges](TextContentModel.md#paragraphstyleranges) setter, which specifies new style range(s) for the entire text at once, and resets any unspecified properties back to @@ -211,8 +212,9 @@ The styles to apply. • **range?**: [`TextRange`](../interfaces/TextRange.md) -The start and length of character sequence to which the styles should be applied. -If not specified the styles will be applied to the entire piece of text content flow. +The start and length of character sequence to which the styles should be applied. Styles apply to any +paragraphs that even partially overlap this range. +If range is not specified, the styles will be applied to the entire text content flow. #### Returns @@ -222,6 +224,10 @@ If not specified the styles will be applied to the entire piece of text content [`TextContentModel`](TextContentModel.md).[`applyParagraphStyles`](TextContentModel.md#applyparagraphstyles) +#### Throws + +If applying an ordered-list style when the text contains fonts that are unavailable to the current user. + --- ### deleteText() diff --git a/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md b/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md index f2fa32cad..851b81f18 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md @@ -2,11 +2,13 @@ # Class: ThreadedTextNode -A ThreadedTextNode represents a text display frame in the scenegraph. It is a subset of longer text that flows across -multiple TextNode "frames". Because of this, the TextNode does not directly hold the text content and styles – +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](TextNodeContentModel.md), which may be shared across multiple ThreadedTextNode frames. -APIs are not yet available to create multi-frame text flows. +All linked ThreadedTextNodes that share a single TextContentModel must remain together within the same artboard. + +APIs are not yet available to create multi-frame text flows. To create *non*-threaded text, use [Editor.createText](Editor.md#createtext). ## Extends @@ -76,6 +78,7 @@ even for an orphan node with no parent. `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -96,9 +99,14 @@ The top-left corner of the bounding box corresponds to the visual top-left corne `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + +Note: the visual top-left corner of this box is usually not (0,0). Always use `boundsLocal` or [topLeftLocal](TextNode.md#topleftlocal) +instead of assuming (0,0). + --- ### centerPointLocal @@ -111,6 +119,7 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -124,6 +133,7 @@ The model containing the complete text string and its styles, only part of which this specific TextNode "frame." The full text content flow may be split across multiple frames, and/or it may be clipped if a fixed-size frame using [AreaTextLayout](../interfaces/AreaTextLayout.md) does not fit all the (remaining) text. + Note: When traversing the scenegraph in search of text content, bear in mind that multiple TextNodes may refer to the same single [TextNodeContentModel](TextNodeContentModel.md); this can give the impression that the same text is duplicated multiple times when it is not. Use [TextNodeContentModel](TextNodeContentModel.md).id to determine whether a given piece of text content is unique or if it's already been @@ -152,24 +162,11 @@ moved to a different part of the document. • `get` **layout**(): `Readonly`<[`AreaTextLayout`](../interfaces/AreaTextLayout.md)\> - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - • `set` **layout**(`layout`): `void` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - -Sets the layout mode of the TextNode "frame." - +Sets the layout mode of this TextNode "frame" which the text content is displayed within. Only [AreaTextLayout](../interfaces/AreaTextLayout.md), with fully fixed bounds, is currently supported by threaded text. -#### Throws - -if [ThreadedTextNode](ThreadedTextNode.md) is part of a multi-frame text content flow and the layout is not [AreaTextLayout](../interfaces/AreaTextLayout.md). - #### Parameters • **layout**: [`AreaTextLayout`](../interfaces/AreaTextLayout.md) @@ -341,9 +338,13 @@ boundsInParent. `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + +Note: this value is usually not (0,0) due to the way text layout is defined. + --- ### transformMatrix @@ -435,6 +436,7 @@ relative to one another (the target node need not be an ancestor of this node, n `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this method only when the node is placed on a page. @@ -448,10 +450,6 @@ page. It is recommended to use this method only when the node is placed on a pag • **cloneInPlace**(): [`ThreadedTextNode`](ThreadedTextNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md b/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md index 83d4218cc..ca7570cec 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md @@ -160,6 +160,10 @@ expectations before doing so. Get [AddOnData](AddOnData.md) reference for managing private metadata attached to the media resource displayed by this node. The same media resource may be reused in multiple places in the document, and all share the same AddOnData state. + + +Note: This support is not present for PSD (Photoshop Document) / AI (Adobe Illustrator) assets. An error will be thrown in that case. + #### Returns [`AddOnData`](AddOnData.md) @@ -342,10 +346,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): `never` - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Always throws as it's not possible to clone just the media rectangle alone. Clone the entire parent MediaContainerNode instead. diff --git a/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md b/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md index b3799599d..1e3b9c196 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md @@ -299,10 +299,6 @@ relative to one another (the target node need not be an ancestor of this node, n • **cloneInPlace**(): [`UnknownNode`](UnknownNode.md) - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Creates a copy of this node and its entire subtree of descendants. The node must be attached to a page as the copy will be added as a sibling. diff --git a/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md b/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md index 986bdafac..e2e6152b8 100644 --- a/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md +++ b/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md @@ -91,6 +91,7 @@ interacts with other siblings within the same container. See documentation below The normal, default blend mode for leaf nodes. + Note: Group nodes default to using `passThrough` blend mode instead. See below. --- diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/AreaTextLayout.md b/src/pages/references/document-sandbox/document-apis/interfaces/AreaTextLayout.md index 38da176cf..474ce37c4 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/AreaTextLayout.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/AreaTextLayout.md @@ -2,9 +2,8 @@ # Interface: AreaTextLayout - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. +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. ## Properties diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md b/src/pages/references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md index d0777669c..bae004184 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md @@ -2,9 +2,8 @@ # Interface: AutoHeightTextLayout - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. +Auto-height text: Width is explicitly set, and text wraps to use as much vertical space as necessary to display the +full content. ## Properties diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/AutoWidthTextLayout.md b/src/pages/references/document-sandbox/document-apis/interfaces/AutoWidthTextLayout.md index 81f23ce3f..eff150058 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/AutoWidthTextLayout.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/AutoWidthTextLayout.md @@ -2,9 +2,8 @@ # Interface: AutoWidthTextLayout - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. +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. ## Properties diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/BaseParagraphStyles.md b/src/pages/references/document-sandbox/document-apis/interfaces/BaseParagraphStyles.md index 14bc509fa..562c94962 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/BaseParagraphStyles.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/BaseParagraphStyles.md @@ -2,10 +2,6 @@ # Interface: BaseParagraphStyles - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Base paragraph styles that can be applied to an entire paragraph atomically. Excludes list style settings, which differ between the getter-oriented [ParagraphStyles](ParagraphStyles.md) interface and the setter-oriented [ParagraphStylesRangeInput](ParagraphStylesRangeInput.md). diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md index e31e2657e..96f89423c 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md @@ -64,6 +64,7 @@ Size of the text in points. • **length**: `number` The length or number of characters in which character styles will be applied. + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md index 8c8d5a236..50a0db2e5 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md @@ -65,6 +65,7 @@ Size of the text in points. • **length**: `number` The length or number of characters in which character styles will be applied. + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/IMediaContainerNode.md b/src/pages/references/document-sandbox/document-apis/interfaces/IMediaContainerNode.md index 605af7634..41d7ee603 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/IMediaContainerNode.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/IMediaContainerNode.md @@ -42,9 +42,9 @@ or top/bottom edges. Currently only supports images as the new media, but previo #### Parameters -• **media**: [`BitmapImage`](../classes/BitmapImage.md) +• **media**: `BitmapImage` -New content to display. Currently must be a [BitmapImage](../classes/BitmapImage.md). +New content to display. Currently must be a BitmapImage. #### Returns diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/IRectangularNode.md b/src/pages/references/document-sandbox/document-apis/interfaces/IRectangularNode.md index 26478e2c8..d5cd65f23 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/IRectangularNode.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/IRectangularNode.md @@ -4,6 +4,15 @@ Interface for nodes with width and height properties. +## Implemented by + +- [`ArtboardNode`](../classes/ArtboardNode.md) +- [`GridLayoutNode`](../classes/GridLayoutNode.md) +- [`ImageRectangleNode`](../classes/ImageRectangleNode.md) +- [`MediaRectangleNode`](../classes/MediaRectangleNode.md) +- [`PageNode`](../classes/PageNode.md) +- [`RectangleNode`](../classes/RectangleNode.md) + ## Properties ### height diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ListItem.md b/src/pages/references/document-sandbox/document-apis/interfaces/ListItem.md index 2811f6e68..ccd3e79e6 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ListItem.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ListItem.md @@ -2,5 +2,4 @@ # Interface: ListItem -Base interface for any item that can be used in [ItemList](../classes/ItemList.md). ItemList is used in different places to hold various -types of items, including Nodes, Fills, and Strokes. +Base interface for any item that can be stored in an [ItemList](../classes/ItemList.md) (typically a [Node](../classes/Node.md) type). diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/OrderedListStyleInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/OrderedListStyleInput.md index 934bd523a..8f51b763c 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/OrderedListStyleInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/OrderedListStyleInput.md @@ -2,10 +2,6 @@ # Interface: OrderedListStyleInput - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Interface for specifying an ordered list style, such as a numbered list. ## Extends @@ -31,7 +27,7 @@ A value from 0-8 that specifies indent/nesting level. Default is 0 if not provid • `optional` **numbering**: [`OrderedListNumbering`](../namespaces/Constants/enumerations/OrderedListNumbering.md) The numbering style to use. If undefined, it defaults to a different type depending on the paragraph's indent level. -The defaults for increasing indent are 1, a, i, I, and then they repeat. +The defaults for increasing indent are: 1, a, i, I, and then they repeat. These markers and the prefix/postfix strings (if any) are displayed using the same font as the start of the paragraph's text content. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStyles.md b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStyles.md index d5ae7b0ff..a63a2d9cc 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStyles.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStyles.md @@ -2,10 +2,6 @@ # Interface: ParagraphStyles - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - 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). diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesInput.md index d81f12b3d..2f311be65 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesInput.md @@ -2,11 +2,7 @@ # Interface: ParagraphStylesInput - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - -The variant of [ParagraphStyles](ParagraphStyles.md) with all optional style fields is used to apply ParagraphStyles(). When using that API, +A variant of [ParagraphStyles](ParagraphStyles.md) 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. ## Extends @@ -34,7 +30,7 @@ It only affects the space *between* lines, not the space above the first line or ### list? -• `optional` **list**: [`OrderedListStyleInput`](OrderedListStyleInput.md) \| [`UnorderedListStyleInput`](UnorderedListStyleInput.md) +• `optional` **list**: [`ListStyleInput`](../type-aliases/ListStyleInput.md) --- diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md index 63fcaaa3f..84c22ed3c 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md @@ -2,11 +2,7 @@ # Interface: ParagraphStylesRange - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - -A set of [ParagraphStyles](ParagraphStyles.md) and the text range they apply to. It is seen in the paragraphStyleRanges getter. +A set of [ParagraphStyles](ParagraphStyles.md) along with the text range they apply to. Returned by the paragraphStyleRanges getter. ## Extends @@ -19,6 +15,7 @@ A set of [ParagraphStyles](ParagraphStyles.md) and the text range they apply to. • **length**: `number` The length or number of characters in which character styles will be applied. + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md index 8a45db61e..8ae80a5ce 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md @@ -2,15 +2,10 @@ # Interface: ParagraphStylesRangeInput - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - -A variant of [ParagraphStylesRange](ParagraphStylesRange.md) with all style fields optional and the text range they apply to. Used for the +A variant of [ParagraphStylesRange](ParagraphStylesRange.md) 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. -Paragraphs are separated by newline characters (`\n`). The ranges specified here should align with -those boundaries. +Paragraphs are separated by newline characters (`\n`). Ranges specified here should align with those boundaries. ## Extends @@ -23,6 +18,7 @@ those boundaries. • **length**: `number` The length or number of characters in which character styles will be applied. + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. @@ -47,7 +43,7 @@ It only affects the space *between* lines, not the space above the first line or ### list? -• `optional` **list**: [`OrderedListStyleInput`](OrderedListStyleInput.md) \| [`UnorderedListStyleInput`](UnorderedListStyleInput.md) +• `optional` **list**: [`ListStyleInput`](../type-aliases/ListStyleInput.md) #### Inherited from diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/RemoveListStyleInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/RemoveListStyleInput.md new file mode 100644 index 000000000..6666119e7 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/RemoveListStyleInput.md @@ -0,0 +1,27 @@ +[@express-document-sdk](../overview.md) / RemoveListStyleInput + +# Interface: RemoveListStyleInput + +Interface for removing a list style. + +## Extends + +- `BaseParagraphListStyle` + +## Properties + +### indentLevel? + +• `optional` **indentLevel**: `number` + +A value from 0-8 that specifies indent/nesting level. Default is 0 if not provided. + +#### Inherited from + +`BaseParagraphListStyle.indentLevel` + +--- + +### type + +• **type**: [`none`](../namespaces/Constants/enumerations/ParagraphListType.md#none) diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md b/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md index b5dea0be8..e4a70e4f0 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md @@ -18,5 +18,7 @@ Represents a range of characters defined by a length (and implicitly started at • **length**: `number` The length or number of characters in which character styles will be applied. + + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/UnorderedListStyleInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/UnorderedListStyleInput.md index 49716cac2..eb398cd57 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/UnorderedListStyleInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/UnorderedListStyleInput.md @@ -2,10 +2,6 @@ # Interface: UnorderedListStyleInput - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - Interface for specifying an unordered list style, such as a bullet list. ## Extends diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md b/src/pages/references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md index 88d0fef2e..7409ddbce 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/UnsupportedTextLayout.md @@ -2,9 +2,7 @@ # Interface: UnsupportedTextLayout - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. +Represents a text layout the API does not yet support setting or reading the details of. ## Properties diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/OrderedListNumbering.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/OrderedListNumbering.md index 6146189c7..091d48314 100644 --- a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/OrderedListNumbering.md +++ b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/OrderedListNumbering.md @@ -2,10 +2,6 @@ # Enumeration: OrderedListNumbering - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../manifest/index.md#requirements) section of the `manifest.json`. - Numbering types used to display ordered lists: 1, A, a, I, i 01, 001. ## Enumeration Members diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/ParagraphListType.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/ParagraphListType.md index ece8d5658..f12238f75 100644 --- a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/ParagraphListType.md +++ b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/ParagraphListType.md @@ -2,20 +2,22 @@ # Enumeration: ParagraphListType - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../manifest/index.md#requirements) section of the `manifest.json`. - Indicates list type: see [UnorderedListStyleInput](../../../interfaces/UnorderedListStyleInput.md) and [OrderedListStyleInput](../../../interfaces/OrderedListStyleInput.md). ## Enumeration Members +### none + +• **none**: `0` + +--- + ### ordered -• **ordered**: `1` +• **ordered**: `2` --- ### unordered -• **unordered**: `0` +• **unordered**: `1` diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md index 096fe8c92..267e11c06 100644 --- a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md +++ b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md @@ -4,7 +4,7 @@ -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../manifest/index.md#requirements) section of the `manifest.json`. +**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../../references/manifest/index.md#requirements) section of the `manifest.json`. Indicates which existing text to match the style of when inserting new text or replacing text. diff --git a/src/pages/references/document-sandbox/document-apis/overview.md b/src/pages/references/document-sandbox/document-apis/overview.md index e76830992..75fd7a7d0 100644 --- a/src/pages/references/document-sandbox/document-apis/overview.md +++ b/src/pages/references/document-sandbox/document-apis/overview.md @@ -1,7 +1,3 @@ -**@express-document-sdk** • **Docs** - ---- - # @express-document-sdk ## Namespaces @@ -31,7 +27,6 @@ - [AvailableFont](classes/AvailableFont.md) - [BaseFont](classes/BaseFont.md) - [BaseNode](classes/BaseNode.md) -- [BitmapImage](classes/BitmapImage.md) - [ColorUtils](classes/ColorUtils.md) - [ComplexShapeNode](classes/ComplexShapeNode.md) - [Context](classes/Context.md) @@ -99,6 +94,7 @@ - [Point](interfaces/Point.md) - [Rect](interfaces/Rect.md) - [RectangleGeometry](interfaces/RectangleGeometry.md) +- [RemoveListStyleInput](interfaces/RemoveListStyleInput.md) - [SolidColorStroke](interfaces/SolidColorStroke.md) - [Stroke](interfaces/Stroke.md) - [StyleRange](interfaces/StyleRange.md) @@ -111,6 +107,7 @@ - [EditorEventHandler](type-aliases/EditorEventHandler.md) - [EventHandlerId](type-aliases/EventHandlerId.md) - [Font](type-aliases/Font.md) +- [ListStyleInput](type-aliases/ListStyleInput.md) - [OrderedListStyle](type-aliases/OrderedListStyle.md) - [SolidColorStrokeWithOptionalType](type-aliases/SolidColorStrokeWithOptionalType.md) - [UnorderedListStyle](type-aliases/UnorderedListStyle.md) diff --git a/src/pages/references/document-sandbox/document-apis/type-aliases/Font.md b/src/pages/references/document-sandbox/document-apis/type-aliases/Font.md index c36e26565..7a6c2d694 100644 --- a/src/pages/references/document-sandbox/document-apis/type-aliases/Font.md +++ b/src/pages/references/document-sandbox/document-apis/type-aliases/Font.md @@ -6,5 +6,7 @@ Represents a font in the document. + + Note: not every font encountered in the existing content is available for editing. Check the `availableForEditing` property to be sure. diff --git a/src/pages/references/document-sandbox/document-apis/type-aliases/ListStyleInput.md b/src/pages/references/document-sandbox/document-apis/type-aliases/ListStyleInput.md new file mode 100644 index 000000000..0dd8e2243 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/type-aliases/ListStyleInput.md @@ -0,0 +1,5 @@ +[@express-document-sdk](../overview.md) / ListStyleInput + +# Type alias: ListStyleInput + +• **ListStyleInput**: [`OrderedListStyleInput`](../interfaces/OrderedListStyleInput.md) \| [`UnorderedListStyleInput`](../interfaces/UnorderedListStyleInput.md) \| [`RemoveListStyleInput`](../interfaces/RemoveListStyleInput.md) diff --git a/src/pages/references/document-sandbox/document-apis/type-aliases/OrderedListStyle.md b/src/pages/references/document-sandbox/document-apis/type-aliases/OrderedListStyle.md index 263570b58..27976b76b 100644 --- a/src/pages/references/document-sandbox/document-apis/type-aliases/OrderedListStyle.md +++ b/src/pages/references/document-sandbox/document-apis/type-aliases/OrderedListStyle.md @@ -4,8 +4,4 @@ • **OrderedListStyle**: `Required`<[`OrderedListStyleInput`](../interfaces/OrderedListStyleInput.md)\> - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - OrderedListStyle represents the style of an ordered list. diff --git a/src/pages/references/document-sandbox/document-apis/type-aliases/UnorderedListStyle.md b/src/pages/references/document-sandbox/document-apis/type-aliases/UnorderedListStyle.md index 456bfd94e..0ba9d86ad 100644 --- a/src/pages/references/document-sandbox/document-apis/type-aliases/UnorderedListStyle.md +++ b/src/pages/references/document-sandbox/document-apis/type-aliases/UnorderedListStyle.md @@ -4,8 +4,4 @@ • **UnorderedListStyle**: `Required`<[`UnorderedListStyleInput`](../interfaces/UnorderedListStyleInput.md)\> - - -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../manifest/index.md#requirements) section of the `manifest.json`. - UnorderedListStyle represents the style of an unordered list.