Skip to content

Commit 8f6f951

Browse files
tomhickstomhicks
committed
Move to UiController
1 parent 0502cf7 commit 8f6f951

File tree

8 files changed

+302
-296
lines changed

8 files changed

+302
-296
lines changed

‎docs/Layers/LayersController.md

-56
Original file line numberDiff line numberDiff line change
@@ -642,62 +642,6 @@ const maxNewBuildingHeight = await felt.getAggregates({
642642
});
643643
```
644644

645-
***
646-
647-
## showLayerDataTable()
648-
649-
> **showLayerDataTable**(`params`: \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); }): `Promise`\<`void`>
650-
651-
Shows a data table view for the specified layer, optionally sorted by a given attribute.
652-
653-
### Parameters
654-
655-
| Parameter | Type |
656-
| ----------------- | ----------------------------------------------------------------------------- |
657-
| `params` | \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); } |
658-
| `params.layerId` | `string` |
659-
| `params.sorting`? | [`SortConfig`](../Shared/SortConfig.md) |
660-
661-
### Returns
662-
663-
`Promise`\<`void`>
664-
665-
### Example
666-
667-
```typescript
668-
// Show data table with default sorting
669-
await felt.showLayerDataTable({
670-
layerId: "layer-1",
671-
});
672-
673-
// Show data table sorted by height in descending order
674-
await felt.showLayerDataTable({
675-
layerId: "layer-1",
676-
sorting: {
677-
attribute: "height",
678-
direction: "desc",
679-
},
680-
});
681-
```
682-
683-
***
684-
685-
## hideLayerDataTable()
686-
687-
> **hideLayerDataTable**(): `Promise`\<`void`>
688-
689-
Hides the data table.
690-
691-
### Returns
692-
693-
`Promise`\<`void`>
694-
695-
### Example
696-
697-
```typescript
698-
await felt.hideLayerDataTable();
699-
```
700-
701645
# Events
702646

703647
## onLayerChange()

‎docs/Main/FeltController.md

+56-56
Original file line numberDiff line numberDiff line change
@@ -875,62 +875,6 @@ const maxNewBuildingHeight = await felt.getAggregates({
875875

876876
***
877877

878-
## showLayerDataTable()
879-
880-
> **showLayerDataTable**(`params`: \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); }): `Promise`\<`void`>
881-
882-
Shows a data table view for the specified layer, optionally sorted by a given attribute.
883-
884-
### Parameters
885-
886-
| Parameter | Type |
887-
| ----------------- | ----------------------------------------------------------------------------- |
888-
| `params` | \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); } |
889-
| `params.layerId` | `string` |
890-
| `params.sorting`? | [`SortConfig`](../Shared/SortConfig.md) |
891-
892-
### Returns
893-
894-
`Promise`\<`void`>
895-
896-
### Example
897-
898-
```typescript
899-
// Show data table with default sorting
900-
await felt.showLayerDataTable({
901-
layerId: "layer-1",
902-
});
903-
904-
// Show data table sorted by height in descending order
905-
await felt.showLayerDataTable({
906-
layerId: "layer-1",
907-
sorting: {
908-
attribute: "height",
909-
direction: "desc",
910-
},
911-
});
912-
```
913-
914-
***
915-
916-
## hideLayerDataTable()
917-
918-
> **hideLayerDataTable**(): `Promise`\<`void`>
919-
920-
Hides the data table.
921-
922-
### Returns
923-
924-
`Promise`\<`void`>
925-
926-
### Example
927-
928-
```typescript
929-
await felt.hideLayerDataTable();
930-
```
931-
932-
***
933-
934878
## getMapDetails()
935879

936880
> **getMapDetails**(): `Promise`\<[`MapDetails`](../Misc/MapDetails.md)>
@@ -1220,6 +1164,62 @@ will still be selected when clicked.
12201164

12211165
***
12221166

1167+
## showLayerDataTable()
1168+
1169+
> **showLayerDataTable**(`params`: \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); }): `Promise`\<`void`>
1170+
1171+
Shows a data table view for the specified layer, optionally sorted by a given attribute.
1172+
1173+
### Parameters
1174+
1175+
| Parameter | Type |
1176+
| ----------------- | ----------------------------------------------------------------------------- |
1177+
| `params` | \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); } |
1178+
| `params.layerId` | `string` |
1179+
| `params.sorting`? | [`SortConfig`](../Shared/SortConfig.md) |
1180+
1181+
### Returns
1182+
1183+
`Promise`\<`void`>
1184+
1185+
### Example
1186+
1187+
```typescript
1188+
// Show data table with default sorting
1189+
await felt.showLayerDataTable({
1190+
layerId: "layer-1",
1191+
});
1192+
1193+
// Show data table sorted by height in descending order
1194+
await felt.showLayerDataTable({
1195+
layerId: "layer-1",
1196+
sorting: {
1197+
attribute: "height",
1198+
direction: "desc",
1199+
},
1200+
});
1201+
```
1202+
1203+
***
1204+
1205+
## hideLayerDataTable()
1206+
1207+
> **hideLayerDataTable**(): `Promise`\<`void`>
1208+
1209+
Hides the data table.
1210+
1211+
### Returns
1212+
1213+
`Promise`\<`void`>
1214+
1215+
### Example
1216+
1217+
```typescript
1218+
await felt.hideLayerDataTable();
1219+
```
1220+
1221+
***
1222+
12231223
## getViewport()
12241224

12251225
> **getViewport**(): `Promise`\<[`ViewportState`](../Viewport/ViewportState.md)>

‎docs/UI/UiController.md

+60-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
***
22

3-
The UI controller allows you to enable and disable UI controls on the
4-
embedded map.
3+
The UI controller allows you to control various aspects of the Felt UI in your embedded map.
4+
5+
This includes enabling/disabling UI controls, managing on-map interactions, and controlling
6+
the visibility of UI components like the data table.
57

68
# Extended by
79

@@ -50,3 +52,59 @@ will still be selected when clicked.
5052
### Returns
5153

5254
`void`
55+
56+
***
57+
58+
## showLayerDataTable()
59+
60+
> **showLayerDataTable**(`params`: \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); }): `Promise`\<`void`>
61+
62+
Shows a data table view for the specified layer, optionally sorted by a given attribute.
63+
64+
### Parameters
65+
66+
| Parameter | Type |
67+
| ----------------- | ----------------------------------------------------------------------------- |
68+
| `params` | \{ `layerId`: `string`; `sorting`: [`SortConfig`](../Shared/SortConfig.md); } |
69+
| `params.layerId` | `string` |
70+
| `params.sorting`? | [`SortConfig`](../Shared/SortConfig.md) |
71+
72+
### Returns
73+
74+
`Promise`\<`void`>
75+
76+
### Example
77+
78+
```typescript
79+
// Show data table with default sorting
80+
await felt.showLayerDataTable({
81+
layerId: "layer-1",
82+
});
83+
84+
// Show data table sorted by height in descending order
85+
await felt.showLayerDataTable({
86+
layerId: "layer-1",
87+
sorting: {
88+
attribute: "height",
89+
direction: "desc",
90+
},
91+
});
92+
```
93+
94+
***
95+
96+
## hideLayerDataTable()
97+
98+
> **hideLayerDataTable**(): `Promise`\<`void`>
99+
100+
Hides the data table.
101+
102+
### Returns
103+
104+
`Promise`\<`void`>
105+
106+
### Example
107+
108+
```typescript
109+
await felt.hideLayerDataTable();
110+
```

0 commit comments

Comments
 (0)