locar-tiler 0.2.0 → 0.4.0

package/README.md

@@ -12,9 +12,9 @@ Consequently `locar-tiler` needs to be provided with a server URL which accepts
 
 Note that `locar-tiler` does not include any mechanism to cache the tiled data - this is up to the developer to do. It merely downloads the tiled data when needed (i.e. the user moves into a new area) and holds it in memory so the data for that tile isn't downloaded if the user revisits that tile in the same session.
 
-## Overview of classes
+## API Documentation
 
-Full API documentation is available in `docs`. 
+Available on [GitHub Pages](https://ar-js-org.github.io/locar-tiler).
 
 ## Based on
 

package/dist/locar-tiler.d.ts

@@ -83,7 +83,7 @@ export declare class DemTiler extends Tiler {
      * @param {EastNorth} sphMercPos - the Spherical Mercator position.
      * @return {number} the elevation in metres, or Number.NEGATIVE_INFINITY if this position is outside the extent of the DEM.
      */
-    getElevation(sphMercPos: EastNorth): number;
+    getElevation(sphMercPos: EastNorth): number | null;
     /**
      * Obtain the elevation in metres for a given longitude/latitude.
      * @param {LonLat} lonLat - the longitude/latitude.
@@ -113,6 +113,22 @@ export declare class EastNorth {
      * @param {number} n - the northing.
      */
     constructor(e: any, n: any);
+    /**
+     * Returns a string representation of the EastNorth.
+     * @return {string} the string representation.
+     */
+    toString(): string;
+}
+
+export declare interface Feature {
+    type: string;
+    properties: any; 
+    geometry: Point | LineString | MultiLineString;
+}
+
+export declare interface FeatureCollection {
+    type: string;
+    features: Array<Feature>;
 }
 
 /** Class representing a Tiler which delivers JSON data. */
@@ -131,6 +147,11 @@ export declare class JsonTiler extends Tiler {
     readTile(url: string): Promise<any>;
 }
 
+export declare interface LineString {
+    type: string;
+    coordinates: number[][];
+}
+
 /** Represents a longitude/latitude.
  * @property {number} lon - the longitude.
  * @property {number} lat -the latitude.
@@ -139,12 +160,27 @@ export declare class LonLat {
     lon: number;
     lat: number;
     /**
-     * Creates an LonLat.
+     * Creates a LonLat.
      * @class
      * @param {number} lon - the longitude.
      * @param {number} lat - the latitude.
      */
     constructor(lon: any, lat: any);
+    /**
+     * Returns a string representation of the LonLat.
+     * @return {string} the string representation.
+     */
+    toString(): string;
+}
+
+export declare interface MultiLineString {
+    type: string;
+    coordinates: number[][][];
+}
+
+export declare interface Point {
+    type: string;
+    coordinates: number[];
 }
 
 export declare interface RawPngData {
@@ -223,6 +259,7 @@ export declare class Tile {
      * @return {string} a string indexing the tile in format z/x/y
      */
     getIndex(): string;
+    toString(): string;
 }
 
 /** Represents a tiler, capable of delivering Tiles from a given URL. */
@@ -284,7 +321,7 @@ export declare abstract class Tiler {
      * @param {number} z - zoom level to use (default 13)
      * @return {Promise<Tile>} Promise resolving with the given Tile.
      */
-    getData(sphMercPos: EastNorth, z?: number): Promise<Tile>;
+    getData(sphMercPos: EastNorth, z?: number): Promise<DataTile>;
     /**
      * Converts the raw data from the server to a custom type of data.
      * By default, returns a DataTile object containing the Tile and the raw data returned from readTile(), but this can be overridden (e.g. in DemTile the `data` of the DataTile is a DEM object).