Skip to content

Conversation

@vamshich13
Copy link
Collaborator

Summary

This PR introduces the createRendition API, enabling add-ons to generate image renditions of visual nodes directly from the document sandbox.

Key Changes

New API Method

  • VisualNode.createRendition(options?): Added to VisualNode and inherited by all visual node subclasses (e.g., ArtboardNode, GroupNode, RectangleNode, TextNode). This asynchronous method generates a rendition of the node and its descendants.

New Interfaces & Enumerations

  • CreateRenditionOptions: Interface defining configuration options for generating renditions.
  • CreateRenditionResult: Interface defining the structure of the returned rendition data (e.g., blob, metadata).
  • CreateRenditionFormat: New enumeration in Constants namespace specifying supported output formats (e.g., PNG, JPEG, PDF).

Documentation Updates

  • Updated 40+ class files (including ArtboardNode, GroupNode, RectangleNode, TextNode, etc.) to reflect the new createRendition method availability.
  • Updated overview.md to include references to the new interfaces and enumeration.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@vamshich13 vamshich13 requested a review from undavide February 5, 2026 12:34
@undavide undavide merged commit 212e6d5 into main Feb 6, 2026
1 of 2 checks passed
@undavide undavide deleted the vamshi/doc-changes branch February 6, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants