@openglobus/og 0.18.0 → 0.18.2

package/lib/js/layer/WMS.d.ts

@@ -0,0 +1,75 @@
+import { Extent } from "../Extent";
+import { Segment } from "../segment/Segment";
+import { XYZ, IXYZParams } from "./XYZ";
+interface IWMSParams extends IXYZParams {
+    extra?: any;
+    layers: string;
+    imageWidth?: number;
+    imageHeight?: number;
+    version?: string;
+}
+/**
+ * Used to display WMS services as tile layers on the globe.
+ * @class
+ * @extends {XYZ}
+ * @param {string} name - Layer name.
+ * @param {Object} options - Options:
+ * @param {number} [options.opacity=1.0] - Layer opacity.
+ * @param {number} [options.minZoom=0] - Minimal visibility zoom level.
+ * @param {number} [options.maxZoom=0] - Maximal visibility zoom level.
+ * @param {string} [options.attribution] - Layer attribution that displayed in the attribution area on the screen.
+ * @param {boolean} [options.isBaseLayer=false] - Base layer flag.
+ * @param {boolean} [options.visibility=true] - Layer visibility.
+ * @param {string} options.url - WMS url source.
+ * @param {number} [options.width=256] - Tile width.
+ * @param {number} [options.height=256] - Tile height.
+ * @param {string} options.layers - WMS layers string.
+ * @param {string} [options.version="1.1.1"] - WMS version.
+ * @param {Object} extra  - Extra parameters (by WMS reference or by WMS service vendors) to pass to WMS service.
+ * @example:
+ * new og.layer.WMS("USA States", {
+ *     isBaseLayer: false,
+ *     url: "http://openglobus.org/geoserver/",
+ *     layers: "topp:states",
+ *     opacity: 0.5,
+ *     zIndex: 50,
+ *     attribution: 'USA states - geoserver WMS example',
+ *     version: "1.1.1",
+ *     visibility: false }, {
+ *     transparent: true,
+ *     sld: "style.sld"}
+ * );
+ */
+declare class WMS extends XYZ {
+    protected _extra: string;
+    /**
+     * WMS layers string.
+     * @public
+     * @type {string}
+     */
+    layers: string;
+    /**
+     * WMS tile width.
+     * @public
+     * @type {number}
+     */
+    imageWidth: number;
+    /**
+     * WMS tile height.
+     * @public
+     * @type {number}
+     */
+    imageHeight: number;
+    protected _getBbox: (extent: Extent) => string;
+    protected _version: string;
+    constructor(name: string | null, options: IWMSParams);
+    static createRequestUrl(url: string, layers: string, format: string | undefined, version: string | undefined, request: string | undefined, srs: string, bbox: string, width?: number, height?: number, extra?: string): string;
+    static get_bbox_v1_1_1(extent: Extent): string;
+    static get_bbox_v1_3_0(extent: Extent): string;
+    _checkSegment(segment: Segment): boolean;
+    get instanceName(): string;
+    protected _createUrl(segment: Segment): string;
+    setVersion(version?: string): void;
+    _correctFullExtent(): void;
+}
+export { WMS };

package/{src/layer/WMS.ts → lib/js/layer/WMS.js}

@@ -1,17 +1,7 @@
 import * as mercator from "../mercator";
