Skip to content

Commit 0502cf7

Browse files
committed
Add hide method
1 parent 8c4ef86 commit 0502cf7

File tree

5 files changed

+67
-12
lines changed

5 files changed

+67
-12
lines changed

Diff for: docs/Layers/LayersController.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -667,19 +667,37 @@ Shows a data table view for the specified layer, optionally sorted by a given at
667667
```typescript
668668
// Show data table with default sorting
669669
await felt.showLayerDataTable({
670-
layerId: "buildingsLayerId"
670+
layerId: "layer-1",
671671
});
672672

673673
// Show data table sorted by height in descending order
674674
await felt.showLayerDataTable({
675-
layerId: "buildingsLayerId",
675+
layerId: "layer-1",
676676
sorting: {
677677
attribute: "height",
678-
direction: "desc"
679-
}
678+
direction: "desc",
679+
},
680680
});
681681
```
682682

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+
683701
# Events
684702

685703
## onLayerChange()

Diff for: docs/Main/FeltController.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -898,21 +898,39 @@ Shows a data table view for the specified layer, optionally sorted by a given at
898898
```typescript
899899
// Show data table with default sorting
900900
await felt.showLayerDataTable({
901-
layerId: "buildingsLayerId"
901+
layerId: "layer-1",
902902
});
903903

904904
// Show data table sorted by height in descending order
905905
await felt.showLayerDataTable({
906-
layerId: "buildingsLayerId",
906+
layerId: "layer-1",
907907
sorting: {
908908
attribute: "height",
909-
direction: "desc"
910-
}
909+
direction: "desc",
910+
},
911911
});
912912
```
913913

914914
***
915915

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+
916934
## getMapDetails()
917935

918936
> **getMapDetails**(): `Promise`\<[`MapDetails`](../Misc/MapDetails.md)>

Diff for: etc/js-sdk.api.md

+1
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,7 @@ export interface LayersController {
397397
getLegendItems(constraint?: LegendItemsConstraint): Promise<Array<LegendItem | null>>;
398398
getRenderedFeatures(
399399
params?: GetRenderedFeaturesConstraint): Promise<Array<Feature>>;
400+
hideLayerDataTable(): Promise<void>;
400401
onLayerChange(args: {
401402
options: {
402403
id: string;

Diff for: src/modules/layers/controller.ts

+15-4
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ export const layersController = (feltWindow: Window): LayersController => ({
6666

6767
// new method
6868
showLayerDataTable: method(feltWindow, "showLayerDataTable"),
69+
hideLayerDataTable: method(feltWindow, "hideLayerDataTable"),
6970
});
7071

7172
/**
@@ -590,21 +591,31 @@ export interface LayersController {
590591
* ```typescript
591592
* // Show data table with default sorting
592593
* await felt.showLayerDataTable({
593-
* layerId: "buildingsLayerId"
594+
* layerId: "layer-1",
594595
* });
595596
*
596597
* // Show data table sorted by height in descending order
597598
* await felt.showLayerDataTable({
598-
* layerId: "buildingsLayerId",
599+
* layerId: "layer-1",
599600
* sorting: {
600601
* attribute: "height",
601-
* direction: "desc"
602-
* }
602+
* direction: "desc",
603+
* },
603604
* });
604605
* ```
605606
*/
606607
showLayerDataTable(params: {
607608
layerId: string;
608609
sorting?: SortConfig;
609610
}): Promise<void>;
611+
612+
/**
613+
* Hides the data table.
614+
*
615+
* @example
616+
* ```typescript
617+
* await felt.hideLayerDataTable();
618+
* ```
619+
*/
620+
hideLayerDataTable(): Promise<void>;
610621
}

Diff for: src/modules/layers/schema.ts

+7
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,11 @@ const ShowLayerDataTableMessage = methodMessage(
139139
}),
140140
);
141141

142+
const HideLayerDataTableMessage = methodMessage(
143+
"hideLayerDataTable",
144+
z.undefined(),
145+
);
146+
142147
export const layersSchema = {
143148
methods: [
144149
GetLayerMessage,
@@ -166,6 +171,7 @@ export const layersSchema = {
166171
GetLayerCalculationMessage,
167172

168173
ShowLayerDataTableMessage,
174+
HideLayerDataTableMessage,
169175
],
170176
listeners: [
171177
OnLayerChangeMessage,
@@ -238,6 +244,7 @@ export type LayersSchema = {
238244
>;
239245

240246
showLayerDataTable: Method<zInfer<typeof ShowLayerDataTableMessage>, void>;
247+
hideLayerDataTable: Method<zInfer<typeof HideLayerDataTableMessage>, void>;
241248
};
242249
listeners: {
243250
onLayerChange: Listener<

0 commit comments

Comments
 (0)