Skip to content

Commit 9e74aec

Browse files
author
Unzela Inamdar
committed
Updated
1 parent 92cfc4e commit 9e74aec

File tree

3 files changed

+37
-37
lines changed

3 files changed

+37
-37
lines changed

src/pages/references/document-sandbox/document-apis/classes/ArtboardNode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please note that creating and deleting an artboard in a single frame will crash
1616

1717
## Implements
1818

19-
- `Readonly`\<[`IRectangularNode`](../interfaces/IRectangularNode.md)\>
19+
- `Readonly`<[`IRectangularNode`](../interfaces/IRectangularNode.md)\>
2020
- [`ContainerNode`](../interfaces/ContainerNode.md)
2121

2222
## Accessors

src/pages/references/document-sandbox/document-apis/classes/StandaloneTextNode.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Get [AddOnData](AddOnData.md) reference for managing the private metadata on thi
2727

2828
### allChildren
2929

30-
`get` **allChildren**(): `Readonly`\<`Iterable`\<[`Node`](Node.md), `any`, `any`\>\>
30+
`get` **allChildren**(): `Readonly`<`Iterable`<[`Node`](Node.md), `any`, `any`\>\>
3131

3232
Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or
3333
GroupNode also provide a mutable [ContainerNode.children](../interfaces/ContainerNode.md#children) list. Other nodes with a more specific structure can
@@ -38,7 +38,7 @@ The children of a Node are always other Node classes (never the more minimal Bas
3838

3939
#### Returns
4040

41-
`Readonly`\<`Iterable`\<[`Node`](Node.md), `any`, `any`\>\>
41+
`Readonly`<`Iterable`<[`Node`](Node.md), `any`, `any`\>\>
4242

4343
---
4444

@@ -63,7 +63,7 @@ Blend mode determines how a node is composited onto the content below it. The de
6363

6464
### boundsInParent
6565

66-
`get` **boundsInParent**(): `Readonly`\<[`Rect`](../interfaces/Rect.md)\>
66+
`get` **boundsInParent**(): `Readonly`<[`Rect`](../interfaces/Rect.md)\>
6767

6868
An axis-aligned box in the parent’s coordinate space encompassing the node’s layout bounds (its
6969
[boundsLocal](VisualNode.md#boundslocal), as transformed by its position and rotation relative to the parent). If the node has
@@ -73,7 +73,7 @@ even for an orphan node with no parent.
7373

7474
#### Returns
7575

76-
`Readonly`\<[`Rect`](../interfaces/Rect.md)\>
76+
`Readonly`<[`Rect`](../interfaces/Rect.md)\>
7777

7878
Note: The bounding box of an orphaned TextNode may become different after it is placed on a
7979
page. It is recommended to use this property only when the node is placed on a page.
@@ -82,7 +82,7 @@ page. It is recommended to use this property only when the node is placed on a p
8282

8383
### boundsLocal
8484

85-
`get` **boundsLocal**(): `Readonly`\<[`Rect`](../interfaces/Rect.md)\>
85+
`get` **boundsLocal**(): `Readonly`<[`Rect`](../interfaces/Rect.md)\>
8686

8787
The bounding box of the node, expressed in the node's local coordinate space (which may be shifted or rotated
8888
relative to its parent). Generally matches the selection outline seen in the UI, encompassing the vector path
@@ -93,7 +93,7 @@ The top-left corner of the bounding box corresponds to the visual top-left corne
9393

9494
#### Returns
9595

96-
`Readonly`\<[`Rect`](../interfaces/Rect.md)\>
96+
`Readonly`<[`Rect`](../interfaces/Rect.md)\>
9797

9898
Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a
9999
page. It is recommended to use this property only when the node is placed on a page.
@@ -102,13 +102,13 @@ page. It is recommended to use this property only when the node is placed on a p
102102

103103
### centerPointLocal
104104

105-
`get` **centerPointLocal**(): `Readonly`\<[`Point`](../interfaces/Point.md)\>
105+
`get` **centerPointLocal**(): `Readonly`<[`Point`](../interfaces/Point.md)\>
106106

107107
Position of the node's centerpoint in its own local coordinate space, i.e. the center of the boundsLocal box.
108108

109109
#### Returns
110110

111-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
111+
`Readonly`<[`Point`](../interfaces/Point.md)\>
112112

113113
Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is
114114
recommended to use this property only when the node is placed on a page.
@@ -149,7 +149,7 @@ moved to a different part of the document.
149149

150150
### layout
151151

152-
`get` **layout**(): `Readonly`\<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\>
152+
`get` **layout**(): `Readonly`<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\>
153153

154154
<InlineAlert slots="text" variant="warning"/>
155155

@@ -179,7 +179,7 @@ if [StandaloneTextNode](StandaloneTextNode.md) is not a part of a multi-frame te
179179

180180
#### Returns
181181

182-
`Readonly`\<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\>
182+
`Readonly`<[`AutoWidthTextLayout`](../interfaces/AutoWidthTextLayout.md) \| [`AutoHeightTextLayout`](../interfaces/AutoHeightTextLayout.md) \| [`UnsupportedTextLayout`](../interfaces/UnsupportedTextLayout.md)\>
183183

184184
The layout mode of the TextNode "frame."
185185

@@ -334,15 +334,15 @@ The horizontal text alignment of the TextNode. Alignment is always the same acro
334334

335335
### topLeftLocal
336336

337-
`get` **topLeftLocal**(): `Readonly`\<[`Point`](../interfaces/Point.md)\>
337+
`get` **topLeftLocal**(): `Readonly`<[`Point`](../interfaces/Point.md)\>
338338

339339
Position of the node's top-left corner in its own local coordinate space, equal to (boundsLocal.x,
340340
boundsLocal.y). If the node is rotated, this is not the same as the top-left corner of
341341
boundsInParent.
342342

343343
#### Returns
344344

345-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
345+
`Readonly`<[`Point`](../interfaces/Point.md)\>
346346

347347
Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a
348348
page. It is recommended to use this property only when the node is placed on a page.
@@ -363,7 +363,7 @@ The node's transform matrix relative to its parent.
363363

364364
### translation
365365

366-
`get` **translation**(): `Readonly`\<[`Point`](../interfaces/Point.md)\>
366+
`get` **translation**(): `Readonly`<[`Point`](../interfaces/Point.md)\>
367367

368368
The translation of the node along its parent's axes. This is identical to the translation component of
369369
`transformMatrix`. It is often simpler to set a node's position using `setPositionInParent` than by
@@ -377,7 +377,7 @@ setting translation directly.
377377

378378
#### Returns
379379

380-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
380+
`Readonly`<[`Point`](../interfaces/Point.md)\>
381381

382382
---
383383

@@ -424,7 +424,7 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s
424424

425425
### boundsInNode()
426426

427-
**boundsInNode**(`targetNode`): `Readonly`\<[`Rect`](../interfaces/Rect.md)\>
427+
**boundsInNode**(`targetNode`): `Readonly`<[`Rect`](../interfaces/Rect.md)\>
428428

429429
Convert the node's [boundsLocal](VisualNode.md#boundslocal) to an axis-aligned bounding box in the coordinate space of the target
430430
node. Both nodes must share the same [visualRoot](VisualNode.md#visualroot), but can lie anywhere within that subtree
@@ -436,7 +436,7 @@ relative to one another (the target node need not be an ancestor of this node, n
436436

437437
#### Returns
438438

439-
`Readonly`\<[`Rect`](../interfaces/Rect.md)\>
439+
`Readonly`<[`Rect`](../interfaces/Rect.md)\>
440440

441441
Note: The bounding box of an orphaned TextNode may become different after it is placed on a
442442
page. It is recommended to use this method only when the node is placed on a page.
@@ -481,7 +481,7 @@ Helper method to determine if the text is in a flow.
481481

482482
### localPointInNode()
483483

484-
**localPointInNode**(`localPoint`, `targetNode`): `Readonly`\<[`Point`](../interfaces/Point.md)\>
484+
**localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\>
485485

486486
Convert a point given in the node’s local coordinate space to a point in the coordinate space of the target node.
487487
Both nodes must share the same [visualRoot](VisualNode.md#visualroot), but can lie anywhere within that subtree relative to one
@@ -495,7 +495,7 @@ another (the target node need not be an ancestor of this node, nor vice versa).
495495

496496
#### Returns
497497

498-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
498+
`Readonly`<[`Point`](../interfaces/Point.md)\>
499499

500500
#### Inherited from
501501

src/pages/references/document-sandbox/document-apis/classes/ThreadedTextNode.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Get [AddOnData](AddOnData.md) reference for managing the private metadata on thi
2828

2929
### allChildren
3030

31-
`get` **allChildren**(): `Readonly`\<`Iterable`\<[`Node`](Node.md), `any`, `any`\>\>
31+
`get` **allChildren**(): `Readonly`<`Iterable`<[`Node`](Node.md), `any`, `any`\>\>
3232

3333
Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or
3434
GroupNode also provide a mutable [ContainerNode.children](../interfaces/ContainerNode.md#children) list. Other nodes with a more specific structure can
@@ -39,7 +39,7 @@ The children of a Node are always other Node classes (never the more minimal Bas
3939

4040
#### Returns
4141

42-
`Readonly`\<`Iterable`\<[`Node`](Node.md), `any`, `any`\>\>
42+
`Readonly`<`Iterable`<[`Node`](Node.md), `any`, `any`\>\>
4343

4444
---
4545

@@ -64,7 +64,7 @@ Blend mode determines how a node is composited onto the content below it. The de
6464

6565
### boundsInParent
6666

67-
`get` **boundsInParent**(): `Readonly`\<[`Rect`](../interfaces/Rect.md)\>
67+
`get` **boundsInParent**(): `Readonly`<[`Rect`](../interfaces/Rect.md)\>
6868

6969
An axis-aligned box in the parent’s coordinate space encompassing the node’s layout bounds (its
7070
[boundsLocal](VisualNode.md#boundslocal), as transformed by its position and rotation relative to the parent). If the node has
@@ -74,7 +74,7 @@ even for an orphan node with no parent.
7474

7575
#### Returns
7676

77-
`Readonly`\<[`Rect`](../interfaces/Rect.md)\>
77+
`Readonly`<[`Rect`](../interfaces/Rect.md)\>
7878

7979
Note: The bounding box of an orphaned TextNode may become different after it is placed on a
8080
page. It is recommended to use this property only when the node is placed on a page.
@@ -83,7 +83,7 @@ page. It is recommended to use this property only when the node is placed on a p
8383

8484
### boundsLocal
8585

86-
`get` **boundsLocal**(): `Readonly`\<[`Rect`](../interfaces/Rect.md)\>
86+
`get` **boundsLocal**(): `Readonly`<[`Rect`](../interfaces/Rect.md)\>
8787

8888
The bounding box of the node, expressed in the node's local coordinate space (which may be shifted or rotated
8989
relative to its parent). Generally matches the selection outline seen in the UI, encompassing the vector path
@@ -94,7 +94,7 @@ The top-left corner of the bounding box corresponds to the visual top-left corne
9494

9595
#### Returns
9696

97-
`Readonly`\<[`Rect`](../interfaces/Rect.md)\>
97+
`Readonly`<[`Rect`](../interfaces/Rect.md)\>
9898

9999
Note: The bounding box of the orphaned TextNode may be different from the bounding box of the node placed on a
100100
page. It is recommended to use this property only when the node is placed on a page.
@@ -103,13 +103,13 @@ page. It is recommended to use this property only when the node is placed on a p
103103

104104
### centerPointLocal
105105

106-
`get` **centerPointLocal**(): `Readonly`\<[`Point`](../interfaces/Point.md)\>
106+
`get` **centerPointLocal**(): `Readonly`<[`Point`](../interfaces/Point.md)\>
107107

108108
Position of the node's centerpoint in its own local coordinate space, i.e. the center of the boundsLocal box.
109109

110110
#### Returns
111111

112-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
112+
`Readonly`<[`Point`](../interfaces/Point.md)\>
113113

114114
Note: The center of the orphaned TextNode may be different from the center of the node placed on a page. It is
115115
recommended to use this property only when the node is placed on a page.
@@ -150,7 +150,7 @@ moved to a different part of the document.
150150

151151
### layout
152152

153-
`get` **layout**(): `Readonly`\<[`AreaTextLayout`](../interfaces/AreaTextLayout.md)\>
153+
`get` **layout**(): `Readonly`<[`AreaTextLayout`](../interfaces/AreaTextLayout.md)\>
154154

155155
<InlineAlert slots="text" variant="warning"/>
156156

@@ -176,7 +176,7 @@ if [ThreadedTextNode](ThreadedTextNode.md) is part of a multi-frame text content
176176

177177
#### Returns
178178

179-
`Readonly`\<[`AreaTextLayout`](../interfaces/AreaTextLayout.md)\>
179+
`Readonly`<[`AreaTextLayout`](../interfaces/AreaTextLayout.md)\>
180180

181181
The layout mode of the TextNode "frame."
182182

@@ -331,15 +331,15 @@ The horizontal text alignment of the TextNode. Alignment is always the same acro
331331

332332
### topLeftLocal
333333

334-
`get` **topLeftLocal**(): `Readonly`\<[`Point`](../interfaces/Point.md)\>
334+
`get` **topLeftLocal**(): `Readonly`<[`Point`](../interfaces/Point.md)\>
335335

336336
Position of the node's top-left corner in its own local coordinate space, equal to (boundsLocal.x,
337337
boundsLocal.y). If the node is rotated, this is not the same as the top-left corner of
338338
boundsInParent.
339339

340340
#### Returns
341341

342-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
342+
`Readonly`<[`Point`](../interfaces/Point.md)\>
343343

344344
Note: The top-left of the orphaned TextNode may be different from the top-left of the node placed on a
345345
page. It is recommended to use this property only when the node is placed on a page.
@@ -360,7 +360,7 @@ The node's transform matrix relative to its parent.
360360

361361
### translation
362362

363-
`get` **translation**(): `Readonly`\<[`Point`](../interfaces/Point.md)\>
363+
`get` **translation**(): `Readonly`<[`Point`](../interfaces/Point.md)\>
364364

365365
The translation of the node along its parent's axes. This is identical to the translation component of
366366
`transformMatrix`. It is often simpler to set a node's position using `setPositionInParent` than by
@@ -374,7 +374,7 @@ setting translation directly.
374374

375375
#### Returns
376376

377-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
377+
`Readonly`<[`Point`](../interfaces/Point.md)\>
378378

379379
---
380380

@@ -421,7 +421,7 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s
421421

422422
### boundsInNode()
423423

424-
**boundsInNode**(`targetNode`): `Readonly`\<[`Rect`](../interfaces/Rect.md)\>
424+
**boundsInNode**(`targetNode`): `Readonly`<[`Rect`](../interfaces/Rect.md)\>
425425

426426
Convert the node's [boundsLocal](VisualNode.md#boundslocal) to an axis-aligned bounding box in the coordinate space of the target
427427
node. Both nodes must share the same [visualRoot](VisualNode.md#visualroot), but can lie anywhere within that subtree
@@ -433,7 +433,7 @@ relative to one another (the target node need not be an ancestor of this node, n
433433

434434
#### Returns
435435

436-
`Readonly`\<[`Rect`](../interfaces/Rect.md)\>
436+
`Readonly`<[`Rect`](../interfaces/Rect.md)\>
437437

438438
Note: The bounding box of an orphaned TextNode may become different after it is placed on a
439439
page. It is recommended to use this method only when the node is placed on a page.
@@ -478,7 +478,7 @@ Helper method to determine if the text is in a flow.
478478

479479
### localPointInNode()
480480

481-
**localPointInNode**(`localPoint`, `targetNode`): `Readonly`\<[`Point`](../interfaces/Point.md)\>
481+
**localPointInNode**(`localPoint`, `targetNode`): `Readonly`<[`Point`](../interfaces/Point.md)\>
482482

483483
Convert a point given in the node’s local coordinate space to a point in the coordinate space of the target node.
484484
Both nodes must share the same [visualRoot](VisualNode.md#visualroot), but can lie anywhere within that subtree relative to one
@@ -492,7 +492,7 @@ another (the target node need not be an ancestor of this node, nor vice versa).
492492

493493
#### Returns
494494

495-
`Readonly`\<[`Point`](../interfaces/Point.md)\>
495+
`Readonly`<[`Point`](../interfaces/Point.md)\>
496496

497497
#### Inherited from
498498

0 commit comments

Comments
 (0)