Skip to content

Commit

Permalink
Improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Clebal
Clebal committed Jan 31, 2025
1 parent a12be5b commit ca514ab
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 83 deletions.
15 changes: 2 additions & 13 deletions docs/Viewport/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,7 @@ current viewport, getting the current viewport, and being notified when the view
## Types

* [ViewportCenterZoom](ViewportCenterZoom.md)
* [ViewportState](ViewportState.md)
* [SetViewportCenterZoomParams](SetViewportCenterZoomParams.md)
* [ViewportFitBoundsParams](ViewportFitBoundsParams.md)

## Types

The constraints for the viewport. Used to ensure that the viewport stays
within certain bounds and zoom levels.

* [ViewportConstraints](ViewportConstraints.md)

## Types

The current state of the viewport, including the derived bounds.

* [ViewportState](ViewportState.md)
* [ViewportFitBoundsParams](ViewportFitBoundsParams.md)
3 changes: 3 additions & 0 deletions docs/Viewport/ViewportConstraints.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
***

The constraints for the viewport. Used to ensure that the viewport stays
within certain bounds and zoom levels.

## Properties

### minZoom
Expand Down
2 changes: 2 additions & 0 deletions docs/Viewport/ViewportState.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
***

The current state of the viewport, including the derived bounds.

## Properties

