diff --git a/gatsby-config.js b/gatsby-config.js index f174432f9..9b3425237 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -376,6 +376,14 @@ module.exports = { title: "ContainerNode", path: "references/document-sandbox/document-apis/interfaces/ContainerNode.md", }, + { + title: "CreateRenditionOptions", + path: "references/document-sandbox/document-apis/interfaces/CreateRenditionOptions.md", + }, + { + title: "CreateRenditionResult", + path: "references/document-sandbox/document-apis/interfaces/CreateRenditionResult.md", + }, { title: "Fill", path: "references/document-sandbox/document-apis/interfaces/Fill.md", @@ -510,6 +518,10 @@ module.exports = { title: "BlendMode", path: "references/document-sandbox/document-apis/enumerations/BlendMode.md", }, + { + title: "CreateRenditionFormat", + path: "references/document-sandbox/document-apis/namespaces/Constants/enumerations/CreateRenditionFormat.md", + }, { title: "EditorEvent", path: "references/document-sandbox/document-apis/enumerations/EditorEvent.md", diff --git a/src/pages/guides/getting_started/changelog.md b/src/pages/guides/getting_started/changelog.md index 5be4a5472..662e5e01e 100644 --- a/src/pages/guides/getting_started/changelog.md +++ b/src/pages/guides/getting_started/changelog.md @@ -25,6 +25,19 @@ contributors: # Changelog +## 2026-02-06 + +### Added + +We have added new APIs to generate image rendition of visual nodes directly from the document sandbox. + +- **Experimental** [`VisualNode.createRendition()`](../../references/document-sandbox/document-apis/classes/VisualNode.md#createrendition) asynchronous method - Generate a rendition of a visual node and its descendants. +- **Experimental** [`CreateRenditionOptions`](../../references/document-sandbox/document-apis/interfaces/CreateRenditionOptions.md) interface - define configuration options for generating renditions. +- **Experimental** [`CreateRenditionResult`](../../references/document-sandbox/document-apis/interfaces/CreateRenditionResult.md) interface - define the structure of the returned rendition data (e.g., blob, metadata). +- **Experimental** [`CreateRenditionFormat`](../../references/document-sandbox/document-apis/namespaces/Constants/enumerations/CreateRenditionFormat.md) enumeration - specify supported output formats (e.g., PNG, JPEG, PDF) in the `Constants` namespace. + +- **Experimental** [`addOnUISdk.app.document.isPresentation()`](../../references/addonsdk/app-document.md#ispresentation) asynchronous method - Returns `true` if the document is a presentation, `false` if not. + ## 2026-01-26 ### Added diff --git a/src/pages/references/addonsdk/app-document.md b/src/pages/references/addonsdk/app-document.md index 47912b624..6f497e9ea 100644 --- a/src/pages/references/addonsdk/app-document.md +++ b/src/pages/references/addonsdk/app-document.md @@ -217,7 +217,7 @@ Retrieve the details about the template used to create the document. #### `PrintQualityCheckOptions` -The options to pass into the print quality check.. +The options to pass into the print quality check. | Name | Type | Description | | ---------- | -------------------------------------------- | --------------------------------------------------------------------- | @@ -228,30 +228,30 @@ The options to pass into the print quality check.. The metadata of a page. -| Name | Type | Description | -| -------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `id` | `string` | The id of the page. | -| `title` | `string` | The title of the page. | -| `size` | `{ width: number, height: number }` | The size of the page in pixels. | -| `hasPremiumContent` | `boolean` | `true` if the page has premium content, `false` if not. | -| `hasAudioContent` | `boolean` | `true` if the page has audio content, `false` if not. | -| `hasVideoContent` | `boolean` | `true` if the page has video content, `false` if not. | -| `hasAnimatedContent` | `boolean` | `true` if the page has animated content, `false` if not. | -| `hasTemporalContent` | `boolean` | `true` if the page has timelines, `false` if not. | -| `temporalContentDuration?` | `number` | The duration of temporal content in milliseconds (only present when `hasTemporalContent` is `true`). | -| `pixelsPerInch?` | `number` | The pixels per inch of the page. | -| `isPrintReady?` | `boolean` | Indicates whether the page has passed various internal quality checks to ensure high quality output when printed. While the specifics may change over time, Adobe Express checks for sufficient image resolution and sizes to ensure that a print will be of good quality. If this is `false`, the output may be blurry or of poor quality (based on internal heuristics). | -| `isBlank?` | `boolean` | Indicates whether the page is blank. | -| `templateDetails?` | `TemplateDetails` | The details of the template for the page. | +| Name | Type | Description | +| -------------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `id` | `string` | The id of the page. | +| `title` | `string` | The title of the page. | +| `size` | `{ width: number, height: number }` | The size of the page in pixels. | +| `hasPremiumContent` | `boolean` | `true` if the page has premium content, `false` if not. | +| `hasAudioContent` | `boolean` | `true` if the page has audio content, `false` if not. | +| `hasVideoContent` | `boolean` | `true` if the page has video content, `false` if not. | +| `hasAnimatedContent` | `boolean` | `true` if the page has animated content, `false` if not. | +| `hasTemporalContent` | `boolean` | `true` if the page has timelines, `false` if not. | +| `temporalContentDuration?` | `number` | The duration of temporal content in milliseconds (only present when `hasTemporalContent` is `true`). | +| `pixelsPerInch?` | `number` | The pixels per inch of the page. | +| `isPrintReady?` | `boolean` | Indicates whether the page has passed various internal quality checks to ensure high quality output when printed. While the specifics may change over time, Adobe Express checks for sufficient image resolution and sizes to ensure that a print will be of good quality. If this is `false`, the output may be blurry or of poor quality (based on internal heuristics). | +| `isBlank?` | `boolean` | Indicates whether the page is blank. | +| `templateDetails?` | `TemplateDetails` | The details of the template for the page. | #### `PageMetadataOptions` This object is passed as a parameter to the [`getPagesMetadata`](#getpagesmetadata) method and includes the range and optional `pageIds` for which you want to retrieve metadata for. -| Name | Type | Description | -| -------------------- | ------------------------------------------------------ | --------------------------------------------------------------------: | +| Name | Type | Description | +| -------------------- | -------------------------------------------- | --------------------------------------------------------------------: | | `range` | [`Range`](../addonsdk/addonsdk-constants.md) | Range of the document to get the metadata | -| `pageIds?: string[]` | `string` | Id's of the pages. (Only required when the range is `specificPages`). | +| `pageIds?: string[]` | `string` | Id's of the pages. (Only required when the range is `specificPages`). | ### getSelectedPageIds() @@ -278,7 +278,7 @@ async function getSelectedPages() { try { const selectedPageIds = await addOnUISdk.app.document.getSelectedPageIds(); console.log("Selected page ids:", selectedPageIds); - + if (selectedPageIds.length === 0) { console.log("No pages are currently selected"); } else { @@ -293,13 +293,13 @@ async function getSelectedPages() { async function getSelectedPagesMetadata() { try { const selectedPageIds = await addOnUISdk.app.document.getSelectedPageIds(); - + if (selectedPageIds.length > 0) { const metadata = await addOnUISdk.app.document.getPagesMetadata({ range: addOnUISdk.constants.Range.specificPages, pageIds: selectedPageIds }); - + metadata.forEach((page, index) => { console.log(`Selected page ${index + 1}: ${page.title} (${page.id})`); }); @@ -338,6 +338,10 @@ A `documentLinkAvailable` or `documentPublishedLinkAvailable` event is triggered #### Example Usage + + +#### JavaScript + ```javascript import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js"; @@ -374,6 +378,42 @@ The options to pass into the link method. | ------------- | -------- | -------------------------------------------------------- | | `linkOptions` | `string` | [`LinkOptions`](./addonsdk-constants.md) constant value. | +### isPresentation() + +Returns `true` if the document is a presentation. + + + +**IMPORTANT:** This method 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 this method, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../references/manifest/index.md#requirements) section of the `manifest.json`. + +#### Signature + +`isPresentation(): Promise` + +#### Return Value + +A resolved `Promise` containing `true` if the document is a presentation, `false` if not. + +#### Example Usage + + + +#### JavaScript + +```javascript +import addOnUISdk from "https://express.adobe.com/static/add-on-sdk/sdk.js"; + +addOnUISdk.ready.then(async () => { + try { + // Get if the document is a presentation + const isPresentation = await addOnUISdk.app.document.isPresentation(); + console.log("Is presentation:", isPresentation); + } catch (error) { + console.log("Failed to get is presentation:", error); + } +}); +``` + ## Import Content Methods ### addImage() @@ -386,11 +426,11 @@ Adds an image/gif/PSD/AI/SVG file to the current page. #### Parameters -| Name | Type | Description | -| ------------------ | ------------------------------------------- | ---------------------------------------------------------------------------------------: | -| `imageBlob` | `Blob` | The image to add to the page. | -| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes that can be passed when adding image/PSD/AI/SVG files to the page (i.e., `title`). | -| `importAddOnData?` | [`ImportAddOnData`](#importaddondata) | Add-on specific metadata to attach to the imported asset. | +| Name | Type | Description | +| ------------------ | ------------------------------------- | --------------------------------------------------------------------------------------------: | +| `imageBlob` | `Blob` | The image to add to the page. | +| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes that can be passed when adding image/PSD/AI/SVG files to the page (i.e., `title`). | +| `importAddOnData?` | [`ImportAddOnData`](#importaddondata) | Add-on specific metadata to attach to the imported asset. | #### Return Value @@ -455,11 +495,11 @@ Adds an animated image (gif) to the current page. #### Parameters -| Name | Type | Description | -| ------------------ | ------------------------------------------- | -----------------------------------------------------------------------------------: | -| `imageBlob` | `Blob` | The image to add to the page. | -| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes that can be passed when adding animated gifs to the page (i.e., `title`). | -| `importAddOnData?` | [`ImportAddOnData`](#importaddondata) | Add-on specific metadata to attach to the imported asset. | +| Name | Type | Description | +| ------------------ | ------------------------------------- | -----------------------------------------------------------------------------------: | +| `imageBlob` | `Blob` | The image to add to the page. | +| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes that can be passed when adding animated gifs to the page (i.e., `title`). | +| `importAddOnData?` | [`ImportAddOnData`](#importaddondata) | Add-on specific metadata to attach to the imported asset. | #### Return Value @@ -492,11 +532,11 @@ Adds a video to the current page. #### Parameters -| Name | Type | Description | -| ------------------ | ------------------------------------------- | -----------------------------------------------------------------------------------: | -| `videoBlob` | `Blob` | The video to add to the page. | -| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes that can be passed when adding video files to the page (i.e., `title`). | -| `importAddOnData?` | [`ImportAddOnData`](#importaddondata) | Add-on specific metadata to attach to the imported asset. | +| Name | Type | Description | +| ------------------ | ------------------------------------- | ---------------------------------------------------------------------------------: | +| `videoBlob` | `Blob` | The video to add to the page. | +| `attributes?` | [`MediaAttributes`](#mediaattributes) | Attributes that can be passed when adding video files to the page (i.e., `title`). | +| `importAddOnData?` | [`ImportAddOnData`](#importaddondata) | Add-on specific metadata to attach to the imported asset. | #### Example Usage @@ -571,10 +611,10 @@ async function addAudioFromURL(url) { Represents add-on-specific data that can be attached to imported media assets (nodes). This data provides a way for add-ons to store custom metadata with imported assets across multiple import APIs. Note: This support is not present for PSD/AI assets. -| Name | Type | Description | -| ----------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| `nodeAddOnData?` | `Record` | Node-specific add-on data that persists with the individual asset container. This data remains attached to the container node even when the asset content is replaced. This data can be accessed later via document sandbox `MediaContainerNode.addOnData` API. | -| `mediaAddOnData?` | `Record` | Media-specific add-on data that is tied to the actual asset content. This data is shared across all copies of the same asset throughout the document and will be reset if the asset content is replaced with different media. This data can be accessed later via document sandbox `MediaRectangleNode.mediaAddOnData` API. | +| Name | Type | Description | +| ----------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `nodeAddOnData?` | `Record` | Node-specific add-on data that persists with the individual asset container. This data remains attached to the container node even when the asset content is replaced. This data can be accessed later via document sandbox `MediaContainerNode.addOnData` API. | +| `mediaAddOnData?` | `Record` | Media-specific add-on data that is tied to the actual asset content. This data is shared across all copies of the same asset throughout the document and will be reset if the asset content is replaced with different media. This data can be accessed later via document sandbox `MediaRectangleNode.mediaAddOnData` API. | @@ -839,8 +879,8 @@ Extends the [`RenditionOptions`](#renditionoptions) object and adds the followin Extends the [`RenditionOptions`](#renditionoptions) object with the specific format for `pptx` renditions: -| Name | Type | Description | -| -------- | -------- | -----------------------------------------------------------------------------------------------: | +| Name | Type | Description | +| -------- | -------- | --------------------------------------------------------------------------------------------: | | `format` | `string` | [`RenditionFormat.pptx`](./addonsdk-constants.md) constant value for PowerPoint presentation. | @@ -860,9 +900,9 @@ Extends the [`RenditionOptions`](#renditionoptions) object and adds the followin Represents a _bleed_ for a page. In printing, _bleed_ is printing that goes beyond the edge of where the sheet will be trimmed. In other words, the bleed is the area to be trimmed off. If the value is left undefined, then no bleed will be assumed. -| Name | Type | Description | -| --------- | ---------------------------------------------------------- | -----------------------------------------------: | -| `amount?` | `number` | The amount for the bleed. | +| Name | Type | Description | +| --------- | ------------------------------------------------ | -----------------------------------------------: | +| `amount?` | `number` | The amount for the bleed. | | `unit` | [`BleedUnit`](../addonsdk/addonsdk-constants.md) | The unit in which the bleed amount is expressed. | #### `PdfPageBoxes` @@ -956,7 +996,7 @@ async function exportAsPowerPoint() { renditionOptions, addOnUISdk.constants.RenditionIntent.export ); - + // Download the PPTX file const rendition = renditions[0]; // PPTX exports as single file const url = URL.createObjectURL(rendition.blob); @@ -1012,7 +1052,7 @@ async function exportAsPowerPoint() { renditionOptions, RenditionIntent.export ); - + // Download the PPTX file const rendition = renditions[0]; // PPTX exports as single file const url = URL.createObjectURL(rendition.blob); diff --git a/src/pages/references/changelog.md b/src/pages/references/changelog.md index 0c14a5a4b..84270247c 100644 --- a/src/pages/references/changelog.md +++ b/src/pages/references/changelog.md @@ -25,6 +25,19 @@ contributors: # Changelog +## 2026-02-06 + +### Added + +We have added new APIs to generate image rendition of visual nodes directly from the document sandbox. + +- **Experimental** [`VisualNode.createRendition()`](../references/document-sandbox/document-apis/classes/VisualNode.md#createrendition) asynchronous method - Generate a rendition of a visual node and its descendants. +- **Experimental** [`CreateRenditionOptions`](../references/document-sandbox/document-apis/interfaces/CreateRenditionOptions.md) interface - define configuration options for generating renditions. +- **Experimental** [`CreateRenditionResult`](../references/document-sandbox/document-apis/interfaces/CreateRenditionResult.md) interface - define the structure of the returned rendition data (e.g., blob, metadata). +- **Experimental** [`CreateRenditionFormat`](../references/document-sandbox/document-apis/namespaces/Constants/enumerations/CreateRenditionFormat.md) enumeration - specify supported output formats (e.g., PNG, JPEG, PDF) in the `Constants` namespace. + +- **Experimental** [`addOnUISdk.app.document.isPresentation()`](../references/addonsdk/app-document.md#ispresentation) asynchronous method - Returns `true` if the document is a presentation, `false` if not. + ## 2026-01-26 ### Added diff --git a/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md b/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md index fa5db05cc..85845c8bb 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md @@ -251,6 +251,37 @@ To resize an artboard, resize the parent [PageNode](PageNode.md). ## Methods +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Implementation of + +[`ContainerNode`](../interfaces/ContainerNode.md).[`createRendition`](../interfaces/ContainerNode.md#createrendition) + +#### Inherited from + +[`VisualNode`](VisualNode.md).[`createRendition`](VisualNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 fc98513ee..649ef018f 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ComplexShapeNode.md @@ -399,6 +399,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`FillableNode`](FillableNode.md).[`createRendition`](FillableNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/classes/Context.md b/src/pages/references/document-sandbox/document-apis/classes/Context.md index 81f863f8d..046156ce4 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Context.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Context.md @@ -108,7 +108,9 @@ Callback that was previously registered will be removed and will no more be invo Registers a handler for editor events such as selection change. The registered callback will be invoked when the specified event occurs. - + + + Note: Do not attempt to make changes to the document in response to a selection change callback because it may destabilize the application. #### Parameters diff --git a/src/pages/references/document-sandbox/document-apis/classes/Editor.md b/src/pages/references/document-sandbox/document-apis/classes/Editor.md index 4bbddc9c9..e1911a2c5 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Editor.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Editor.md @@ -182,7 +182,7 @@ the initial string to show. a text node with default styles. Creates auto-width text, so the node's width will automatically adjust to accommodate the given text content. - + Note: the registration point of this text node is not guaranteed to be at the top-left of the bounding box of its insertion parent. Recommend using `setPositionInParent` over `translation` to set the position. 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 653e1bf98..798d2a0c9 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/EllipseNode.md @@ -442,6 +442,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`FillableNode`](FillableNode.md).[`createRendition`](FillableNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/classes/ExpressContext.md b/src/pages/references/document-sandbox/document-apis/classes/ExpressContext.md index 674b82501..484e30504 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ExpressContext.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ExpressContext.md @@ -125,7 +125,9 @@ Callback that was previously registered will be removed and will no more be invo Registers a handler for editor events such as selection change. The registered callback will be invoked when the specified event occurs. - + + + Note: Do not attempt to make changes to the document in response to a selection change callback because it may destabilize the application. #### Parameters diff --git a/src/pages/references/document-sandbox/document-apis/classes/ExpressEditor.md b/src/pages/references/document-sandbox/document-apis/classes/ExpressEditor.md index 9e41ab0e3..3dd51f4bd 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ExpressEditor.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ExpressEditor.md @@ -210,7 +210,7 @@ the initial string to show. a text node with default styles. Creates auto-width text, so the node's width will automatically adjust to accommodate the given text content. - + Note: the registration point of this text node is not guaranteed to be at the top-left of the bounding box of its insertion parent. Recommend using `setPositionInParent` over `translation` to set the position. 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 f951f74c7..e0584f48f 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/FillableNode.md @@ -409,6 +409,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`StrokableNode`](StrokableNode.md).[`createRendition`](StrokableNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 bf0d5e01b..3d790adf5 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GridCellNode.md @@ -391,6 +391,33 @@ Use the parent grid container instead. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 d58b35660..66cfafa7d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GridLayoutNode.md @@ -419,6 +419,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 93414a0ae..1343ef5ca 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/GroupNode.md @@ -413,6 +413,37 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Implementation of + +[`ContainerNode`](../interfaces/ContainerNode.md).[`createRendition`](../interfaces/ContainerNode.md#createrendition) + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 56624f635..c09ee4180 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ImageRectangleNode.md @@ -425,6 +425,33 @@ Clone the entire parent MediaContainerNode instead. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`MediaRectangleNode`](MediaRectangleNode.md).[`createRendition`](MediaRectangleNode.md#createrendition) + +--- + ### fetchBitmapImage() • **fetchBitmapImage**(): `Promise`<[`BitmapImage`](BitmapImage.md)\> 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 79a241c9d..d6e6650ae 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/LineNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/LineNode.md @@ -508,6 +508,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`StrokableNode`](StrokableNode.md).[`createRendition`](StrokableNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 ad76dec89..0a3ab2a48 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/MediaContainerNode.md @@ -397,6 +397,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 c6576b1a0..3cd993d54 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/MediaRectangleNode.md @@ -416,6 +416,33 @@ Clone the entire parent MediaContainerNode instead. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 29d8c6738..933a4f14f 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/Node.md +++ b/src/pages/references/document-sandbox/document-apis/classes/Node.md @@ -377,6 +377,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`VisualNode`](VisualNode.md).[`createRendition`](VisualNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/classes/PageNode.md b/src/pages/references/document-sandbox/document-apis/classes/PageNode.md index 022454e6c..f6a82f6fd 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/PageNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/PageNode.md @@ -117,6 +117,7 @@ All Artboards within a page share the same dimensions, so changing this value wi size of every child [ArtboardNode](ArtboardNode.md). + Note: changing the page's size does not adjust the size or position of any of visual content inside any child [ArtboardNode](ArtboardNode.md). Callers should use their own layout logic to update the content for the new bounds as desired. For example, making the size smaller could result in content being clipped and hard to access if it is @@ -206,6 +207,7 @@ All Artboards within a page share the same dimensions, so changing this value wi size of every child [ArtboardNode](ArtboardNode.md). + Note: changing the page's size does not adjust the size or position of any of visual content inside any child [ArtboardNode](ArtboardNode.md). Callers should use their own layout logic to update the content for the new bounds as desired. For example, making the size smaller could result in content being clipped and hard to access if it is diff --git a/src/pages/references/document-sandbox/document-apis/classes/PathNode.md b/src/pages/references/document-sandbox/document-apis/classes/PathNode.md index c0002f622..4926ccef1 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/PathNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/PathNode.md @@ -439,6 +439,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`FillableNode`](FillableNode.md).[`createRendition`](FillableNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md b/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md index 44e9f01e0..011e5bd6d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ReadOnlyItemList.md @@ -14,7 +14,7 @@ capabilities, and is most frequently encountered as [ArtboardNode.children](Artb ## Type parameters -• **T** _extends_ [`ListItem`](../interfaces/ListItem.md) +• **T** *extends* [`ListItem`](../interfaces/ListItem.md) ## Accessors 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 e05d14d7a..2f0bd9525 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/RectangleNode.md @@ -534,6 +534,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`FillableNode`](FillableNode.md).[`createRendition`](FillableNode.md#createrendition) + +--- + ### getUniformCornerRadius() • **getUniformCornerRadius**(): `undefined` \| `number` diff --git a/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md b/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md index 95961f197..7c28e68ad 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md +++ b/src/pages/references/document-sandbox/document-apis/classes/RestrictedItemList.md @@ -17,7 +17,7 @@ reordered. The [ItemList](ItemList.md) subclass adds more capabilities, however. ## Type parameters -• **T** _extends_ [`ListItem`](../interfaces/ListItem.md) +• **T** *extends* [`ListItem`](../interfaces/ListItem.md) ## Accessors 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 82b2d351f..c3abc7234 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/SolidColorShapeNode.md @@ -379,6 +379,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 17a2ee2e9..76c88326c 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md @@ -123,6 +123,8 @@ even for an orphan node with no parent. `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -384,9 +386,13 @@ boundsInParent. `Readonly`<[`Point`](../interfaces/Point.md)\> + + Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + + Note: this value is usually not (0,0) due to the way text layout is defined. --- @@ -480,6 +486,8 @@ relative to one another (the target node need not be an ancestor of this node, n `Readonly`<[`Rect`](../interfaces/Rect.md)\> + + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this method only when the node is placed on a page. @@ -507,6 +515,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`TextNode`](TextNode.md).[`createRendition`](TextNode.md#createrendition) + +--- + ### isStandaloneText() • **isStandaloneText**(): `this is StandaloneTextNode` 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 39b58ef04..78be9e81a 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StrokableNode.md @@ -390,6 +390,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 4f60e3b34..bd0e8e57d 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/StrokeShapeNode.md @@ -381,6 +381,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`StrokableNode`](StrokableNode.md).[`createRendition`](StrokableNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 bd70ed964..dd4ac7cf5 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/TextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/TextNode.md @@ -155,10 +155,12 @@ The top-left corner of the bounding box corresponds to the visual top-left corne `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + Note: the visual top-left corner of this box is usually not (0,0). Always use `boundsLocal` or [topLeftLocal](TextNode.md#topleftlocal) instead of assuming (0,0). @@ -175,6 +177,7 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -189,6 +192,7 @@ this specific TextNode "frame." The full text content flow may be split across m fixed-size frame using [AreaTextLayout](../interfaces/AreaTextLayout.md) does not fit all the (remaining) text. + Note: When traversing the scenegraph in search of text content, bear in mind that multiple TextNodes may refer to the same single [TextNodeContentModel](TextNodeContentModel.md); this can give the impression that the same text is duplicated multiple times when it is not. Use [TextNodeContentModel](TextNodeContentModel.md).id to determine whether a given piece of text content is unique or if it's already been @@ -385,10 +389,12 @@ boundsInParent. `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + Note: this value is usually not (0,0) due to the way text layout is defined. --- @@ -483,6 +489,7 @@ relative to one another (the target node need not be an ancestor of this node, n `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this method only when the node is placed on a page. @@ -510,6 +517,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### isStandaloneText() • **isStandaloneText**(): `this is StandaloneTextNode` 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 d162b7f27..9b1b6cccb 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md @@ -124,6 +124,7 @@ even for an orphan node with no parent. `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -145,10 +146,12 @@ The top-left corner of the bounding box corresponds to the visual top-left corne `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + Note: the visual top-left corner of this box is usually not (0,0). Always use `boundsLocal` or [topLeftLocal](TextNode.md#topleftlocal) instead of assuming (0,0). @@ -165,6 +168,7 @@ Position of the node's centerpoint in its own local coordinate space, i.e. the c `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is recommended to use this property only when the node is placed on a page. @@ -179,6 +183,7 @@ this specific ThreadedTextNode "frame." The full text content flow may be split fixed-size frame using [AreaTextLayout](../interfaces/AreaTextLayout.md) does not fit all the (remaining) text. + Note: When traversing the scenegraph in search of text content, bear in mind that multiple ThreadedTextNodes may refer to the same single [ThreadedTextContentModel](ThreadedTextContentModel.md); this can give the impression that the same text is duplicated multiple times when it is not. Use [ThreadedTextContentModel](ThreadedTextContentModel.md).id to determine whether a given piece of text content is unique or if it's already been @@ -384,10 +389,12 @@ boundsInParent. `Readonly`<[`Point`](../interfaces/Point.md)\> + Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a page. It is recommended to use this property only when the node is placed on a page. + Note: this value is usually not (0,0) due to the way text layout is defined. --- @@ -482,6 +489,7 @@ relative to one another (the target node need not be an ancestor of this node, n `Readonly`<[`Rect`](../interfaces/Rect.md)\> + Note: The bounding box of an orphaned TextNode may become different after it is placed on a page. It is recommended to use this method only when the node is placed on a page. @@ -509,6 +517,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`TextNode`](TextNode.md).[`createRendition`](TextNode.md#createrendition) + +--- + ### isStandaloneText() • **isStandaloneText**(): `this is StandaloneTextNode` 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 e012ae5ca..3acdff489 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/UnknownMediaRectangleNode.md @@ -406,6 +406,33 @@ Clone the entire parent MediaContainerNode instead. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`MediaRectangleNode`](MediaRectangleNode.md).[`createRendition`](MediaRectangleNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> 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 d89bcb507..c100c44d2 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/UnknownNode.md @@ -360,6 +360,33 @@ The node must be attached to a page as the copy will be added as a sibling. --- +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +#### Inherited from + +[`Node`](Node.md).[`createRendition`](Node.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/classes/VisualNode.md b/src/pages/references/document-sandbox/document-apis/classes/VisualNode.md index 080a511f7..6d1ced197 100644 --- a/src/pages/references/document-sandbox/document-apis/classes/VisualNode.md +++ b/src/pages/references/document-sandbox/document-apis/classes/VisualNode.md @@ -201,6 +201,29 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s ## Methods +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](../interfaces/CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](../interfaces/CreateRenditionResult.md)\> + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md b/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md index e2e6152b8..1a3330ca9 100644 --- a/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md +++ b/src/pages/references/document-sandbox/document-apis/enumerations/BlendMode.md @@ -92,6 +92,7 @@ interacts with other siblings within the same container. See documentation below The normal, default blend mode for leaf nodes. + Note: Group nodes default to using `passThrough` blend mode instead. See below. --- diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md index 96f89423c..8734c8c07 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRange.md @@ -64,7 +64,9 @@ Size of the text in points. • **length**: `number` The length or number of characters in which character styles will be applied. + + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md index 50a0db2e5..15836fb09 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CharacterStylesRangeInput.md @@ -65,7 +65,9 @@ Size of the text in points. • **length**: `number` The length or number of characters in which character styles will be applied. + + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ContainerNode.md b/src/pages/references/document-sandbox/document-apis/interfaces/ContainerNode.md index c2cea32d9..5f1356e0c 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ContainerNode.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ContainerNode.md @@ -203,6 +203,33 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s ## Methods +### createRendition() + +• **createRendition**(`options`?): `Promise`<[`CreateRenditionResult`](CreateRenditionResult.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`. + +Generates a rendition of this node and its descendants. + +If this node contains images, it will wait for the best quality to be available before capturing. +As such, there is a 20s timeout before an error is thrown to prevent indefinite waiting. + +#### Parameters + +• **options?**: [`CreateRenditionOptions`](CreateRenditionOptions.md) + +#### Returns + +`Promise`<[`CreateRenditionResult`](CreateRenditionResult.md)\> + +#### Inherited from + +[`VisualNode`](../classes/VisualNode.md).[`createRendition`](../classes/VisualNode.md#createrendition) + +--- + ### localPointInNode() • **localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](Point.md)\> diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CreateRenditionOptions.md b/src/pages/references/document-sandbox/document-apis/interfaces/CreateRenditionOptions.md new file mode 100644 index 000000000..fb8aa735c --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CreateRenditionOptions.md @@ -0,0 +1,25 @@ +[@express-document-sdk](../overview.md) / CreateRenditionOptions + +# Interface: CreateRenditionOptions + + + +**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 configuring [VisualNode.createRendition](../classes/VisualNode.md#createrendition). + +## Properties + +### format? + +• `optional` **format**: [`CreateRenditionFormat`](../namespaces/Constants/enumerations/CreateRenditionFormat.md) + +Whether to output in PNG or JPEG format. Defaults to PNG. + +--- + +### scale? + +• `optional` **scale**: `number` + +The scale factor to apply to the content before it is rendered. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/CreateRenditionResult.md b/src/pages/references/document-sandbox/document-apis/interfaces/CreateRenditionResult.md new file mode 100644 index 000000000..6ef7e04f3 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/interfaces/CreateRenditionResult.md @@ -0,0 +1,27 @@ +[@express-document-sdk](../overview.md) / CreateRenditionResult + +# Interface: CreateRenditionResult + + + +**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 the result of [VisualNode.createRendition](../classes/VisualNode.md#createrendition). + +## Properties + +### blob? + +• `optional` **blob**: `Blob` + +The PNG or JPEG data for the rendition. + +--- + +### drawBoundsGlobal? + +• `optional` **drawBoundsGlobal**: [`Rect`](Rect.md) + +The bounds of the rendition in the global coordinate space. +This may be larger than the [VisualNode.boundsLocal](../classes/VisualNode.md#boundslocal) due to rotations, borders, filters, or other effects. +Only provided if the [VisualNode](../classes/VisualNode.md) is not orphaned. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md index 84c22ed3c..3282b340d 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRange.md @@ -15,7 +15,9 @@ A set of [ParagraphStyles](ParagraphStyles.md) along with the text range they ap • **length**: `number` The length or number of characters in which character styles will be applied. + + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md index 8ae80a5ce..bad84e30e 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/ParagraphStylesRangeInput.md @@ -18,7 +18,9 @@ Paragraphs are separated by newline characters (`\n`). Ranges specified here sho • **length**: `number` The length or number of characters in which character styles will be applied. + + Note: since characters are represented as UTF-16 code units, some symbols such as emojis are considered to have a length of 2. diff --git a/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md b/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md index e4a70e4f0..a766dcdc1 100644 --- a/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md +++ b/src/pages/references/document-sandbox/document-apis/interfaces/StyleRange.md @@ -18,6 +18,7 @@ Represents a range of characters defined by a length (and implicitly started at • **length**: `number` The length or number of characters in which character styles will be applied. + Note: since characters are represented as UTF-16 code units, some symbols diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/CreateRenditionFormat.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/CreateRenditionFormat.md new file mode 100644 index 000000000..9f88c9d71 --- /dev/null +++ b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/CreateRenditionFormat.md @@ -0,0 +1,21 @@ +[@express-document-sdk](../../../overview.md) / [Constants](../overview.md) / CreateRenditionFormat + +# Enumeration: CreateRenditionFormat + + + +**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../manifest/index.md#requirements) section of the `manifest.json`. + +The format of the rendition output. + +## Enumeration Members + +### jpeg + +• **jpeg**: `"jpeg"` + +--- + +### png + +• **png**: `"png"` diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md index 267e11c06..096fe8c92 100644 --- a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md +++ b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/enumerations/TextStyleSource.md @@ -4,7 +4,7 @@ -**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../../references/manifest/index.md#requirements) section of the `manifest.json`. +**IMPORTANT:** This is currently ***experimental only*** and should not be used in any add-ons you will be distributing until it has been declared stable. To use it, you will first need to set the `experimentalApis` flag to `true` in the [`requirements`](../../../../../manifest/index.md#requirements) section of the `manifest.json`. Indicates which existing text to match the style of when inserting new text or replacing text. diff --git a/src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md b/src/pages/references/document-sandbox/document-apis/namespaces/Constants/overview.md index bf49f32c4..341f7fec9 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 @@ -1,7 +1,3 @@ -[**@express-document-sdk**](../../overview.md) • **Docs** - ---- - [@express-document-sdk](../../overview.md) / Constants # Namespace: Constants @@ -10,6 +6,7 @@ ### Enumerations +- [CreateRenditionFormat](enumerations/CreateRenditionFormat.md) - [OrderedListNumbering](enumerations/OrderedListNumbering.md) - [ParagraphListType](enumerations/ParagraphListType.md) - [TextStyleSource](enumerations/TextStyleSource.md) diff --git a/src/pages/references/document-sandbox/document-apis/overview.md b/src/pages/references/document-sandbox/document-apis/overview.md index 7597d89e8..6268581c7 100644 --- a/src/pages/references/document-sandbox/document-apis/overview.md +++ b/src/pages/references/document-sandbox/document-apis/overview.md @@ -86,6 +86,8 @@ - [ColorFill](interfaces/ColorFill.md) - [CommonResizeOptions](interfaces/CommonResizeOptions.md) - [ContainerNode](interfaces/ContainerNode.md) +- [CreateRenditionOptions](interfaces/CreateRenditionOptions.md) +- [CreateRenditionResult](interfaces/CreateRenditionResult.md) - [Fill](interfaces/Fill.md) - [IFillableNode](interfaces/IFillableNode.md) - [IMediaContainerNode](interfaces/IMediaContainerNode.md) @@ -129,6 +131,12 @@ ## References +### CreateRenditionFormat + +Re-exports [CreateRenditionFormat](namespaces/Constants/enumerations/CreateRenditionFormat.md) + +--- + ### OrderedListNumbering Re-exports [OrderedListNumbering](namespaces/Constants/enumerations/OrderedListNumbering.md)