Skip to content

Update docs #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
undavide merged 2 commits into from
Jan 15, 2026
Merged

Update docs #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44140a2
update docs
rekha-m Jan 9, 2026
91863cf
Resize
rekha-m Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 5 additions & 109 deletions src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,131 +397,27 @@ removal. No-op if node is already an orphan.

---

### rescaleProportionalToHeight()
### resize()

• **rescaleProportionalToHeight**(`height`): `void`
• **resize**(`options`): `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 by visually *scaling* the entire content larger or smaller on both axes to
preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#rescaleproportionaltowidth) documentation for additional explanation.
Resizes this node based on the given [ResizeOptions](../type-aliases/ResizeOptions.md).

#### Parameters

• **height**: `number`
• **options**: [`ResizeOptions`](../type-aliases/ResizeOptions.md)

#### 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 by visually *scaling* the entire content larger or smaller on both axes to
preserve its existing aspect ratio, keeping its top-left corner ([topLeftLocal](VisualNode.md#topleftlocal)) at a fixed location.

Scaling changes the size of visual styling elements such as stroke width, corner detailing, and font size.
Contrast this to *resizing* operations (such as [resizeToFitWithin](Node.md#resizetofitwithin)), which adjust the bounding box of an
element while trying to preserve the existing size of visual detailing such as strokes, corners, and fonts.

Rescaling becomes baked into the updated values of fields such as stroke weight, rectangle width, etc. (it is not
a separate, persistent scale factor multiplier).

#### 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 completely *cover* a box of the given dimensions, keeping its top-left corner ([topLeftLocal](VisualNode.md#topleftlocal))
at a fixed location. Nodes with a fixed aspect ratio may extend outside the box on one axis as a result, but
nodes with flexible aspect ratio will be resized to the exact box size specified. See [resizeToFitWithin](Node.md#resizetofitwithin)
documentation for additional explanation.

#### Parameters

• **width**: `number`

• **height**: `number`

#### Returns

`void`

#### Inherited from

[`FillableNode`](FillableNode.md).[`resizeToCover`](FillableNode.md#resizetocover)

#### See

resizeToFitWithin

---

### 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 entirely *within* a box of the given dimensions, keeping its top-left corner ([topLeftLocal](VisualNode.md#topleftlocal))
at a fixed location. Nodes with a fixed aspect ratio may leave unused space on one axis as a result, but nodes
with flexible aspect ratio will be resized to the exact box size specified.

Resizing attempts to preserve the existing size of visual styling elements such as stroke width, corner detailing,
and font size as much as possible. Contrast with *rescaling* (such as [rescaleProportionalToWidth](Node.md#rescaleproportionaltowidth)), which
always changes the size of visual detailing in exact proportion to the change in overall bounding box size. This
API may still produce *some* degree of rescaling if necessary for certain shapes with fixed corner/edge detailing
to fit the box better.

#### Parameters

• **width**: `number`

• **height**: `number`

#### Returns

`void`

#### Inherited from

[`FillableNode`](FillableNode.md).[`resizeToFitWithin`](FillableNode.md#resizetofitwithin)

#### See

resizeToCover
[`FillableNode`](FillableNode.md).[`resize`](FillableNode.md#resize)

---

Expand Down
114 changes: 5 additions & 109 deletions src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,131 +440,27 @@ removal. No-op if node is already an orphan.

---

### rescaleProportionalToHeight()
### resize()

• **rescaleProportionalToHeight**(`height`): `void`
• **resize**(`options`): `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 by visually *scaling* the entire content larger or smaller on both axes to
preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#rescaleproportionaltowidth) documentation for additional explanation.
Resizes this node based on the given [ResizeOptions](../type-aliases/ResizeOptions.md).

#### Parameters

• **height**: `number`
• **options**: [`ResizeOptions`](../type-aliases/ResizeOptions.md)

#### 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 by visually *scaling* the entire content larger or smaller on both axes to
preserve its existing aspect ratio, keeping its top-left corner ([topLeftLocal](VisualNode.md#topleftlocal)) at a fixed location.

Scaling changes the size of visual styling elements such as stroke width, corner detailing, and font size.
Contrast this to *resizing* operations (such as [resizeToFitWithin](Node.md#resizetofitwithin)), which adjust the bounding box of an
element while trying to preserve the existing size of visual detailing such as strokes, corners, and fonts.

Rescaling becomes baked into the updated values of fields such as stroke weight, rectangle width, etc. (it is not
a separate, persistent scale factor multiplier).

#### 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 completely *cover* a box of the given dimensions, keeping its top-left corner ([topLeftLocal](VisualNode.md#topleftlocal))
at a fixed location. Nodes with a fixed aspect ratio may extend outside the box on one axis as a result, but
nodes with flexible aspect ratio will be resized to the exact box size specified. See [resizeToFitWithin](Node.md#resizetofitwithin)
documentation for additional explanation.

#### Parameters

• **width**: `number`

• **height**: `number`

#### Returns

`void`

#### Inherited from

[`FillableNode`](FillableNode.md).[`resizeToCover`](FillableNode.md#resizetocover)

#### See

resizeToFitWithin

---

### 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 entirely *within* a box of the given dimensions, keeping its top-left corner ([topLeftLocal](VisualNode.md#topleftlocal))
at a fixed location. Nodes with a fixed aspect ratio may leave unused space on one axis as a result, but nodes
with flexible aspect ratio will be resized to the exact box size specified.

Resizing attempts to preserve the existing size of visual styling elements such as stroke width, corner detailing,
and font size as much as possible. Contrast with *rescaling* (such as [rescaleProportionalToWidth](Node.md#rescaleproportionaltowidth)), which
always changes the size of visual detailing in exact proportion to the change in overall bounding box size. This
API may still produce *some* degree of rescaling if necessary for certain shapes with fixed corner/edge detailing
to fit the box better.

#### Parameters

• **width**: `number`

• **height**: `number`

#### Returns

`void`

#### Inherited from

[`FillableNode`](FillableNode.md).[`resizeToFitWithin`](FillableNode.md#resizetofitwithin)

#### See

resizeToCover
[`FillableNode`](FillableNode.md).[`resize`](FillableNode.md#resize)

---

Expand Down
Loading
Loading