-import {Extent} from "../Extent";
-import {LonLat} from "../LonLat";
-import {Segment} from "../segment/Segment";
-import {XYZ, IXYZParams} from "./XYZ";
-
-interface IWMSParams extends IXYZParams {
-    extra?: any;
-    layers: string;
-    imageWidth?: number;
-    imageHeight?: number;
-    version?: string;
-}
-
+import { Extent } from "../Extent";
+import { LonLat } from "../LonLat";
+import { XYZ } from "./XYZ";
 /**
  * Used to display WMS services as tile layers on the globe.
  * @class
@@ -45,150 +35,78 @@ interface IWMSParams extends IXYZParams {
  * );
  */
 class WMS extends XYZ {
-
-    protected _extra: string;
-
-    /**
-     * WMS layers string.
-     * @public
-     * @type {string}
-     */
-    public layers: string;
-
-    /**
-     * WMS tile width.
-     * @public
-     * @type {number}
-     */
-    public imageWidth: number;
-
-    /**
-     * WMS tile height.
-     * @public
-     * @type {number}
-     */
-    public imageHeight: number;
-
-    protected _getBbox: (extent: Extent) => string;
-
-    protected _version: string;
-
-    constructor(name: string | null, options: IWMSParams) {
+    constructor(name, options) {
         super(name, options);
-
         this._extra = new URLSearchParams(options.extra).toString();
-
         if (!options.extent) {
             this.setExtent(new Extent(new LonLat(-180.0, -90), new LonLat(180.0, 90)));
         }
-
         this.layers = options.layers;
-
         /**
          * WMS tile width.
          * @public
          * @type {number}
          */
         this.imageWidth = options.imageWidth || 256;
-
         /**
          * WMS tile height.
          * @public
          * @type {number}
          */
         this.imageHeight = options.imageHeight || 256;
-
         this._getBbox = WMS.get_bbox_v1_1_1;
-
         this._version = "";
-
         this.setVersion(options.version);
     }
-
-    static createRequestUrl(
-        url: string,
-        layers: string,
-        format: string = "image/png",
-        version: string = "1.1.1",
-        request: string = "GetMap",
-        srs: string,
-        bbox: string,
-        width: number = 256,
-        height: number = 256,
-        extra?: string
-    ): string {
+    static createRequestUrl(url, layers, format = "image/png", version = "1.1.1", request = "GetMap", srs, bbox, width = 256, height = 256, extra) {
         return `${url}/?LAYERS=${layers}&FORMAT=${format}&SERVICE=WMS&VERSION=${version}&REQUEST=${request}&SRS=${srs}&BBOX=${bbox}&WIDTH=${width}&HEIGHT=${height}` + (extra ? `&${extra}` : "");
     }
-
-    static get_bbox_v1_1_1(extent: Extent): string {
+    static get_bbox_v1_1_1(extent) {
         return `${extent.getWest()},${extent.getSouth()},${extent.getEast()},${extent.getNorth()}`;
     }
-
-    static get_bbox_v1_3_0(extent: Extent): string {
+    static get_bbox_v1_3_0(extent) {
         return `${extent.getSouth()},${extent.getWest()},${extent.getNorth()},${extent.getEast()}`;
     }
-
-    public override _checkSegment(segment: Segment) {
+    _checkSegment(segment) {
         return true;
     }
-
-    public override get instanceName(): string {
+    get instanceName() {
         return "WMS";
     }
-
-    protected override _createUrl(segment: Segment): string {
-        return WMS.createRequestUrl(
-            this.url,
-            this.layers,
-            "image/png",
-            this._version,
-            "GetMap",
-            segment._projection.code,
-            this._getBbox(segment.getExtent()),
-            this.imageWidth,
-            this.imageHeight,
-            this._extra
-        );
+    _createUrl(segment) {
+        return WMS.createRequestUrl(this.url, this.layers, "image/png", this._version, "GetMap", segment._projection.code, this._getBbox(segment.getExtent()), this.imageWidth, this.imageHeight, this._extra);
     }
-
-    public setVersion(version?: string) {
+    setVersion(version) {
         if (version) {
             this._version = version;
-        } else {
+        }
+        else {
             this._version = "1.1.1";
         }
-
         if (this._version === "1.1.1") {
             this._getBbox = WMS.get_bbox_v1_1_1;
-        } else if (version === "1.3.0") {
+        }
+        else if (version === "1.3.0") {
             this._getBbox = WMS.get_bbox_v1_3_0;
         }
     }
-
-    public override _correctFullExtent() {
+    _correctFullExtent() {
         const e = this._extent;
         const em = this._extentMerc;
-
         const ENLARGE_MERCATOR_LON = mercator.POLE + 50000;
         const ENLARGE_MERCATOR_LAT = mercator.POLE + 50000;
-
         if (e.northEast.lat === 90.0) {
             em.northEast.lat = ENLARGE_MERCATOR_LAT;
         }
-
         if (e.northEast.lon === 180.0) {
             em.northEast.lon = ENLARGE_MERCATOR_LON;
         }
-
         if (e.southWest.lat === -90.0) {
             em.southWest.lat = -ENLARGE_MERCATOR_LAT;
         }
-
         if (e.southWest.lon === -180.0) {
             em.southWest.lon = -ENLARGE_MERCATOR_LON;
         }
     }
 }
-
-export {WMS};
-
+export { WMS };

package/lib/js/layer/XYZ.d.ts

@@ -0,0 +1,149 @@
+import { Layer, ILayerParams, LayerEventsList } from "./Layer";
+import { Segment } from "../segment/Segment";
+import { EventsHandler } from "../Events";
+import { Material } from "./Material";
+import { NumberArray4 } from "../math/Vec4";
+export interface IXYZParams extends ILayerParams {
+    url?: string;
+    subdomains?: string[];
+    minNativeZoom?: number;
+    maxNativeZoom?: number;
+    urlRewrite?: Function;
+}
+type XYZEventsList = [
+    "load",
+    "loadend"
+];
+type XYZEventsType = EventsHandler<XYZEventsList> & EventsHandler<LayerEventsList>;
+/**
+ * Represents an imagery tiles source provider.
+ * @class
+ * @extends {Layer}
+ * @param {string} name - Layer name.
+ * @param {IXYZParams} options:
+ * @param {number} [options.opacity=1.0] - Layer opacity.
+ * @param {Array.<string>} [options.subdomains=['a','b','c']] - Subdomains of the tile service.
+ * @param {number} [options.minZoom=0] - Minimal visibility zoom level.
+ * @param {number} [options.maxZoom=0] - Maximal visibility zoom level.
+ * @param {number} [options.minNativeZoom=0] - Minimal available zoom level.
+ * @param {number} [options.maxNativeZoom=19] - Maximal available zoom level.
+ * @param {string} [options.attribution] - Layer attribution that displayed in the attribution area on the screen.
+ * @param {boolean} [options.isBaseLayer=false] - Base layer flag.
+ * @param {boolean} [options.visibility=true] - Layer visibility.
+ * @param {string} [options.crossOrigin=true] - If true, all tiles will have their crossOrigin attribute set to ''.
+ * @param {string} options.url - Tile url source template(see example below).
+ * @param {string} options.textureFilter - texture gl filter. NEAREST, LINEAR, MIPMAP, ANISOTROPIC.
+ * @param {Function} options.urlRewrite - Url rewrite function.
+ *
+ * @fires EventsHandler<XYZEventsList>#load
+ * @fires EventsHandler<XYZEventsList>#loadend
+ *
+ * @example <caption>Creates OpenStreetMap base tile layer</caption>
+ * new og.layer.XYZ("OpenStreetMap", {
+ *     isBaseLayer: true,
+ *     url: "http://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
+ *     visibility: true,
+ *     attribution: 'Data @ <a href="http://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="http://www.openstreetmap.org/copyright">ODbL</a>'
+ * });
+ */
+export declare class XYZ extends Layer {
+    events: XYZEventsType;
+    /**
+     * Tile url source template.
+     * @public
+     * @type {string}
+     */
+    url: string;
+    /**
+     * @protected
+     */
+    protected _s: string[];
+    /**
+     * Minimal native zoom level when tiles are available.
+     * @public
+     * @type {number}
+     */
+    minNativeZoom: number;
+    /**
+     * Maximal native zoom level when tiles are available.
+     * @public
+     * @type {number}
+     */
+    maxNativeZoom: number;
+    /**
+     * Rewrites imagery tile url query.
+     * @private
+     * @callback og.layer.XYZ~_urlRewriteCallback
+     * @param {Segment} segment - Segment to load.
+     * @param {string} url - Created url.
+     * @returns {string} - Url query string.
+     */
+    protected _urlRewriteCallback: Function | null;
+    protected _requestsPeerSubdomains: number;
+    protected _requestCount: number;
+    constructor(name: string | null, options?: IXYZParams);
+    /**
+     * @warning Use XYZ.isIdle in requestAnimationFrame(after setVisibility)
+     */
+    get isIdle(): boolean;
+    get instanceName(): string;
+    /**
+     * Abort loading tiles.
+     * @public
+     */
+    abortLoading(): void;
+    /**
+     * Sets layer visibility.
+     * @public
+     * @param {boolean} visibility - Layer visibility.
+     */
+    setVisibility(visibility: boolean): void;
+    remove(): this;
+    /**
+     * Sets imagery tiles url source template.
+     * @public
+     * @param {string} url - Url template.
+     * @example
+     * http://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
+     * where {z}, {x} and {y} - replaces by current tile values, {s} - random domain.
+     */
+    setUrl(url: string): void;
+    _checkSegment(segment: Segment): boolean;
+    /**
+     * Start to load tile material.
+     * @public
+     * @virtual
+     * @param {Material} material - Loads current material.
+     * @param {boolean} [forceLoading=false] -
+     */
+    loadMaterial(material: Material, forceLoading?: boolean): void;
+    /**
+     * Creates query url.
+     * @protected
+     * @virtual
+     * @param {Segment} segment - Creates specific url for current segment.
+     * @returns {string} - Returns url string.
+     */
+    protected _createUrl(segment: Segment): string;
+    protected _getSubdomain(): string;
+    /**
+     * Returns actual url query string.
+     * @protected
+     * @param {Segment} segment - Segment that loads image data.
+     * @returns {string} - Url string.
+     */
+    protected _getHTTPRequestString(segment: Segment): any;
+    /**
+     * Sets url rewrite callback, used for custom url rewriting for every tile loading.
+     * @public
+     * @param {Function} ur - The callback that returns tile custom created url.
+     */
+    setUrlRewriteCallback(ur: Function): void;
+    applyMaterial(material: Material, forceLoading?: boolean): NumberArray4;
+    clearMaterial(material: Material): void;
+    /**
+     * @protected
+     */
+    protected _correctFullExtent(): void;
+}
+export {};