### center
Expand Down
132 changes: 66 additions & 66 deletions etc/js-sdk.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,72 +4,72 @@
```ts

import { a1 as CircleToolSettings } from './types-0BnQDzxQ.js';
import { C as ConfigurableToolType } from './types-0BnQDzxQ.js';
import { E as Element_2 } from './types-0BnQDzxQ.js';
import { d as ElementChangeCallbackParams } from './types-0BnQDzxQ.js';
import { b as ElementGroup } from './types-0BnQDzxQ.js';
import { e as ElementGroupChangeCallbackParams } from './types-0BnQDzxQ.js';
import { J as ElementGroupNode } from './types-0BnQDzxQ.js';
import { K as ElementNode } from './types-0BnQDzxQ.js';
import { r as EntityNode } from './types-0BnQDzxQ.js';
import { q as Feature } from './types-0BnQDzxQ.js';
import { N as FeatureNode } from './types-0BnQDzxQ.js';
import { s as FeatureSelection } from './types-0BnQDzxQ.js';
import { Q as FeltBoundary } from './types-0BnQDzxQ.js';
import { U as FeltZoom } from './types-0BnQDzxQ.js';
import { B as FilterExpression } from './types-0BnQDzxQ.js';
import { D as FilterLogicGate } from './types-0BnQDzxQ.js';
import { F as Filters } from './types-0BnQDzxQ.js';
import { H as FilterTernary } from './types-0BnQDzxQ.js';
import { G as Geometry } from './types-0BnQDzxQ.js';
import { c as GetElementGroupsConstraint } from './types-0BnQDzxQ.js';
import { a as GetElementsConstraint } from './types-0BnQDzxQ.js';
import { i as GetLayerGroupsConstraint } from './types-0BnQDzxQ.js';
import { f as GetLayersConstraint } from './types-0BnQDzxQ.js';
import { p as GetRenderedFeaturesConstraint } from './types-0BnQDzxQ.js';
import { a2 as HighlighterToolSettings } from './types-0BnQDzxQ.js';
import { I as InputToolSettings } from './types-0BnQDzxQ.js';
import { W as LatLng } from './types-0BnQDzxQ.js';
import { L as Layer } from './types-0BnQDzxQ.js';
import { g as LayerChangeCallbackParams } from './types-0BnQDzxQ.js';
import { o as LayerFilters } from './types-0BnQDzxQ.js';
import { h as LayerGroup } from './types-0BnQDzxQ.js';
import { j as LayerGroupChangeCallbackParams } from './types-0BnQDzxQ.js';
import { O as LayerGroupNode } from './types-0BnQDzxQ.js';
import { P as LayerNode } from './types-0BnQDzxQ.js';
import { A as LayerProcessingStatus } from './types-0BnQDzxQ.js';
import { l as LegendItem } from './types-0BnQDzxQ.js';
import { n as LegendItemChangeCallbackParams } from './types-0BnQDzxQ.js';
import { k as LegendItemIdentifier } from './types-0BnQDzxQ.js';
import { m as LegendItemsConstraint } from './types-0BnQDzxQ.js';
import { X as LineStringGeometry } from './types-0BnQDzxQ.js';
import { a3 as LineToolSettings } from './types-0BnQDzxQ.js';
import { Y as LngLatTuple } from './types-0BnQDzxQ.js';
import { M as MapInteractionEvent } from './types-0BnQDzxQ.js';
import { a4 as MarkerToolSettings } from './types-0BnQDzxQ.js';
import { Z as MultiLineStringGeometry } from './types-0BnQDzxQ.js';
import { _ as MultiPolygonGeometry } from './types-0BnQDzxQ.js';
import { a5 as NoteToolSettings } from './types-0BnQDzxQ.js';
import { a6 as PinFrame } from './types-0BnQDzxQ.js';
import { a7 as PinSymbol } from './types-0BnQDzxQ.js';
import { a8 as PinToolSettings } from './types-0BnQDzxQ.js';
import { $ as PointGeometry } from './types-0BnQDzxQ.js';
import { a0 as PolygonGeometry } from './types-0BnQDzxQ.js';
import { a9 as PolygonToolSettings } from './types-0BnQDzxQ.js';
import { R as RasterValue } from './types-0BnQDzxQ.js';
import { aa as RouteToolSettings } from './types-0BnQDzxQ.js';
import { v as SetViewportCenterZoomParams } from './types-0BnQDzxQ.js';
import { S as SetVisibilityRequest } from './types-0BnQDzxQ.js';
import { ab as TextToolSettings } from './types-0BnQDzxQ.js';
import { u as ToolSettingsChangeEvent } from './types-0BnQDzxQ.js';
import { t as ToolSettingsMap } from './types-0BnQDzxQ.js';
import { T as ToolType } from './types-0BnQDzxQ.js';
import { y as ViewportCenterZoom } from './types-0BnQDzxQ.js';
import { w as ViewportConstraints } from './types-0BnQDzxQ.js';
import { x as ViewportFitBoundsParams } from './types-0BnQDzxQ.js';
import { V as ViewportState } from './types-0BnQDzxQ.js';
import { z } from './types-0BnQDzxQ.js';
import { a1 as CircleToolSettings } from './types-BLsf5GHN.js';
import { C as ConfigurableToolType } from './types-BLsf5GHN.js';
import { E as Element_2 } from './types-BLsf5GHN.js';
import { d as ElementChangeCallbackParams } from './types-BLsf5GHN.js';
import { b as ElementGroup } from './types-BLsf5GHN.js';
import { e as ElementGroupChangeCallbackParams } from './types-BLsf5GHN.js';
import { J as ElementGroupNode } from './types-BLsf5GHN.js';
import { K as ElementNode } from './types-BLsf5GHN.js';
import { r as EntityNode } from './types-BLsf5GHN.js';
import { q as Feature } from './types-BLsf5GHN.js';
import { N as FeatureNode } from './types-BLsf5GHN.js';
import { s as FeatureSelection } from './types-BLsf5GHN.js';
import { Q as FeltBoundary } from './types-BLsf5GHN.js';
import { U as FeltZoom } from './types-BLsf5GHN.js';
import { B as FilterExpression } from './types-BLsf5GHN.js';
import { D as FilterLogicGate } from './types-BLsf5GHN.js';
import { F as Filters } from './types-BLsf5GHN.js';
import { H as FilterTernary } from './types-BLsf5GHN.js';
import { G as Geometry } from './types-BLsf5GHN.js';
import { c as GetElementGroupsConstraint } from './types-BLsf5GHN.js';
import { a as GetElementsConstraint } from './types-BLsf5GHN.js';
import { i as GetLayerGroupsConstraint } from './types-BLsf5GHN.js';
import { f as GetLayersConstraint } from './types-BLsf5GHN.js';
import { p as GetRenderedFeaturesConstraint } from './types-BLsf5GHN.js';
import { a2 as HighlighterToolSettings } from './types-BLsf5GHN.js';
import { I as InputToolSettings } from './types-BLsf5GHN.js';
import { W as LatLng } from './types-BLsf5GHN.js';
import { L as Layer } from './types-BLsf5GHN.js';
import { g as LayerChangeCallbackParams } from './types-BLsf5GHN.js';
import { o as LayerFilters } from './types-BLsf5GHN.js';
import { h as LayerGroup } from './types-BLsf5GHN.js';
import { j as LayerGroupChangeCallbackParams } from './types-BLsf5GHN.js';
import { O as LayerGroupNode } from './types-BLsf5GHN.js';
import { P as LayerNode } from './types-BLsf5GHN.js';
import { A as LayerProcessingStatus } from './types-BLsf5GHN.js';
import { l as LegendItem } from './types-BLsf5GHN.js';
import { n as LegendItemChangeCallbackParams } from './types-BLsf5GHN.js';
import { k as LegendItemIdentifier } from './types-BLsf5GHN.js';
import { m as LegendItemsConstraint } from './types-BLsf5GHN.js';
import { X as LineStringGeometry } from './types-BLsf5GHN.js';
import { a3 as LineToolSettings } from './types-BLsf5GHN.js';
import { Y as LngLatTuple } from './types-BLsf5GHN.js';
import { M as MapInteractionEvent } from './types-BLsf5GHN.js';
import { a4 as MarkerToolSettings } from './types-BLsf5GHN.js';
import { Z as MultiLineStringGeometry } from './types-BLsf5GHN.js';
import { _ as MultiPolygonGeometry } from './types-BLsf5GHN.js';
import { a5 as NoteToolSettings } from './types-BLsf5GHN.js';
import { a6 as PinFrame } from './types-BLsf5GHN.js';
import { a7 as PinSymbol } from './types-BLsf5GHN.js';
import { a8 as PinToolSettings } from './types-BLsf5GHN.js';
import { $ as PointGeometry } from './types-BLsf5GHN.js';
import { a0 as PolygonGeometry } from './types-BLsf5GHN.js';
import { a9 as PolygonToolSettings } from './types-BLsf5GHN.js';
import { R as RasterValue } from './types-BLsf5GHN.js';
import { aa as RouteToolSettings } from './types-BLsf5GHN.js';
import { v as SetViewportCenterZoomParams } from './types-BLsf5GHN.js';
import { S as SetVisibilityRequest } from './types-BLsf5GHN.js';
import { ab as TextToolSettings } from './types-BLsf5GHN.js';
import { u as ToolSettingsChangeEvent } from './types-BLsf5GHN.js';
import { t as ToolSettingsMap } from './types-BLsf5GHN.js';
import { T as ToolType } from './types-BLsf5GHN.js';
import { y as ViewportCenterZoom } from './types-BLsf5GHN.js';
import { w as ViewportConstraints } from './types-BLsf5GHN.js';
import { x as ViewportFitBoundsParams } from './types-BLsf5GHN.js';
import { V as ViewportState } from './types-BLsf5GHN.js';
import { z } from './types-BLsf5GHN.js';
import { z as z_2 } from 'zod';

export { CircleToolSettings }
Expand Down
10 changes: 6 additions & 4 deletions src/modules/viewport/types.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ export const ViewportCenterZoomSchema = z.object({
});

/**
* @group Types
*
* The current state of the viewport, including the derived bounds.
*
* @group Types
*/
export interface ViewportState {
/**
Expand Down Expand Up @@ -77,10 +77,10 @@ export const SetViewportCenterZoomParamsSchema = z.object({
});

/**
* @group Types
*
* The constraints for the viewport. Used to ensure that the viewport stays
* within certain bounds and zoom levels.
*
* @group Types
*/
export interface ViewportConstraints {
/**
Expand All @@ -107,6 +107,8 @@ export interface ViewportConstraints {

/**
* The parameters for the `setViewportConstraints` method.
*
* @group Types
*/
export const SetViewportConstraintsParamsSchema = z
.object({
Expand Down

0 comments on commit ca514ab

Please sign in to comment.