Skip to content

Commit b0a5104

Browse files
kikuomaxkikuomax
committed
docs: update api-docs
1 parent 96d23f2 commit b0a5104

11 files changed

+32
-32
lines changed

‎api-docs/markdown/mapbox-collision-boxes.box.brx.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## Box.brX property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
X-coordinate value of the bottom-right corner of the box.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
brX: number;

‎api-docs/markdown/mapbox-collision-boxes.box.bry.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## Box.brY property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Y-coordinate value of the bottom-right corner of the box.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
brY: number;

‎api-docs/markdown/mapbox-collision-boxes.box.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## Box interface
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Box in the screen coordinate.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
export interface Box
@@ -19,8 +19,8 @@ export interface Box
1919

2020
| Property | Modifiers | Type | Description |
2121
| --- | --- | --- | --- |
22-
| [brX](./mapbox-collision-boxes.box.brx.md) | | number | <b><i>(BETA)</i></b> X-coordinate value of the bottom-right corner of the box. |
23-
| [brY](./mapbox-collision-boxes.box.bry.md) | | number | <b><i>(BETA)</i></b> Y-coordinate value of the bottom-right corner of the box. |
24-
| [tlX](./mapbox-collision-boxes.box.tlx.md) | | number | <b><i>(BETA)</i></b> X-coordinate value of the top-left corner of the box. |
25-
| [tlY](./mapbox-collision-boxes.box.tly.md) | | number | <b><i>(BETA)</i></b> Y-coordinate value of the top-left corner of the box. |
22+
| [brX](./mapbox-collision-boxes.box.brx.md) | | number | **_(BETA)_** X-coordinate value of the bottom-right corner of the box. |
23+
| [brY](./mapbox-collision-boxes.box.bry.md) | | number | **_(BETA)_** Y-coordinate value of the bottom-right corner of the box. |
24+
| [tlX](./mapbox-collision-boxes.box.tlx.md) | | number | **_(BETA)_** X-coordinate value of the top-left corner of the box. |
25+
| [tlY](./mapbox-collision-boxes.box.tly.md) | | number | **_(BETA)_** Y-coordinate value of the top-left corner of the box. |
2626

‎api-docs/markdown/mapbox-collision-boxes.box.tlx.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## Box.tlX property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
X-coordinate value of the top-left corner of the box.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
tlX: number;

‎api-docs/markdown/mapbox-collision-boxes.box.tly.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## Box.tlY property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Y-coordinate value of the top-left corner of the box.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
tlY: number;

‎api-docs/markdown/mapbox-collision-boxes.boxesintersect.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## boxesIntersect() function
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Returns if two `Box`<!-- -->es intersect.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
export declare function boxesIntersect(box1: Box, box2: Box): boolean;
@@ -22,7 +22,7 @@ export declare function boxesIntersect(box1: Box, box2: Box): boolean;
2222
| box1 | [Box](./mapbox-collision-boxes.box.md) | Box to be tested. |
2323
| box2 | [Box](./mapbox-collision-boxes.box.md) | Another box to be tested. |
2424

25-
<b>Returns:</b>
25+
**Returns:**
2626

2727
boolean
2828

‎api-docs/markdown/mapbox-collision-boxes.collectcollisionboxesandfeatures.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## collectCollisionBoxesAndFeatures() function
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Collects collision boxes on a given Mapbox map layer.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
export declare function collectCollisionBoxesAndFeatures(map: Map, layerId: string): Promise<FeatureBox[]>;
@@ -22,7 +22,7 @@ export declare function collectCollisionBoxesAndFeatures(map: Map, layerId: stri
2222
| map | Map | [Mapbox map](https://docs.mapbox.com/mapbox-gl-js/api/map/) instance. |
2323
| layerId | string | ID of the layer where collision boxes are to be collected. |
2424

25-
<b>Returns:</b>
25+
**Returns:**
2626

2727
Promise&lt;[FeatureBox](./mapbox-collision-boxes.featurebox.md)<!-- -->\[\]&gt;
2828

‎api-docs/markdown/mapbox-collision-boxes.featurebox.box.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## FeatureBox.box property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Box of the feature.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
box: Box;

‎api-docs/markdown/mapbox-collision-boxes.featurebox.feature.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## FeatureBox.feature property
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Feature.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
feature: QueryFeature;

‎api-docs/markdown/mapbox-collision-boxes.featurebox.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
## FeatureBox interface
66

7-
> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
7+
> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
88
>
99
1010
Box with feature information.
1111

12-
<b>Signature:</b>
12+
**Signature:**
1313

1414
```typescript
1515
export interface FeatureBox
@@ -19,6 +19,6 @@ export interface FeatureBox
1919

2020
| Property | Modifiers | Type | Description |
2121
| --- | --- | --- | --- |
22-
| [box](./mapbox-collision-boxes.featurebox.box.md) | | [Box](./mapbox-collision-boxes.box.md) | <b><i>(BETA)</i></b> Box of the feature. |
23-
| [feature](./mapbox-collision-boxes.featurebox.feature.md) | | QueryFeature | <b><i>(BETA)</i></b> Feature. |
22+
| [box](./mapbox-collision-boxes.featurebox.box.md) | | [Box](./mapbox-collision-boxes.box.md) | **_(BETA)_** Box of the feature. |
23+
| [feature](./mapbox-collision-boxes.featurebox.feature.md) | | QueryFeature | **_(BETA)_** Feature. |
2424

0 commit comments

Comments
 (0)