Skip to content

Commit f389278

Browse files
authored
Merge pull request #11 from AdobeDocs/vamshi/hlapi-glue-layer-docs
new hlapi docs
2 parents 6dfa9df + e0b9ec2 commit f389278

Some content is hidden

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

62 files changed

+4533
-5717
lines changed

gatsby-config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module.exports = {
2222
title: 'References',
2323
menu: [
2424
{
25-
title: 'Authoring APIs',
25+
title: 'Editor APIs',
2626
path: '/api/overview.md'
2727
}
2828
]

src/pages/api/classes/ArtboardList.md

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
[@add-on-hlapi-sdk](../overview.md) / ArtboardList
2+
3+
# Class: ArtboardList
4+
5+
ArtboardList represents an ordered list of High Level API ArtboardNodes, representing
6+
artboards that are children of a page node.
7+
8+
ArtboardList also provides APIs for adding/removing ArtboardNodes from the list by adding/removing them
9+
from the PageNode.
10+
11+
## Hierarchy
12+
13+
- [`ReadOnlyItemList`](ReadOnlyItemList.md)<[`ArtboardNode`](ArtboardNode.md)\>
14+
15+
**`ArtboardList`**
16+
17+
## Table of contents
18+
19+
### Accessors
20+
21+
- [first](ArtboardList.md#first)
22+
- [last](ArtboardList.md#last)
23+
- [length](ArtboardList.md#length)
24+
25+
### Methods
26+
27+
- [[iterator]](ArtboardList.md#[iterator])
28+
- [addArtboard](ArtboardList.md#addArtboard)
29+
- [item](ArtboardList.md#item)
30+
- [remove](ArtboardList.md#remove)
31+
- [toArray](ArtboardList.md#toArray)
32+
33+
## Accessors
34+
35+
### <a id="first" name="first"></a> first
36+
37+
`get` **first**(): `undefined` \| `T`
38+
39+
First item in this list, or undefined if list is empty.
40+
41+
#### Returns
42+
43+
`undefined` \| `T`
44+
45+
#### Inherited from
46+
47+
ReadOnlyItemList.first
48+
49+
___
50+
51+
### <a id="last" name="last"></a> last
52+
53+
`get` **last**(): `undefined` \| `T`
54+
55+
Last item in this list, or undefined if list is empty.
56+
57+
#### Returns
58+
59+
`undefined` \| `T`
60+
61+
#### Inherited from
62+
63+
ReadOnlyItemList.last
64+
65+
___
66+
67+
### <a id="length" name="length"></a> length
68+
69+
`get` **length**(): `number`
70+
71+
Number of items in this list.
72+
73+
#### Returns
74+
75+
`number`
76+
77+
#### Inherited from
78+
79+
ReadOnlyItemList.length
80+
81+
## Methods
82+
83+
### <a id="[iterator]" name="[iterator]"></a> [iterator]
84+
85+
**[iterator]**(): `Iterator`<[`ArtboardNode`](ArtboardNode.md), `any`, `undefined`\>
86+
87+
Iterates over all the items in this list. Mutations that occur mid-iteration are not reflected by the iterator.
88+
89+
#### Returns
90+
91+
`Iterator`<[`ArtboardNode`](ArtboardNode.md), `any`, `undefined`\>
92+
93+
#### Inherited from
94+
95+
[ReadOnlyItemList](ReadOnlyItemList.md).[[iterator]](ReadOnlyItemList.md#[iterator])
96+
97+
___
98+
99+
### <a id="addArtboard" name="addArtboard"></a> addArtboard
100+
101+
**addArtboard**(): [`ArtboardNode`](ArtboardNode.md)
102+
103+
Create a new artboard and add it to the end of the list.
104+
105+
#### Returns
106+
107+
[`ArtboardNode`](ArtboardNode.md)
108+
109+
the newly added artboard.
110+
111+
___
112+
113+
### <a id="item" name="item"></a> item
114+
115+
**item**(`index`): `undefined` \| [`ArtboardNode`](ArtboardNode.md)
116+
117+
Returns item at the given index, or undefined if index is out of range.
118+
119+
#### Parameters
120+
121+
| Name | Type | Description |
122+
| :------ | :------ | :------ |
123+
| `index` | `number` | Zero-based index |
124+
125+
#### Returns
126+
127+
`undefined` \| [`ArtboardNode`](ArtboardNode.md)
128+
129+
#### Inherited from
130+
131+
[ReadOnlyItemList](ReadOnlyItemList.md).[item](ReadOnlyItemList.md#item)
132+
133+
___
134+
135+
### <a id="remove" name="remove"></a> remove
136+
137+
**remove**(...`items`): `void`
138+
139+
Remove the items from the list.
140+
141+
**`Throws`**
142+
143+
An error if any of the items are not in the list or if removing the
144+
items would cause the list to be empty. If one of these errors occurs, the list
145+
is not modified.
146+
147+
#### Parameters
148+
149+
| Name | Type |
150+
| :------ | :------ |
151+
| `...items` | [`ArtboardNode`](ArtboardNode.md)[] |
152+
153+
#### Returns
154+
155+
`void`
156+
157+
___
158+
159+
### <a id="toArray" name="toArray"></a> toArray
160+
161+
**toArray**(): readonly [`ArtboardNode`](ArtboardNode.md)[]
162+
163+
All items in the list, as a static array. Mutations that occur later are not reflected in an array returned earlier.
164+
165+
#### Returns
166+
167+
readonly [`ArtboardNode`](ArtboardNode.md)[]
168+
169+
#### Inherited from
170+
171+
[ReadOnlyItemList](ReadOnlyItemList.md).[toArray](ReadOnlyItemList.md#toArray)

0 commit comments

Comments
 (0)