Skip to content

Commit 012f8aa

Browse files
OS-pedrogustavobilroOS-pedrogustavobilro
authored
docs: update google maps and inappbrowser (#431)
1 parent e2d40d7 commit 012f8aa

File tree

2 files changed

+29
-45
lines changed

2 files changed

+29
-45
lines changed

‎docs/apis/google-maps.md‎

Lines changed: 20 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -987,30 +987,36 @@ A marker is an icon placed at a particular point on the map's surface.
987987

988988
#### Point
989989

990-
<a href="#point">Point</a> geometry object.
991-
https://tools.ietf.org/html/rfc7946#section-3.1.2
992-
993-
| Prop | Type | Description |
994-
| ----------------- | --------------------------------------------- | ------------------------------------- |
995-
| **`type`** | <code>'<a href="#point">Point</a>'</code> | Specifies the type of GeoJSON object. |
996-
| **`coordinates`** | <code><a href="#position">Position</a></code> | |
990+
| Prop | Type |
991+
| ------- | ------------------- |
992+
| **`x`** | <code>number</code> |
993+
| **`y`** | <code>number</code> |
997994

998995

999996
#### Polygon
1000997

1001-
<a href="#polygon">Polygon</a> geometry object.
1002-
https://tools.ietf.org/html/rfc7946#section-3.1.6
998+
For web, all the javascript <a href="#polygon">Polygon</a> options are available as
999+
Polygon extends google.maps.PolygonOptions.
1000+
For iOS and Android only the config options declared on <a href="#polygon">Polygon</a> are available.
10031001

1004-
| Prop | Type | Description |
1005-
| ----------------- | --------------------------------------------- | ------------------------------------- |
1006-
| **`type`** | <code>'<a href="#polygon">Polygon</a>'</code> | Specifies the type of GeoJSON object. |
1007-
| **`coordinates`** | <code>Position[][]</code> | |
1002+
| Prop | Type | Description |
1003+
| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1004+
| **`paths`** | <code>any[] \| MVCArray&lt;any&gt;</code> | The ordered sequence of coordinates that designates a closed loop. Unlike polylines, a polygon may consist of one or more paths. As a result, the paths property may specify one or more arrays of &lt;code&gt;<a href="#latlng">LatLng</a>&lt;/code&gt; coordinates. Paths are closed automatically; do not repeat the first vertex of the path as the last vertex. Simple polygons may be defined using a single array of &lt;code&gt;<a href="#latlng">LatLng</a>&lt;/code&gt;s. More complex polygons may specify an array of arrays. Any simple arrays are converted into &lt;code&gt;&lt;a href="#MVCArray"&gt;MVCArray&lt;/a&gt;&lt;/code&gt;s. Inserting or removing &lt;code&gt;<a href="#latlng">LatLng</a>&lt;/code&gt;s from the &lt;code&gt;MVCArray&lt;/code&gt; will automatically update the polygon on the map. |
1005+
| **`strokeColor`** | <code>string</code> | The stroke color. All CSS3 colors are supported except for extended named colors. |
1006+
| **`strokeOpacity`** | <code>number</code> | The stroke opacity between 0.0 and 1.0 |
1007+
| **`strokeWeight`** | <code>number</code> | The stroke width in pixels. |
1008+
| **`fillColor`** | <code>string</code> | The fill color. All CSS3 colors are supported except for extended named colors. |
1009+
| **`fillOpacity`** | <code>number</code> | The fill opacity between 0.0 and 1.0 |
1010+
| **`geodesic`** | <code>boolean</code> | When &lt;code&gt;true&lt;/code&gt;, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When &lt;code&gt;false&lt;/code&gt;, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth. |
1011+
| **`clickable`** | <code>boolean</code> | Indicates whether this &lt;code&gt;<a href="#polygon">Polygon</a>&lt;/code&gt; handles mouse events. |
1012+
| **`title`** | <code>string</code> | Title, a short description of the overlay. Some overlays, such as markers, will display the title on the map. The title is also the default accessibility text. Only available on iOS. |
1013+
| **`tag`** | <code>string</code> | |
10081014

10091015

10101016
#### Circle
10111017

10121018
For web, all the javascript <a href="#circle">Circle</a> options are available as
1013-
Polygon extends google.maps.CircleOptions.
1019+
Circle extends google.maps.CircleOptions.
10141020
For iOS and Android only the config options declared on <a href="#circle">Circle</a> are available.
10151021

10161022
| Prop | Type | Description |
@@ -1180,29 +1186,6 @@ The callback function to be called when map events are emitted.
11801186
<code>(data: T): void</code>
11811187

11821188

1183-
#### Position
1184-
1185-
A <a href="#position">Position</a> is an array of coordinates.
1186-
https://tools.ietf.org/html/rfc7946#section-3.1.1
1187-
Array should contain between two and three elements.
1188-
The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values),
1189-
but the current specification only allows X, Y, and (optionally) Z to be defined.
1190-
1191-
Note: the type will not be narrowed down to `[number, number] | [number, number, number]` due to
1192-
marginal benefits and the large impact of breaking change.
1193-
1194-
See previous discussions on the type narrowing:
1195-
- {@link https://github.com/DefinitelyTyped/DefinitelyTyped/pull/21590|Nov 2017}
1196-
- {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/67773|Dec 2023}
1197-
- {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/71441| Dec 2024}
1198-
1199-
One can use a
1200-
{@link https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates|user-defined type guard that returns a type predicate}
1201-
to determine if a position is a 2D or 3D position.
1202-
1203-
<code>number[]</code>
1204-
1205-
12061189
#### Marker
12071190

12081191
Supports markers of either either "legacy" or "advanced" types.

‎docs/apis/inappbrowser.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -250,14 +250,15 @@ Defines the options for opening a URL in the web view.
250250

251251
#### iOSWebViewOptions
252252

253-
| Prop | Type | Description |
254-
| ---------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
255-
| **`allowOverScroll`** | <code>boolean</code> | Turns on the Web View bounce property. |
256-
| **`enableViewportScale`** | <code>boolean</code> | Prevents viewport scaling through a meta tag. |
257-
| **`allowInLineMediaPlayback`** | <code>boolean</code> | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. |
258-
| **`surpressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. |
259-
| **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. |
260-
| **`animationEffect`** | <code><a href="#iosanimation">iOSAnimation</a></code> | Sets the transition style of the Web View. |
253+
| Prop | Type | Description |
254+
| ----------------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
255+
| **`allowOverScroll`** | <code>boolean</code> | Turns on the Web View bounce property. |
256+
| **`enableViewportScale`** | <code>boolean</code> | Prevents viewport scaling through a meta tag. |
257+
| **`allowInLineMediaPlayback`** | <code>boolean</code> | Allows in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. Note: The HTML's video element must also include the webkit-playsinline attribute. |
258+
| **`surpressIncrementalRendering`** | <code>boolean</code> | Waits until all new view content is received before being rendered. |
259+
| **`viewStyle`** | <code><a href="#iosviewstyle">iOSViewStyle</a></code> | Sets the presentation style of the Web View. |
260+
| **`animationEffect`** | <code><a href="#iosanimation">iOSAnimation</a></code> | Sets the transition style of the Web View. |
261+
| **`allowsBackForwardNavigationGestures`** | <code>boolean</code> | Enables back and forward swipe gestures in the Web View. |
261262

262263

263264
#### OpenInSystemBrowserParameterModel

0 commit comments

Comments
 (0)