Skip to content

Commit b28cf89

Browse files
tomhickstomhicks
committed
Update typedoc (#24)
1 parent 8dbf302 commit b28cf89

27 files changed

Lines changed: 287 additions & 470 deletions

‎docs/Elements/ElementsController.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -172,18 +172,18 @@ felt.setElementGroupVisibility({ show: ["element-group-1", "element-group-2"], h
172172

173173
### onElementChange()
174174

175-
> **onElementChange**(`args`: \{`options`: \{`id`: `string`; };`handler`: (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`; }): `VoidFunction`
175+
> **onElementChange**(`args`: \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`; }): `VoidFunction`
176176
177177
Adds a listener for when an element changes.
178178

179179
#### Parameters
180180

181-
| Parameter | Type | Description |
182-
| ----------------- | ------------------------------------------------------------------------------------- | ---------------------------------------------------- |
183-
| `args` | `object` | - |
184-
| `args.options` | `object` | - |
185-
| `args.options.id` | `string` | The id of the element to listen for changes to. |
186-
| `args.handler` | (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void` | The handler that is called when the element changes. |
181+
| Parameter | Type | Description |
182+
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
183+
| `args` | \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void`; } | - |
184+
| `args.options` | \{ `id`: `string`; } | - |
185+
| `args.options.id` | `string` | The id of the element to listen for changes to. |
186+
| `args.handler` | (`change`: [`ElementChangeCallbackParams`](ElementChangeCallbackParams.md)) => `void` | The handler that is called when the element changes. |
187187

188188
#### Returns
189189

@@ -207,18 +207,18 @@ unsubscribe();
207207

208208
### onElementGroupChange()
209209

210-
> **onElementGroupChange**(`args`: \{`options`: \{`id`: `string`; };`handler`: (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`; }): `VoidFunction`
210+
> **onElementGroupChange**(`args`: \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`; }): `VoidFunction`
211211
212212
Adds a listener for when an element group changes.
213213

214214
#### Parameters
215215

216-
| Parameter | Type |
217-
| ----------------- | ----------------------------------------------------------------------------------------------- |
218-
| `args` | `object` |
219-
| `args.options` | `object` |
220-
| `args.options.id` | `string` |
221-
| `args.handler` | (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void` |
216+
| Parameter | Type |
217+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
218+
| `args` | \{ `options`: \{ `id`: `string`; }; `handler`: (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void`; } |
219+
| `args.options` | \{ `id`: `string`; } |
220+
| `args.options.id` | `string` |
221+
| `args.handler` | (`change`: [`ElementGroupChangeCallbackParams`](ElementGroupChangeCallbackParams.md)) => `void` |
222222

223223
#### Returns
224224

‎docs/Elements/README.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,17 @@
33
The Felt SDK lets you get information about the elements in the map, and the
44
groups that they belong to.
55

6-
## Index
7-
8-
### Controller
6+
## Controller
97

108
* [ElementsController](ElementsController.md)
119

12-
### Element Groups
10+
## Element Groups
1311

1412
* [ElementGroup](ElementGroup.md)
1513
* [GetElementGroupsConstraint](GetElementGroupsConstraint.md)
1614
* [ElementGroupChangeCallbackParams](ElementGroupChangeCallbackParams.md)
1715

18-
### Elements
16+
## Elements
1917

2018
* [Element](Element.md)
2119
* [GetElementsConstraint](GetElementsConstraint.md)

‎docs/Interactions/InteractionsController.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ The Interactions controller allows you to observe interactions with the map
1010

1111
### onPointerClick()
1212

13-
> **onPointerClick**(`params`: \{`handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
13+
> **onPointerClick**(`params`: \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
1414
1515
Allows you to be notified the user clicks on the map.
1616

1717
#### Parameters
1818

19-
| Parameter | Type |
20-
| ---------------- | -------------------------------------------------------------------- |
21-
| `params` | `object` |
22-
| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void` |
19+
| Parameter | Type |
20+
| ---------------- | ------------------------------------------------------------------------------------- |
21+
| `params` | \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; } |
22+
| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void` |
2323

2424
#### Returns
2525

@@ -42,16 +42,16 @@ unsubscribe();
4242

4343
### onPointerMove()
4444

45-
> **onPointerMove**(`params`: \{`handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
45+
> **onPointerMove**(`params`: \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; }): `VoidFunction`
4646
4747
Allows you to be notified the user moves the mouse over the map.
4848

4949
#### Parameters
5050

51-
| Parameter | Type | Description |
52-
| ---------------- | -------------------------------------------------------------------- | ----------------------- |
53-
| `params` | `object` | Params for the listener |
54-
| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void` | The handler function |
51+
| Parameter | Type | Description |
52+
| ---------------- | ------------------------------------------------------------------------------------- | ----------------------- |
53+
| `params` | \{ `handler`: (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void`; } | Params for the listener |
54+
| `params.handler` | (`event`: [`MapInteractionEvent`](MapInteractionEvent.md)) => `void` | The handler function |
5555

5656
#### Returns
5757

‎docs/Interactions/README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ The Interactions module allows you to be notified when the user interacts with t
44

55
Interactions include clicking and hovering on points and features.
66

7-
## Index
8-
9-
### Interfaces
7+
## Interfaces
108

119
* [MapInteractionEvent](MapInteractionEvent.md)
1210

13-
### Controller
11+
## Controller
1412

1513
* [InteractionsController](InteractionsController.md)

‎docs/Layers/GetRenderedFeaturesConstraint.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ provided, all rendered features will be returned.
77

88
### areaQuery?
99

10-
> `optional` **areaQuery**: \{`coordinates`: [`LatLng`](../Shared/LatLng.md); } | \{`boundary`: \[`number`, `number`, `number`, `number`]; }
10+
> `optional` **areaQuery**: \{ `coordinates`: [`LatLng`](../Shared/LatLng.md); } | \{ `boundary`: \[`number`, `number`, `number`, `number`]; }
1111
1212
The area to query for rendered features. This can be specific coordinates or a [FeltBoundary](../Shared/FeltBoundary.md). If omitted, the entire viewport will be queried.
1313

0 commit comments

Comments
 (0)