Updated docs for Resize API and TextNode class

gatsby-config.js

@@ -238,6 +238,10 @@ module.exports = {
                     title: "SolidColorShapeNode",
                     path: "references/document-sandbox/document-apis/classes/SolidColorShapeNode.md",
                   },
+                  {
+                    title: "StandaloneTextNode",
+                    path: "references/document-sandbox/document-apis/classes/StandaloneTextNode.md",
+                  },
                   {
                     title: "StrokableNode",
                     path: "references/document-sandbox/document-apis/classes/StrokableNode.md",
@@ -254,6 +258,10 @@ module.exports = {
                     title: "TextNode",
                     path: "references/document-sandbox/document-apis/classes/TextNode.md",
                   },
+                  {
+                    title: "ThreadedTextNode",
+                    path: "references/document-sandbox/document-apis/classes/ThreadedTextNode.md",
+                  },
                   {
                     title: "UnavailableFont",
                     path: "references/document-sandbox/document-apis/classes/UnavailableFont.md",
@@ -284,6 +292,10 @@ module.exports = {
                     title: "AutoHeightTextLayout",
                     path: "references/document-sandbox/document-apis/interfaces/AutoHeightTextLayout.md",
                   },
+                  {
+                    title: "AutoWidthTextLayout",
+                    path: "references/document-sandbox/document-apis/interfaces/AutoWidthTextLayout.md",
+                  },
                   {
                     title: "BaseParagraphStyles",
                     path: "references/document-sandbox/document-apis/interfaces/BaseParagraphStyles.md",
@@ -368,10 +380,6 @@ module.exports = {
                     title: "Point",
                     path: "references/document-sandbox/document-apis/interfaces/Point.md",
                   },
-                  {
-                    title: "PointTextLayout",
-                    path: "references/document-sandbox/document-apis/interfaces/PointTextLayout.md",
-                  },
                   {
                     title: "Rect",
                     path: "references/document-sandbox/document-apis/interfaces/Rect.md",

src/pages/references/changelog.md

@@ -22,6 +22,13 @@ contributors:
 
 # Changelog
 
+## 2025-05-27
+
+### Added
+
+- 4 new Resize HLAPI's are added in [Node](./document-sandbox/document-apis/classes/Node.md) class as experimental.
+- [`TextNode()`](./document-sandbox/document-apis/classes/TextNode.md) is now an abstract base class, with two subclasses: StandaloneTextNode and ThreadedTextNode.  These exist mainly to capture the key difference that the allowed layout choices are not the same.  (Standalone text does not support “area text” layout, while Threaded text can only use “area text” layout).
+
 ## 2025-05-26
 
 ### Added

src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md

@@ -16,7 +16,7 @@ Please note that creating and deleting an artboard in a single frame will crash
 
 ## Implements
 
--   [`IRectangularNode`](../interfaces/IRectangularNode.md)
+-   `Readonly`\<[`IRectangularNode`](../interfaces/IRectangularNode.md)\>
 -   [`ContainerNode`](../interfaces/ContainerNode.md)
 
 ## Accessors
@@ -114,6 +114,7 @@ The background fill of the artboard. Artboards must always have a fill.
 • `get` **height**(): `number`
 
 The height of the artboard.
+Shares the same dimensions as the parent page and other artboards within the parent page.
 
 #### Returns
 
@@ -194,6 +195,7 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s
 • `get` **width**(): `number`
 
 The width of the artboard.
+Shares the same dimensions as the parent page and other artboards within the parent page.
 
 #### Returns
 

src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md

@@ -379,6 +379,110 @@ removal. No-op if node is already an orphan.
 
 ---
 
+### rescaleProportionalToHeight()
+
+• **rescaleProportionalToHeight**(`height`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Changes the height to the given value and the width to the given height multiplied by the aspect ratio.
+
+#### Parameters
+
+• **height**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`rescaleProportionalToHeight`](FillableNode.md#rescaleproportionaltoheight)
+
+---
+
+### rescaleProportionalToWidth()
+
+• **rescaleProportionalToWidth**(`width`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Changes the width to the given value and the height to the given width multiplied by the aspect ratio.
+
+#### Parameters
+
+• **width**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`rescaleProportionalToWidth`](FillableNode.md#rescaleproportionaltowidth)
+
+---
+
+### resizeToCover()
+
+• **resizeToCover**(`width`, `height`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Resizes the node to cover a box with the given dimensions.
+
+If the node doesn't have a fixed aspect ratio then this will resize the node to the given width and height.
+
+#### Parameters
+
+• **width**: `number`
+
+• **height**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`resizeToCover`](FillableNode.md#resizetocover)
+
+---
+
+### resizeToFitWithin()
+
+• **resizeToFitWithin**(`width`, `height`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Resizes the node to fit within a box with the given dimensions.
+
+If the node doesn't have a fixed aspect ratio then this will resize the node to the given width and height.
+
+#### Parameters
+
+• **width**: `number`
+
+• **height**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`resizeToFitWithin`](FillableNode.md#resizetofitwithin)
+
+---
+
 ### setPositionInParent()
 
 • **setPositionInParent**(`parentPoint`, `localRegistrationPoint`): `void`

src/pages/references/document-sandbox/document-apis/classes/Editor.md

@@ -138,15 +138,38 @@ Transform values default to 0.
 
 ### createText()
 
-• **createText**(): [`TextNode`](TextNode.md)
+#### createText()
 
-#### Returns
+• **createText**(): [`StandaloneTextNode`](StandaloneTextNode.md)
+
+##### Returns
 
-[`TextNode`](TextNode.md)
+[`StandaloneTextNode`](StandaloneTextNode.md)
 
 a text node with default styles. The text content is initially empty, so the text node will be
-invisible until its `fullContent` property's `text` is set. Creates point text, so the node's width will automatically
-adjust to accommodate whatever text is set.
+invisible until its `fullContent` property's `text` is set. Creates auto-width text, so the node's width will
+automatically adjust to accommodate whatever text is set.
+
+##### Deprecated
+
+- Initial text content is always expected so please use `createText(textContent: string): StandaloneTextNode`.
+
+#### createText(textContent)
+
+• **createText**(`textContent`): [`StandaloneTextNode`](StandaloneTextNode.md)
+
+##### Parameters
+
+• **textContent**: `string`
+
+the initial string to show.
+
+##### Returns
+
+[`StandaloneTextNode`](StandaloneTextNode.md)
+
+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.

src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md

@@ -422,6 +422,110 @@ removal. No-op if node is already an orphan.
 
 ---
 
+### rescaleProportionalToHeight()
+
+• **rescaleProportionalToHeight**(`height`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Changes the height to the given value and the width to the given height multiplied by the aspect ratio.
+
+#### Parameters
+
+• **height**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`rescaleProportionalToHeight`](FillableNode.md#rescaleproportionaltoheight)
+
+---
+
+### rescaleProportionalToWidth()
+
+• **rescaleProportionalToWidth**(`width`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Changes the width to the given value and the height to the given width multiplied by the aspect ratio.
+
+#### Parameters
+
+• **width**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`rescaleProportionalToWidth`](FillableNode.md#rescaleproportionaltowidth)
+
+---
+
+### resizeToCover()
+
+• **resizeToCover**(`width`, `height`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Resizes the node to cover a box with the given dimensions.
+
+If the node doesn't have a fixed aspect ratio then this will resize the node to the given width and height.
+
+#### Parameters
+
+• **width**: `number`
+
+• **height**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`resizeToCover`](FillableNode.md#resizetocover)
+
+---
+
+### resizeToFitWithin()
+
+• **resizeToFitWithin**(`width`, `height`): `void`
+
+<InlineAlert slots="text" variant="warning"/>
+
+**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`.
+
+Resizes the node to fit within a box with the given dimensions.
+
+If the node doesn't have a fixed aspect ratio then this will resize the node to the given width and height.
+
+#### Parameters
+
+• **width**: `number`
+
+• **height**: `number`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`FillableNode`](FillableNode.md).[`resizeToFitWithin`](FillableNode.md#resizetofitwithin)
+
+---
+
 ### setPositionInParent()
 
 • **setPositionInParent**(`parentPoint`, `localRegistrationPoint`): `void`