Doc updates for Document Sandbox APIs #94
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vamshich13
changed the title
padmkris123
reviewed
Sep 30, 2024
src/pages/references/changelog.md
Outdated
| ## 2024-09-30 | ||
|
|
||
| - Added many new **Text APIs** for improved text management. | ||
| - New [`TextNode.fullContent`](./document-sandbox/document-apis/classes/TextNode.md#fullcontent) accessor: returns the [`TextContentModel`](./document-sandbox/document-apis/classes/TextContentModel.md) containing the complete text string and its styles. `fullContent.text` supersedes `TextNode.text`, now deprecated. |
There was a problem hiding this comment.
...returns the TextContentModel containing the complete text string and its styles associated to the Text Flow (aka Threaded Text or Overflow Text).
There was a problem hiding this comment.
Am wondering if we should have a separate section for deprecated methods to highlight it.
There was a problem hiding this comment.
Added the new text, moved the deprecation in an independent section.
padmkris123
reviewed
Sep 30, 2024
src/pages/references/changelog.md
Outdated
| - Added many new **Text APIs** for improved text management. | ||
| - New [`TextNode.fullContent`](./document-sandbox/document-apis/classes/TextNode.md#fullcontent) accessor: returns the [`TextContentModel`](./document-sandbox/document-apis/classes/TextContentModel.md) containing the complete text string and its styles. `fullContent.text` supersedes `TextNode.text`, now deprecated. | ||
| - New [`TextNode.layout`](./document-sandbox/document-apis/classes/TextNode.md#layout) accessor: gets and sets the [`TextType`](./document-sandbox/document-apis/enumerations/TextType.md) of the text node frame. | ||
| - New [`TextNode.nextTextNode`](./document-sandbox/document-apis/classes/TextNode.md#nexttextnode) accessor: gets the newxt node that overflowing text will spill into. |
There was a problem hiding this comment.
Typo 'newxt'.
Can we move this to the second place so that all threaded text related points are next to each other?
padmkris123
reviewed
Sep 30, 2024
src/pages/references/changelog.md
Outdated
| - New supporting interfaces, enumerations and type aliases. | ||
| - Added **Per Element Metadata APIs**: with this feature, add-ons can store private metadata to any node of the Express document. This metadata is accessible only to the add-on that has set it. See the [`AddOnData`](./document-sandbox/document-apis/classes/AddOnData.md) class and the [`addOnData`](./document-sandbox/document-apis/classes/BaseNode.md#addondata) accessor for the BaseNode class. | ||
| - Added **Selection Change Notification Events APIs**: add-on can register to be notified when selection and properties in the selection changes on the document. The [`Context`](./document-sandbox/document-apis/classes/Context.md) class will expose two [`on()`](./document-sandbox/document-apis/classes/Context.md#on) and [`off()`](./document-sandbox/document-apis/classes/Context.md#off) methods which can be used to register and un-register selection change and selection properties change notifications. | ||
| - Added a new [`GridCellNode`](./document-sandbox/document-apis/classes/GridCellNode.md) class that represents a cell in a grid. |
There was a problem hiding this comment.
Lets also call out the fix for allchildren() which will return the GridCellNode in a logical order from left to right and top to bottom.
padmkris123
reviewed
Oct 2, 2024
|
|
||
| #### Returns | ||
|
|
||
| `Promise`<`undefined` \| [`AvailableFont`](AvailableFont.md)\> |
There was a problem hiding this comment.
@vamshich13 Can you check this once? I tried this API. It doesnt return a promise.
There was a problem hiding this comment.
worked for me using:
const font = await fonts.fromPostscriptName("SourceSans3-Regular");
console.log("Font:------", font);
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doc updates
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: