Skip to content

Commit c80c066

Browse files
committed
Update docs
1 parent dbae830 commit c80c066

3 files changed

Lines changed: 25 additions & 7 deletions

File tree

src/three/plugins/API.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,10 @@ constructor(
262262
format?: string,
263263
tileDimension = 256: number,
264264
styles?: string,
265-
version?: string,
265+
version = '1.3.0': string,
266+
transparent = false: boolean,
267+
levels = 18: number,
268+
contentBoundingBox = null: Array<number> | null,
266269
opacity = 1: number,
267270
color = 0xffffff: number | Color,
268271
frame = null: Matrix4,
@@ -483,9 +486,12 @@ constructor(
483486
layer?: string,
484487
crs?: string,
485488
format?: string,
486-
tileDimension?: number,
489+
tileDimension = 256: number,
487490
styles?: string,
488-
version?: string,
491+
version = '1.3.0': string,
492+
transparent = false: boolean,
493+
levels = 18: number,
494+
contentBoundingBox = null: Array<number> | null,
489495
}
490496
)
491497
```

src/three/plugins/images/EPSGTilesPlugin.js

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,12 @@ export class WMTSTilesPlugin extends EllipsoidProjectionTilesPlugin {
130130
* @param {string} [options.layer] WMS layer name.
131131
* @param {string} [options.crs] Coordinate reference system, e.g. `'EPSG:4326'`.
132132
* @param {string} [options.format] Image MIME type, e.g. `'image/png'`.
133-
* @param {number} [options.tileDimension] Tile pixel size (defaults to 256).
133+
* @param {number} [options.tileDimension=256] Tile pixel size.
134134
* @param {string} [options.styles] WMS styles parameter.
135-
* @param {string} [options.version] WMS version string, e.g. `'1.3.0'`.
135+
* @param {string} [options.version='1.3.0'] WMS version string.
136+
* @param {boolean} [options.transparent=false] Whether to request a transparent image.
137+
* @param {number} [options.levels=18] Number of zoom levels.
138+
* @param {number[]|null} [options.contentBoundingBox=null] Content bounding box in radians `[west, south, east, north]`. If null, uses full projection bounds.
136139
*/
137140
export class WMSTilesPlugin extends EllipsoidProjectionTilesPlugin {
138141

@@ -146,6 +149,9 @@ export class WMSTilesPlugin extends EllipsoidProjectionTilesPlugin {
146149
tileDimension,
147150
styles,
148151
version,
152+
transparent,
153+
levels,
154+
contentBoundingBox,
149155
...rest
150156
} = options;
151157

@@ -159,7 +165,10 @@ export class WMSTilesPlugin extends EllipsoidProjectionTilesPlugin {
159165
format,
160166
tileDimension,
161167
styles,
162-
version
168+
version,
169+
transparent,
170+
levels,
171+
contentBoundingBox,
163172
} );
164173

165174
}

src/three/plugins/images/ImageOverlayPlugin.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1719,7 +1719,10 @@ export class GeoJSONOverlay extends ImageOverlay {
17191719
* @param {string} [options.format] Image MIME type, e.g. `'image/png'`.
17201720
* @param {number} [options.tileDimension=256] Tile pixel size.
17211721
* @param {string} [options.styles] WMS styles parameter.
1722-
* @param {string} [options.version] WMS version string, e.g. `'1.3.0'`.
1722+
* @param {string} [options.version='1.3.0'] WMS version string.
1723+
* @param {boolean} [options.transparent=false] Whether to request a transparent image.
1724+
* @param {number} [options.levels=18] Number of zoom levels.
1725+
* @param {number[]|null} [options.contentBoundingBox=null] Content bounding box in radians `[west, south, east, north]`. If null, uses full projection bounds.
17231726
* @param {number} [options.opacity=1] Overlay opacity (0–1).
17241727
* @param {number|Color} [options.color=0xffffff] Tint color.
17251728
* @param {Matrix4} [options.frame=null] Planar projection frame. If null, cartographic projection is used.

0 commit comments

Comments
 (0)