Skip to content

Commit f1aab74

Browse files
theproducertheproducer
committed
Updating typo in docgen_updates
1 parent 31131fe commit f1aab74

File tree

2 files changed

+22
-47
lines changed

2 files changed

+22
-47
lines changed

‎plugin/README.md‎

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

10691069
#### Point
10701070

1071-
<a href="#point">Point</a> geometry object.
1072-
https://tools.ietf.org/html/rfc7946#section-3.1.2
1073-
1074-
| Prop | Type | Description |
1075-
| ----------------- | --------------------------------------------- | ------------------------------------- |
1076-
| **`type`** | <code>'<a href="#point">Point</a>'</code> | Specifies the type of GeoJSON object. |
1077-
| **`coordinates`** | <code><a href="#position">Position</a></code> | |
1078-
1079-
1080-
#### Position
1081-
1082-
| Prop | Type | Description |
1083-
| ------------ | ------------------- | ----------- |
1084-
| **`line`** | <code>number</code> | &gt;= 1 |
1085-
| **`column`** | <code>number</code> | &gt;= 0 |
1071+
| Prop | Type |
1072+
| ------- | ------------------- |
1073+
| **`x`** | <code>number</code> |
1074+
| **`y`** | <code>number</code> |
10861075

10871076

10881077
#### Polygon
10891078

1090-
<a href="#polygon">Polygon</a> geometry object.
1091-
https://tools.ietf.org/html/rfc7946#section-3.1.6
1079+
For web, all the javascript <a href="#polygon">Polygon</a> options are available as
1080+
Polygon extends google.maps.PolygonOptions.
1081+
For iOS and Android only the config options declared on <a href="#polygon">Polygon</a> are available.
10921082

1093-
| Prop | Type | Description |
1094-
| ----------------- | --------------------------------------------- | ------------------------------------- |
1095-
| **`type`** | <code>'<a href="#polygon">Polygon</a>'</code> | Specifies the type of GeoJSON object. |
1096-
| **`coordinates`** | <code>Position[][]</code> | |
1083+
| Prop | Type | Description |
1084+
| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1085+
| **`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. |
1086+
| **`strokeColor`** | <code>string</code> | The stroke color. All CSS3 colors are supported except for extended named colors. |
1087+
| **`strokeOpacity`** | <code>number</code> | The stroke opacity between 0.0 and 1.0 |
1088+
| **`strokeWeight`** | <code>number</code> | The stroke width in pixels. |
1089+
| **`fillColor`** | <code>string</code> | The fill color. All CSS3 colors are supported except for extended named colors. |
1090+
| **`fillOpacity`** | <code>number</code> | The fill opacity between 0.0 and 1.0 |
1091+
| **`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. |
1092+
| **`clickable`** | <code>boolean</code> | Indicates whether this &lt;code&gt;<a href="#polygon">Polygon</a>&lt;/code&gt; handles mouse events. |
1093+
| **`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. |
1094+
| **`tag`** | <code>string</code> | |
10971095

10981096

10991097
#### Circle
@@ -1269,32 +1267,9 @@ The callback function to be called when map events are emitted.
12691267
<code>(data: T): void</code>
12701268

12711269

1272-
#### Position
1273-
1274-
A <a href="#position">Position</a> is an array of coordinates.
1275-
https://tools.ietf.org/html/rfc7946#section-3.1.1
1276-
Array should contain between two and three elements.
1277-
The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values),
1278-
but the current specification only allows X, Y, and (optionally) Z to be defined.
1279-
1280-
Note: the type will not be narrowed down to `[number, number] | [number, number, number]` due to
1281-
marginal benefits and the large impact of breaking change.
1282-
1283-
See previous discussions on the type narrowing:
1284-
- {@link https://github.com/DefinitelyTyped/DefinitelyTyped/pull/21590|Nov 2017}
1285-
- {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/67773|Dec 2023}
1286-
- {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/71441| Dec 2024}
1287-
1288-
One can use a
1289-
{@link https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates|user-defined type guard that returns a type predicate}
1290-
to determine if a position is a 2D or 3D position.
1291-
1292-
<code>number[]</code>
1293-
1294-
12951270
#### Marker
12961271

1297-
Supports markers of either either "legacy" or "advanced" types.
1272+
Supports markers of either "legacy" or "advanced" types.
12981273

12991274
<code>google.maps.<a href="#marker">Marker</a> | google.maps.marker.AdvancedMarkerElement</code>
13001275

‎scripts/docgen_updates.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ try {
2828
function geojsonDependencyPath() {
2929
// 1. check npm install path
3030
const geojsonPathNpm = path.resolve('../node_modules/@types/geojson');
31-
if (fs.existsSync(geojsonPath)) {
31+
if (fs.existsSync(geojsonPathNpm)) {
3232
return geojsonPathNpm;
3333
}
3434
// 2. check pnpm-style path
@@ -41,4 +41,4 @@ function geojsonDependencyPath() {
4141
}
4242
// 3. no geojson found
4343
return '';
44-
}
44+
}

0 commit comments

Comments
 (0)