Skip to content

Commit a0629c4

Browse files
author
Abhishek Das
committed
Use old bullet for API signatures
1 parent 95c5368 commit a0629c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+972
-972
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This section outlines the steps that should be taken to format the generated Doc
2020
---
2121
```
2222

23-
3. The API signatures generated in `classes`, `enumerations`, `interfaces`, `namespaces`, and `type-aliases` is indented. In these directories, find and replace all occurrences of `>` + space with `•` + space.
23+
3. The API signatures generated in `classes`, `enumerations`, `interfaces`, `namespaces`, and `type-aliases` is indented. In these directories, find and replace all occurrences of `newline + > + space` with `newline + • + space`, ensuring no code example or closing tag is replaced.
2424

2525
4. Find and replace all \`mat2d\` --> \[\`mat2d\`\]\(https://glmatrix.net/docs/module-mat2d.html\)
2626

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

+18-18
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ remove the last remaining artboard from the list.
1616

1717
### first
1818

19-
`get` **first**(): `undefined` \| `T`
19+
`get` **first**(): `undefined` \| `T`
2020

2121
First item in this list, or undefined if list is empty.
2222

@@ -28,7 +28,7 @@ First item in this list, or undefined if list is empty.
2828

2929
### last
3030

31-
`get` **last**(): `undefined` \| `T`
31+
`get` **last**(): `undefined` \| `T`
3232

3333
Last item in this list, or undefined if list is empty.
3434

@@ -40,7 +40,7 @@ Last item in this list, or undefined if list is empty.
4040

4141
### length
4242

43-
`get` **length**(): `number`
43+
`get` **length**(): `number`
4444

4545
Number of items in this list.
4646

@@ -52,7 +52,7 @@ Number of items in this list.
5252

5353
### `[iterator]`()
5454

55-
**\[iterator\]**(): `Iterator`<[`ArtboardNode`](ArtboardNode.md), `any`, `undefined`\>
55+
**\[iterator\]**(): `Iterator`<[`ArtboardNode`](ArtboardNode.md), `any`, `undefined`\>
5656

5757
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
5858

@@ -68,7 +68,7 @@ Iterates over all the items in this list. Mutations that occur mid-iteration are
6868

6969
### addArtboard()
7070

71-
**addArtboard**(): [`ArtboardNode`](ArtboardNode.md)
71+
**addArtboard**(): [`ArtboardNode`](ArtboardNode.md)
7272

7373
Create a new artboard and add it to the end of the list. The artboard size is the same as others on this page. The
7474
artboard background is set to default fill color DEFAULT_ARTBOARD_FILL_COLOR. The new artboard becomes the
@@ -85,13 +85,13 @@ the newly added artboard.
8585

8686
### indexOf()
8787

88-
**indexOf**(`item`): `number`
88+
**indexOf**(`item`): `number`
8989

9090
Get index of item in list.
9191

9292
#### Parameters
9393

94-
**item**: [`ArtboardNode`](ArtboardNode.md)
94+
**item**: [`ArtboardNode`](ArtboardNode.md)
9595

9696
#### Returns
9797

@@ -107,13 +107,13 @@ index number, or -1 if item isn't in this list.
107107

108108
### item()
109109

110-
**item**(`index`): `undefined` \| [`ArtboardNode`](ArtboardNode.md)
110+
**item**(`index`): `undefined` \| [`ArtboardNode`](ArtboardNode.md)
111111

112112
Returns item at the given index, or undefined if index is out of range.
113113

114114
#### Parameters
115115

116-
**index**: `number`
116+
**index**: `number`
117117

118118
Zero-based index
119119

@@ -129,17 +129,17 @@ Zero-based index
129129

130130
### moveAfter()
131131

132-
**moveAfter**(`item`, `after`): `void`
132+
**moveAfter**(`item`, `after`): `void`
133133

134134
Move `item` so it is immediately after `after` in this list: places `item` at the index one higher than `after`.
135135
Depending on the position in the list `item` originally occupied, some other items in the list may shift to higher
136136
or lower indices as a result. No-op if both arguments are the same item.
137137

138138
#### Parameters
139139

140-
**item**: [`ArtboardNode`](ArtboardNode.md)
140+
**item**: [`ArtboardNode`](ArtboardNode.md)
141141

142-
**after**: [`ArtboardNode`](ArtboardNode.md)
142+
**after**: [`ArtboardNode`](ArtboardNode.md)
143143

144144
#### Returns
145145

@@ -157,17 +157,17 @@ An error if either argument is not contained in this list.
157157

158158
### moveBefore()
159159

160-
**moveBefore**(`item`, `before`): `void`
160+
**moveBefore**(`item`, `before`): `void`
161161

162162
Move `item` so it is immediately before `before` in this list: places `item` at the index that `before` used
163163
to occupy. Depending on the position in the list `item` originally occupied, some other items in the list may
164164
shift to higher or lower indices as a result. No-op if both arguments are the same item.
165165

166166
#### Parameters
167167

168-
**item**: [`ArtboardNode`](ArtboardNode.md)
168+
**item**: [`ArtboardNode`](ArtboardNode.md)
169169

170-
**before**: [`ArtboardNode`](ArtboardNode.md)
170+
**before**: [`ArtboardNode`](ArtboardNode.md)
171171

172172
#### Returns
173173

@@ -185,13 +185,13 @@ An error if either argument is not contained in this list.
185185

186186
### remove()
187187

188-
**remove**(...`items`): `void`
188+
**remove**(...`items`): `void`
189189

190190
Remove the items from the list. The items need not be contiguous.
191191

192192
#### Parameters
193193

194-
...**items**: [`ArtboardNode`](ArtboardNode.md)[]
194+
...**items**: [`ArtboardNode`](ArtboardNode.md)[]
195195

196196
#### Returns
197197

@@ -209,7 +209,7 @@ If any of the items are not in the list, or if it is illegal to remove any of th
209209

210210
### toArray()
211211

212-
**toArray**(): readonly [`ArtboardNode`](ArtboardNode.md)[]
212+
**toArray**(): readonly [`ArtboardNode`](ArtboardNode.md)[]
213213

214214
All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.
215215

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

+18-18
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ When multiple artboards exist on a page, the artboards represent "scenes" in a l
1919

2020
### allChildren
2121

22-
`get` **allChildren**(): `Readonly`<`Iterable`<[`Node`](Node.md)\>\>
22+
`get` **allChildren**(): `Readonly`<`Iterable`<[`Node`](Node.md)\>\>
2323

2424
Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or
2525
GroupNode also provide a mutable [ContainerNode.children](../interfaces/ContainerNode.md#children) list. Other nodes with a more specific structure can
@@ -36,7 +36,7 @@ The children of an Artboard are always other Node classes (never the more minima
3636

3737
### boundsLocal
3838

39-
`get` **boundsLocal**(): `Readonly`<`Rect`\>
39+
`get` **boundsLocal**(): `Readonly`<`Rect`\>
4040

4141
The bounding box of the node, expressed in the node's local coordinate space (which may be shifted or rotated
4242
relative to its parent). Generally matches the selection outline seen in the UI, encompassing the vector path
@@ -53,7 +53,7 @@ _not_ necessarily (0,0) – this is especially true for Text and Path nodes.
5353

5454
### centerPointLocal
5555

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

5858
Position of the node's centerpoint in its own local coordinate space, i.e. the center of the boundsLocal
5959
box.
@@ -66,7 +66,7 @@ box.
6666

6767
### children
6868

69-
`get` **children**(): [`ItemList`](ItemList.md)<[`Node`](Node.md)\>
69+
`get` **children**(): [`ItemList`](ItemList.md)<[`Node`](Node.md)\>
7070

7171
The node's children. Use the methods on this ItemList object to get, add, and remove children.
7272

@@ -78,15 +78,15 @@ The node's children. Use the methods on this ItemList object to get, add, and re
7878

7979
### fill
8080

81-
`get` **fill**(): `Readonly`<[`Fill`](../interfaces/Fill.md)\>
81+
`get` **fill**(): `Readonly`<[`Fill`](../interfaces/Fill.md)\>
8282

83-
`set` **fill**(`fill`): `void`
83+
`set` **fill**(`fill`): `void`
8484

8585
The background fill of the artboard. Artboards must always have a fill.
8686

8787
#### Parameters
8888

89-
**fill**: [`Fill`](../interfaces/Fill.md)
89+
**fill**: [`Fill`](../interfaces/Fill.md)
9090

9191
#### Returns
9292

@@ -96,7 +96,7 @@ The background fill of the artboard. Artboards must always have a fill.
9696

9797
### height
9898

99-
`get` **height**(): `number`
99+
`get` **height**(): `number`
100100

101101
The height of the artboard.
102102

@@ -108,7 +108,7 @@ The height of the artboard.
108108

109109
### id
110110

111-
`get` **id**(): `string`
111+
`get` **id**(): `string`
112112

113113
A unique identifier for this node that stays the same when the file is closed & reopened, or if the node is
114114
moved to a different part of the document.
@@ -121,7 +121,7 @@ moved to a different part of the document.
121121

122122
### parent
123123

124-
`get` **parent**(): `undefined` \| [`PageNode`](PageNode.md)
124+
`get` **parent**(): `undefined` \| [`PageNode`](PageNode.md)
125125

126126
The node's parent. Undefined if the node is an orphan.
127127

@@ -133,7 +133,7 @@ The node's parent. Undefined if the node is an orphan.
133133

134134
### topLeftLocal
135135

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

138138
Position of the node's top-left corner in its own local coordinate space, equal to (boundsLocal.x,
139139
boundsLocal.y). If the node is rotated, this is not the same as the top-left corner of
@@ -147,7 +147,7 @@ boundsInParent.
147147

148148
### type
149149

150-
`get` **type**(): [`SceneNodeType`](../enumerations/SceneNodeType.md)
150+
`get` **type**(): [`SceneNodeType`](../enumerations/SceneNodeType.md)
151151

152152
The node's type.
153153

@@ -159,7 +159,7 @@ The node's type.
159159

160160
### visualRoot
161161

162-
`get` **visualRoot**(): [`VisualNode`](VisualNode.md)
162+
`get` **visualRoot**(): [`VisualNode`](VisualNode.md)
163163

164164
The highest ancestor that still has visual presence in the document. Typically an Artboard, but for orphaned
165165
content, it will be the root of the deleted content (which might be this node itself).
@@ -176,7 +176,7 @@ meaningful comparison or conversion between the bounds or coordinate spaces of s
176176

177177
### width
178178

179-
`get` **width**(): `number`
179+
`get` **width**(): `number`
180180

181181
The width of the artboard.
182182

@@ -188,17 +188,17 @@ The width of the artboard.
188188

189189
### localPointInNode()
190190

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

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

197197
#### Parameters
198198

199-
**localPoint**: [`Point`](../interfaces/Point.md)
199+
**localPoint**: [`Point`](../interfaces/Point.md)
200200

201-
**targetNode**: [`VisualNode`](VisualNode.md)
201+
**targetNode**: [`VisualNode`](VisualNode.md)
202202

203203
#### Returns
204204

@@ -216,7 +216,7 @@ another (the target node need not be an ancestor of this node, nor vice versa).
216216

217217
### removeFromParent()
218218

219-
**removeFromParent**(): `void`
219+
**removeFromParent**(): `void`
220220

221221
Removes the node from its parent - effectively deleting it, if the node is not re-added to another parent before the
222222
document is closed.

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ properties.
1717

1818
### allChildren
1919

20-
`get` **allChildren**(): `Readonly`<`Iterable`<[`BaseNode`](BaseNode.md)\>\>
20+
`get` **allChildren**(): `Readonly`<`Iterable`<[`BaseNode`](BaseNode.md)\>\>
2121

2222
Returns a read-only list of all children of the node. General-purpose content containers such as ArtboardNode or
2323
GroupNode also provide a mutable [ContainerNode.children](../interfaces/ContainerNode.md#children) list. Other nodes with a more specific structure can
@@ -35,7 +35,7 @@ to guarantee all their children are full-fledged Node instances.
3535

3636
### id
3737

38-
`get` **id**(): `string`
38+
`get` **id**(): `string`
3939

4040
A unique identifier for this node that stays the same when the file is closed & reopened, or if the node is
4141
moved to a different part of the document.
@@ -48,7 +48,7 @@ moved to a different part of the document.
4848

4949
### parent
5050

51-
`get` **parent**(): `undefined` \| [`BaseNode`](BaseNode.md)
51+
`get` **parent**(): `undefined` \| [`BaseNode`](BaseNode.md)
5252

5353
The node's parent. The parent chain will eventually reach ExpressRootNode for all nodes that are part of the document
5454
content.
@@ -65,7 +65,7 @@ that was part of the document content earlier. Deleted nodes can be reattached t
6565

6666
### type
6767

68-
`get` **type**(): [`SceneNodeType`](../enumerations/SceneNodeType.md)
68+
`get` **type**(): [`SceneNodeType`](../enumerations/SceneNodeType.md)
6969

7070
The node's type.
7171

@@ -77,7 +77,7 @@ The node's type.
7777

7878
### removeFromParent()
7979

80-
**removeFromParent**(): `void`
80+
**removeFromParent**(): `void`
8181

8282
Removes the node from its parent - effectively deleting it, if the node is not re-added to another parent before the
8383
document is closed.

0 commit comments

Comments
 (0)