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 2f7f9aa2b..e41570191 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md @@ -397,20 +397,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -418,110 +417,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`FillableNode`](FillableNode.md).[`rescaleProportionalToHeight`](FillableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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` - - - -**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` - - - -**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) --- 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 a0af62aa2..43b6f2441 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md @@ -440,20 +440,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -461,110 +460,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`FillableNode`](FillableNode.md).[`rescaleProportionalToHeight`](FillableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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` - - - -**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` - - - -**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) --- 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 21b8c098d..b80daa27b 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md @@ -407,20 +407,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -428,110 +427,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`StrokableNode`](StrokableNode.md).[`rescaleProportionalToHeight`](StrokableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`rescaleProportionalToWidth`](StrokableNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`resizeToCover`](StrokableNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`resizeToFitWithin`](StrokableNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`StrokableNode`](StrokableNode.md).[`resize`](StrokableNode.md#resize) --- 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 34976c6be..885f71e23 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md @@ -413,131 +413,29 @@ New content to display. Currently must be a [BitmapImage](BitmapImage.md). --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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. +Proxy resizing of the MediaRectangleNode *inside* this grid cell. The enclosing grid layout keeps +the crop window (and thus the overall GridCellNode/MediaContainerNode bounds) fixed in position. +*Warning:* This will not change the bounds reported by this GridCellNode itself. #### Parameters -• **height**: `number` +• **options**: [`ResizeOptions`](../type-aliases/ResizeOptions.md) #### Returns `void` -#### Inherited from - -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See +#### Overrides -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 8791e4060..ffac4616b 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md @@ -417,20 +417,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -438,110 +437,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 8b51ebd6b..b29bcc591 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md @@ -419,20 +419,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -440,110 +439,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 3b41bc8e2..1d16c0019 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md @@ -345,6 +345,22 @@ relative to one another (the target node need not be an ancestor of this node, n --- +### canExportMedia() + +• **canExportMedia**(): `boolean` + + + +**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 true if the media can be exported based on the user's entitlements. + +#### Returns + +`boolean` + +--- + ### cloneInPlace() • **cloneInPlace**(): `never` @@ -423,52 +439,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() - -• **rescaleProportionalToHeight**(`height`): `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`. - -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. - -#### Parameters - -• **height**: `number` - -#### Returns - -`void` - -#### Inherited from - -[`MediaRectangleNode`](MediaRectangleNode.md).[`rescaleProportionalToHeight`](MediaRectangleNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() +### resize() -• **rescaleProportionalToWidth**(`width`): `void` +• **resize**(`options`): `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`. -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). +Resizes this node based on the given [ResizeOptions](../type-aliases/ResizeOptions.md). #### Parameters -• **width**: `number` +• **options**: [`ResizeOptions`](../type-aliases/ResizeOptions.md) #### Returns @@ -476,78 +459,7 @@ a separate, persistent scale factor multiplier). #### Inherited from -[`MediaRectangleNode`](MediaRectangleNode.md).[`rescaleProportionalToWidth`](MediaRectangleNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`MediaRectangleNode`](MediaRectangleNode.md).[`resizeToCover`](MediaRectangleNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`MediaRectangleNode`](MediaRectangleNode.md).[`resizeToFitWithin`](MediaRectangleNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`MediaRectangleNode`](MediaRectangleNode.md).[`resize`](MediaRectangleNode.md#resize) --- 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 28fc80846..8f77cb436 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/LineNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/LineNode.md @@ -506,20 +506,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -527,110 +526,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`StrokableNode`](StrokableNode.md).[`rescaleProportionalToHeight`](StrokableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`rescaleProportionalToWidth`](StrokableNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`resizeToCover`](StrokableNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`resizeToFitWithin`](StrokableNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`StrokableNode`](StrokableNode.md).[`resize`](StrokableNode.md#resize) --- 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 9bf8166ef..1fda3eb61 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md @@ -419,20 +419,19 @@ New content to display. Currently must be a [BitmapImage](BitmapImage.md). --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -440,110 +439,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 3e92c5053..2faeb3b58 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md @@ -414,20 +414,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -435,110 +434,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 0d4664fbe..19a6b00da 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Node.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Node.md @@ -379,20 +379,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -400,97 +399,6 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res --- -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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` - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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` - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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` - -#### See - -resizeToCover - ---- - ### setPositionInParent() • **setPositionInParent**(`parentPoint`, `localRegistrationPoint`): `void` 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 7bd558fa9..396a6dd19 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/PathNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/PathNode.md @@ -437,20 +437,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -458,110 +457,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`FillableNode`](FillableNode.md).[`rescaleProportionalToHeight`](FillableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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` - - - -**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` - - - -**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) --- 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 751647e48..a0bdd83da 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md @@ -545,20 +545,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -566,110 +565,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`FillableNode`](FillableNode.md).[`rescaleProportionalToHeight`](FillableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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` - - - -**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` - - - -**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) --- 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 4a84ddbfc..f6414eb1d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md @@ -377,20 +377,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -398,110 +397,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 8aadd6b94..828423035 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md @@ -545,20 +545,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -566,110 +565,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`TextNode`](TextNode.md).[`rescaleProportionalToHeight`](TextNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`TextNode`](TextNode.md).[`rescaleProportionalToWidth`](TextNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`TextNode`](TextNode.md).[`resizeToCover`](TextNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`TextNode`](TextNode.md).[`resizeToFitWithin`](TextNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`TextNode`](TextNode.md).[`resize`](TextNode.md#resize) --- 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 fe5804588..6f41a6942 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md @@ -388,20 +388,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -409,110 +408,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 d75295f68..192078afd 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md @@ -379,20 +379,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -400,110 +399,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`StrokableNode`](StrokableNode.md).[`rescaleProportionalToHeight`](StrokableNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`rescaleProportionalToWidth`](StrokableNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`resizeToCover`](StrokableNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`StrokableNode`](StrokableNode.md).[`resizeToFitWithin`](StrokableNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`StrokableNode`](StrokableNode.md).[`resize`](StrokableNode.md#resize) --- 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 5f85df56f..b25a1bf8e 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/TextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/TextNode.md @@ -532,20 +532,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -553,110 +552,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- 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 fee6899ed..fb52fca54 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md @@ -541,20 +541,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -562,110 +561,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`TextNode`](TextNode.md).[`rescaleProportionalToHeight`](TextNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`TextNode`](TextNode.md).[`rescaleProportionalToWidth`](TextNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`TextNode`](TextNode.md).[`resizeToCover`](TextNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`TextNode`](TextNode.md).[`resizeToFitWithin`](TextNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`TextNode`](TextNode.md).[`resize`](TextNode.md#resize) --- 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 ca7570cec..39cf0c49d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md @@ -404,20 +404,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -425,110 +424,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`MediaRectangleNode`](MediaRectangleNode.md).[`rescaleProportionalToHeight`](MediaRectangleNode.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`MediaRectangleNode`](MediaRectangleNode.md).[`rescaleProportionalToWidth`](MediaRectangleNode.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`MediaRectangleNode`](MediaRectangleNode.md).[`resizeToCover`](MediaRectangleNode.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`MediaRectangleNode`](MediaRectangleNode.md).[`resizeToFitWithin`](MediaRectangleNode.md#resizetofitwithin) - -#### See - -resizeToCover +[`MediaRectangleNode`](MediaRectangleNode.md).[`resize`](MediaRectangleNode.md#resize) --- 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 1e3b9c196..3f401d042 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md @@ -358,20 +358,19 @@ removal. No-op if node is already an orphan. --- -### rescaleProportionalToHeight() +### resize() -• **rescaleProportionalToHeight**(`height`): `void` +• **resize**(`options`): `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`. -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 @@ -379,110 +378,7 @@ preserve its existing aspect ratio. See [rescaleProportionalToWidth](Node.md#res #### Inherited from -[`Node`](Node.md).[`rescaleProportionalToHeight`](Node.md#rescaleproportionaltoheight) - ---- - -### rescaleProportionalToWidth() - -• **rescaleProportionalToWidth**(`width`): `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`. - -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 - -[`Node`](Node.md).[`rescaleProportionalToWidth`](Node.md#rescaleproportionaltowidth) - ---- - -### resizeToCover() - -• **resizeToCover**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToCover`](Node.md#resizetocover) - -#### See - -resizeToFitWithin - ---- - -### resizeToFitWithin() - -• **resizeToFitWithin**(`width`, `height`): `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`. - -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 - -[`Node`](Node.md).[`resizeToFitWithin`](Node.md#resizetofitwithin) - -#### See - -resizeToCover +[`Node`](Node.md).[`resize`](Node.md#resize) --- diff --git a/src/pages/references/document-sandbox/document-apis/enumerations/ResizeBehavior.md b/src/pages/references/document-sandbox/document-apis/enumerations/ResizeBehavior.md new file mode 100644 index 000000000..b37ce135c --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/enumerations/ResizeBehavior.md @@ -0,0 +1,38 @@ +[@express-document-sdk](../overview.md) / ResizeBehavior + +# Enumeration: ResizeBehavior + + + +**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`. + +An enum for controlling the behavior of [Node.resize](../classes/Node.md#resize). + +## Enumeration Members + +### contain + +• **contain**: `"contain"` + +Resizes the node to fit entirely *within* a box of the given dimensions, keeping its 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. + +--- + +### cover + +• **cover**: `"cover"` + +Resizes the node to completely *cover* a box of the given dimensions, keeping its 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. + +--- + +### proportional + +• **proportional**: `"proportional"` + +Resizes the node to the given width or height while preserving its current aspect ratio, keeping its +topLeftLocal at a fixed location. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CommonResizeOptions.md b/src/pages/references/document-sandbox/document-apis/interfaces/CommonResizeOptions.md new file mode 100644 index 000000000..565878335 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CommonResizeOptions.md @@ -0,0 +1,25 @@ +[@express-document-sdk](../overview.md) / CommonResizeOptions + +# Interface: CommonResizeOptions + + + +**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`. + +An interface for arbitrary resize operations regardless of whether given a width or height when using [Node.resize](../classes/Node.md#resize). + +## Extended by + +- [`RescaleProportionalToWidthOptions`](RescaleProportionalToWidthOptions.md) +- [`RescaleProportionalToHeightOptions`](RescaleProportionalToHeightOptions.md) +- [`ResizeUsingWidthOptions`](ResizeUsingWidthOptions.md) +- [`ResizeUsingHeightOptions`](ResizeUsingHeightOptions.md) + +## Properties + +### avoidScalingVisualDetailsIfPossible + +• **avoidScalingVisualDetailsIfPossible**: `boolean` + +Whether to try to avoid scaling the content's visual styling (e.g. stroke width, corner detailing, etc.). +Note that some kinds of content may not be able to avoid rescaling in some scenarios. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/RescaleProportionalToHeightOptions.md b/src/pages/references/document-sandbox/document-apis/interfaces/RescaleProportionalToHeightOptions.md new file mode 100644 index 000000000..eb64bd4eb --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/RescaleProportionalToHeightOptions.md @@ -0,0 +1,46 @@ +[@express-document-sdk](../overview.md) / RescaleProportionalToHeightOptions + +# Interface: RescaleProportionalToHeightOptions + + + +**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`. + +An interface for rescaling the node based on a given height when using [Node.resize](../classes/Node.md#resize). + +## Extends + +- [`CommonResizeOptions`](CommonResizeOptions.md) + +## Properties + +### avoidScalingVisualDetailsIfPossible + +• **avoidScalingVisualDetailsIfPossible**: `boolean` + +Whether to try to avoid scaling the content's visual styling (e.g. stroke width, corner detailing, etc.). +Note that some kinds of content may not be able to avoid rescaling in some scenarios. + +#### Inherited from + +[`CommonResizeOptions`](CommonResizeOptions.md).[`avoidScalingVisualDetailsIfPossible`](CommonResizeOptions.md#avoidscalingvisualdetailsifpossible) + +--- + +### behavior + +• **behavior**: [`proportional`](../enumerations/ResizeBehavior.md#proportional) + +--- + +### height + +• **height**: `number` + +--- + +### width? + +• `optional` **width**: `undefined` + +Instead of providing a width, it will be calculated by multiplying the given height by the current aspect ratio. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/RescaleProportionalToWidthOptions.md b/src/pages/references/document-sandbox/document-apis/interfaces/RescaleProportionalToWidthOptions.md new file mode 100644 index 000000000..b24bb5f91 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/RescaleProportionalToWidthOptions.md @@ -0,0 +1,46 @@ +[@express-document-sdk](../overview.md) / RescaleProportionalToWidthOptions + +# Interface: RescaleProportionalToWidthOptions + + + +**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`. + +An interface for rescaling the node based on a given width when using [Node.resize](../classes/Node.md#resize). + +## Extends + +- [`CommonResizeOptions`](CommonResizeOptions.md) + +## Properties + +### avoidScalingVisualDetailsIfPossible + +• **avoidScalingVisualDetailsIfPossible**: `boolean` + +Whether to try to avoid scaling the content's visual styling (e.g. stroke width, corner detailing, etc.). +Note that some kinds of content may not be able to avoid rescaling in some scenarios. + +#### Inherited from + +[`CommonResizeOptions`](CommonResizeOptions.md).[`avoidScalingVisualDetailsIfPossible`](CommonResizeOptions.md#avoidscalingvisualdetailsifpossible) + +--- + +### behavior + +• **behavior**: [`proportional`](../enumerations/ResizeBehavior.md#proportional) + +--- + +### height? + +• `optional` **height**: `undefined` + +Instead of providing a height, it will be calculated by multiplying the given width by the current aspect ratio. + +--- + +### width + +• **width**: `number` diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ResizeUsingHeightOptions.md b/src/pages/references/document-sandbox/document-apis/interfaces/ResizeUsingHeightOptions.md new file mode 100644 index 000000000..81d406069 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ResizeUsingHeightOptions.md @@ -0,0 +1,46 @@ +[@express-document-sdk](../overview.md) / ResizeUsingHeightOptions + +# Interface: ResizeUsingHeightOptions + + + +**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`. + +An interface for resizing the node based on a given height when using [Node.resize](../classes/Node.md#resize). + +## Extends + +- [`CommonResizeOptions`](CommonResizeOptions.md) + +## Properties + +### avoidScalingVisualDetailsIfPossible + +• **avoidScalingVisualDetailsIfPossible**: `boolean` + +Whether to try to avoid scaling the content's visual styling (e.g. stroke width, corner detailing, etc.). +Note that some kinds of content may not be able to avoid rescaling in some scenarios. + +#### Inherited from + +[`CommonResizeOptions`](CommonResizeOptions.md).[`avoidScalingVisualDetailsIfPossible`](CommonResizeOptions.md#avoidscalingvisualdetailsifpossible) + +--- + +### behavior + +• **behavior**: [`contain`](../enumerations/ResizeBehavior.md#contain) \| [`cover`](../enumerations/ResizeBehavior.md#cover) + +--- + +### height + +• **height**: `number` + +--- + +### width? + +• `optional` **width**: `number` + +If a width is not provided, it will be calculated by multiplying the given height by the current aspect ratio. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ResizeUsingWidthOptions.md b/src/pages/references/document-sandbox/document-apis/interfaces/ResizeUsingWidthOptions.md new file mode 100644 index 000000000..6eaaae1df --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ResizeUsingWidthOptions.md @@ -0,0 +1,46 @@ +[@express-document-sdk](../overview.md) / ResizeUsingWidthOptions + +# Interface: ResizeUsingWidthOptions + + + +**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`. + +An interface for resizing the node based on a given width when using [Node.resize](../classes/Node.md#resize). + +## Extends + +- [`CommonResizeOptions`](CommonResizeOptions.md) + +## Properties + +### avoidScalingVisualDetailsIfPossible + +• **avoidScalingVisualDetailsIfPossible**: `boolean` + +Whether to try to avoid scaling the content's visual styling (e.g. stroke width, corner detailing, etc.). +Note that some kinds of content may not be able to avoid rescaling in some scenarios. + +#### Inherited from + +[`CommonResizeOptions`](CommonResizeOptions.md).[`avoidScalingVisualDetailsIfPossible`](CommonResizeOptions.md#avoidscalingvisualdetailsifpossible) + +--- + +### behavior + +• **behavior**: [`contain`](../enumerations/ResizeBehavior.md#contain) \| [`cover`](../enumerations/ResizeBehavior.md#cover) + +--- + +### height? + +• `optional` **height**: `number` + +If a height is not provided, it will be calculated by multiplying the given width by the current aspect ratio. + +--- + +### width + +• **width**: `number` diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md index 5c5e75b45..bf49f32c4 100644 --- a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md +++ b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md @@ -46,6 +46,12 @@ Re-exports [FillType](../../enumerations/FillType.md) --- +### ResizeBehavior + +Re-exports [ResizeBehavior](../../enumerations/ResizeBehavior.md) + +--- + ### SceneNodeType Re-exports [SceneNodeType](../../enumerations/SceneNodeType.md) diff --git a/src/pages/references/document-sandbox/document-apis/overview.md b/src/pages/references/document-sandbox/document-apis/overview.md index 2798ee4c4..2a44a6bdd 100644 --- a/src/pages/references/document-sandbox/document-apis/overview.md +++ b/src/pages/references/document-sandbox/document-apis/overview.md @@ -11,6 +11,7 @@ - [EditorEvent](enumerations/EditorEvent.md) - [FillRule](enumerations/FillRule.md) - [FillType](enumerations/FillType.md) +- [ResizeBehavior](enumerations/ResizeBehavior.md) - [SceneNodeType](enumerations/SceneNodeType.md) - [StrokePosition](enumerations/StrokePosition.md) - [StrokeType](enumerations/StrokeType.md) @@ -82,6 +83,7 @@ - [CharacterStylesRangeInput](interfaces/CharacterStylesRangeInput.md) - [Color](interfaces/Color.md) - [ColorFill](interfaces/ColorFill.md) +- [CommonResizeOptions](interfaces/CommonResizeOptions.md) - [ContainerNode](interfaces/ContainerNode.md) - [Fill](interfaces/Fill.md) - [IFillableNode](interfaces/IFillableNode.md) @@ -100,6 +102,10 @@ - [Rect](interfaces/Rect.md) - [RectangleGeometry](interfaces/RectangleGeometry.md) - [RemoveListStyleInput](interfaces/RemoveListStyleInput.md) +- [RescaleProportionalToHeightOptions](interfaces/RescaleProportionalToHeightOptions.md) +- [RescaleProportionalToWidthOptions](interfaces/RescaleProportionalToWidthOptions.md) +- [ResizeUsingHeightOptions](interfaces/ResizeUsingHeightOptions.md) +- [ResizeUsingWidthOptions](interfaces/ResizeUsingWidthOptions.md) - [SolidColorStroke](interfaces/SolidColorStroke.md) - [Stroke](interfaces/Stroke.md) - [StyleRange](interfaces/StyleRange.md) @@ -114,6 +120,7 @@ - [Font](type-aliases/Font.md) - [ListStyleInput](type-aliases/ListStyleInput.md) - [OrderedListStyle](type-aliases/OrderedListStyle.md) +- [ResizeOptions](type-aliases/ResizeOptions.md) - [SolidColorStrokeWithOptionalType](type-aliases/SolidColorStrokeWithOptionalType.md) - [UnorderedListStyle](type-aliases/UnorderedListStyle.md) diff --git a/src/pages/references/document-sandbox/document-apis/type-aliases/ResizeOptions.md b/src/pages/references/document-sandbox/document-apis/type-aliases/ResizeOptions.md new file mode 100644 index 000000000..b09b3f354 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/type-aliases/ResizeOptions.md @@ -0,0 +1,14 @@ +[@express-document-sdk](../overview.md) / ResizeOptions + +# Type alias: ResizeOptions + +• **ResizeOptions**: [`RescaleProportionalToWidthOptions`](../interfaces/RescaleProportionalToWidthOptions.md) \| [`RescaleProportionalToHeightOptions`](../interfaces/RescaleProportionalToHeightOptions.md) \| [`ResizeUsingWidthOptions`](../interfaces/ResizeUsingWidthOptions.md) \| [`ResizeUsingHeightOptions`](../interfaces/ResizeUsingHeightOptions.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`. + +A type union for providing the necessary arguments to [Node.resize](../classes/Node.md#resize). + +Note that some nodes only support proportional resizing. In some cases this is always true (e.g. images) while in +other cases it is due to the current visual details (e.g. the stroke being too thick to shrink the size of a shape).