====== ThinkGeoCloudClient-js ====== ===== NameSapce =====

**tg** is the abbreviation of ThinkGeo, the namespace of ThinkGeoCloudClient-js

===== tg.ColorClient =====

A class provides the methods to access the ColorUtilities APIs. Generats an diversified family of colors by an input color or a random base color.

Syntax


var colorClient = new tg.ColorClient('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a color object to access the ColorUtilities APIs in ThinkGeo Cloud service.

colorClient.getColorsInAnalogousFamily(options, callback)

Get a family of colors based on three analogous hues.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInAnalogousFamily(options, callback);

Parameters

colorClient.getColorsInComplementaryFamily(options, callback)

Get a family of colors based on two complementary hues.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInComplementaryFamily(options, callback);

Parameters

colorClient.getColorsInContrastingFamily(options, callback)

Get a family of colors based on two contrasting hues.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInContrastingFamily(options, callback);

Parameters

colorClient.getColorsInHueFamily(options, callback)

Get a family of colors with the same hue and sequential variances in lightness and saturation.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInHueFamily(options, callback);

Parameters

colorClient.getColorsInQualityFamily(options, callback)

Get a family of colors with qualitative variances in hue, but similar lightness and saturation.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInQualityFamily(options, callback);

Parameters

colorClient.getColorsInTetradFamily(options, callback)

Get a family of colors based on a harmonious tetrad of hues.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInTetradFamily(options, callback);

Parameters

colorClient.getColorsInTriadFamily(options, callback)

Get a family of colors based on a harmonious triad of hues.

Syntax


  var options = {
      numberOfColors: 25
  };
  var callback = function (status, response) {
      console.log(response);
  };
  colorClient.getColorsInTetradFamily(options, callback);

Parameters

===== tg.ElevationClient=====

A class provides the methods to access the Elevation APIs. Get the elevation of a geometry, include point, line, polygon.

Syntax


var elevationClient = new tg.ElevationClient('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a elevation object to access the Elevation APIs in ThinkGeo Cloud service.

elevationClient.getElevationOfPoint(options, callback)

Get the elevation of a point.

Syntax


  var options = {
      pointY: 33.128367, 
      pointX:-96.809847,
      srid: 4326,
      elevationUnit:'Feet'
  };
  var callback = function (status, response) {
      console.log(response);
  };
  elevationClient.getElevationOfPoint(options, callback);

Parameters

elevationClient.getElevationOfPoints(options, callback)

Get the elevations of all the points in a collection (up to 1,000 points maximum).

Syntax


   var options = {
      body:[
            {
               "coord":"33.128367,-96.809847",
               "srid":4326,
               "elevationUnit":"Meter"
            }
      ]
      srid: 4326,
      elevationUnit:'Meter'
  };
  var callback = function (status, response) {
      console.log(response);
  };
  elevationClient.getElevationOfPoints(options, callback);

Parameters

elevationClient.getElevationOfLine(options, callback)

Get the elevation of points along a line.

Syntax


 var options = {
      wkt: 'LINESTRING(-10717751.685805485 3864388.620499513,-10717359.946035523 3864570.1584416907)',
      srid: 3857,
      numberOfSegments:5,
      elevationUnit:'Meter',
  };
  var callback = function (status, response) {
      console.log(response);
  };
  elevationClient.getElevationOfPoints(options, callback);

Parameters

elevationClient.getGradeOfLine(options, callback)

Get the grade (slope) of a line, optionally split into segments.

Syntax


 var options = {
      wkt: 'LINESTRING(-10717751.685805485 3864388.620499513,-10717359.946035523 3864570.1584416907)',
      srid: 3857,
      numberOfSegments:5,
      elevationUnit:'Meter',
  };
  var callback = function (status, response) {
      console.log(response);
  };
  elevationClient.getGradeOfLine(options, callback);

Parameters

elevationClient.getElevationOfArea(options, callback)

Get the elevation of a matrix of points within an area

Syntax


 var options = {
      wkt: 'POLYGON((-10717723.021919878 3864742.1417553322,-10718038.324661555 3864426.839013656,-10716901.323865812 3864503.2760419413,-10717723.021919878 3864742.1417553322))',
      srid: 3857,
      numberOfSegments:5,
      elevationUnit:'Meter',
  };
  var callback = function (status, response) {
      console.log(response);
  };
  elevationClient.getElevationOfArea(options, callback);

Parameters

===== tg.MapsClient =====

A class provides the methods to access the WorldImagery APIs.

Syntax


var mapClient = new tg.MapsClient ('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a map object to access the Map APIs in ThinkGeo Cloud service.

mapClient.getRasterTile(options, callback)

Get a Maps raster tile by XYZ.

Syntax


  var options = {
      z: 3, 
      x: 2,
      y: 3,
      projection: 3857,
      mapType:'light',
      tileSize:512
      tileResolution:1
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapClient.getRasterTile(options, callback);

Parameters

mapClient.getVectorTile(options, callback)

Get a Maps Streets vector tile by XYZ.

Syntax


  var options = {
      z: 3, 
      x: 2,
      y: 3,
      projection: 3857
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapClient.getVectorTile(options, callback);

Parameters

===== tg.ProjectionClient =====

A class that provides the methods to access the GIS Server Projection APIs. Converts geometry in Well Known Text format from one spatial reference system to another.

Syntax


var projectionClient = new tg.ProjectionClient('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a project object to access the Projection APIs in ThinkGeo Cloud service.

projectionClient.project(options, callback)

Converts a geometry from one spatial reference system to another.

Syntax


  var options = {
    pointX: 31.9000,
    pointY: -55.0000,
    fromProj: 4326,
    toProj: 3857
  };
  var callback = function (status, response) {
      console.log(response);
  };
  projectionClient.project(options, callback);

Parameters

projectionClient.projectForPoint(pointY, pointX, fromProj, toProj, callback)

Converts a geometry from one spatial reference system to another.

Syntax


  var callback = function (status, response) {
      console.log(response);
  };
  projectionClient.projectForPoint(-55.0000,31.9000,4326,3857, callback);

Parameters

projectionClient.projectForGeometry(wkt, fromProj, toProj, callback)

Converts geometry in Well Known Text format from one spatial reference system to another.

Syntax


  var callback = function (status, response) {
      console.log(response);
  };
  projectionClient.projectForGeometry('LINESTRING(-1399103.3657318656 308805.5942721125,-802283.0488812095 592539.8432666864)',3857, 4326, callback);

Parameters

projectionClient.projectForGeometries(options, callback)

Converts a collection of geometries in Well Known Text format from one spatial reference system to another.

Syntax


   var wktArr=[
      "POINT(-997961.8412912609 563188.0244051788)",
      "POINT(-900122.4450862352 484916.5074411584)",
      "POINT(-802283.0488812095 612107.7225076917)"
   ];
   var options = {
      body: {
          wkt: wktArr,
          fromProj: "3857",
          toProj: "4326"
      }
  };
  var callback = function (status, response) {
      console.log(response);
  };
  projectionClient.projectForGeometries(options , callback);

Parameters

===== tg.ReverseGeocodingClient =====

A class provides the methods to access the ReverseGeocoding APIs. Reverse geocode to find locations near a geometry.

Syntax


  var reverseGeocodingClient = new tg.ReverseGeocodingClient ('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a ReverseGeocoding object to access the ReverseGeocoding APIs in ThinkGeo Cloud service.

reverseGeocodingClient.search(options, callback)

Searches for locations around a geometry.

Syntax


  var options = {
      pointX: -10780076.527743513,
      pointY: 3864866.351926295,
      srid: 3857,
  };
  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.search(options , callback);

Parameters

reverseGeocodingClient.searchPlaceByPoint(pointY, pointX, callback, options)

Searches for locations around a geometry.

Syntax


  var options = {
      srid: 3857
  };
  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.searchPlaceByPoint(3864866.351926295, -10780076.527743513, callback, options);

Parameters

reverseGeocodingClient.searchPlaceByLine(wkt, callback, options)

Searches for locations around a line.

Syntax


  var options = {
      srid: 3857,
  };
  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.searchPlaceByLine("LINESTRING(-10780840.898026364 3864952.343583116,-10780219.847171547 3865009.67135433)", callback, options);

Parameters

reverseGeocodingClient.searchPlaceByArea(wkt, callback, options)

Searches for locations around a geometry.

Syntax


  var wkt= "POLYGON((-10780611.586941509 3864847.242669224,-10780831.343397828 3864617.9315843685,-10780363.166599581 3864637.0408414397,-10780611.586941509 3864847.242669224))"
  var options = {
      srid: 3857,
  };
  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.searchPlaceByArea(wkt, callback, options);

Parameters

reverseGeocodingClient.searchPlaceByPoints(options, callback)

Searches for locations around multi points.

Syntax



  var options = {
      body:[
          {
             coord: "32.8345,-96.8616",
             srid: 4326
          },
          {
             coord: "34.8345,-93.8616",
             srid: 4326
          }
      ]
  };
  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.searchPlaceByPoints(options , callback);

Parameters

reverseGeocodingClient.searchPlaceById(placeId, callback, options)

Get details about a place by its OpenStreetMap ID.

Syntax


  var options={
      lang:"en"
  }
  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.searchPlaceById(8689729, callback, options);

Parameters

reverseGeocodingClient.getPlaceCatergories(callback)

Get the available location categories.

Syntax


  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.getPlaceCatergories(callback);

Parameters

reverseGeocodingClient.getCommonCatergories(callback)

Get the types of locations that are considered common.

Syntax


  var callback = function (status, response) {
      console.log(response);
  };
  reverseGeocodingClient.getCommonCatergories(callback);

Parameters

===== tg.GeocodingClient =====

A class provides the methods to access the GeocodingClient APIs. Geocode to get the coordinates of an address.

Syntax


var geocodingClient = new tg.GeocodingClient ('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a Geocoding object to access the Geocoding APIs in ThinkGeo Cloud service.

geocodingClient.search(options, callback)

Search for a location expression.

Syntax


  var options = {
       location: "Dallas",
       maxResults: 5,
  };
  var callback = function (status, response) {
      console.log(response);
  };
  geocodingClient.search(options, callback);

Parameters

geocodingClient.searchByPoint(location, callback, options)

Search for a location expression.

Syntax


  var options = {
       maxResults: 5,
  };
  var callback = function (status, response) {
      console.log(response);
  };
  geocodingClient.searchByPoint("Dallas", callback, options);

Parameters

geocodingClient.searchBatch(options, callback)

Search for a location expression

Syntax


  var options = {
       body:[
           {
              searchText:"Dallas",
              maxResults:5
           },
           {
              searchText:"Frisco"
           }
       ]
       maxResults: 6,
  };
  var callback = function (status, response) {
      console.log(response);
  };
  geocodingClient.searchBatch(options, callback);

Parameters

===== tg.RoutingClient =====

A class provides the methods to access the Routing APIs. Get turn-by-turn driving directions, define service areas that can be reached by car in a given time or distance, and more.

Syntax


var routingClient = new tg.RoutingClient ('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a Routing object to access the Routing APIs in ThinkGeo Cloud service.

routingClient.getRoute(waypoints, callback, options)

Get a route through the specified waypoints.

Syntax


  var waypoints = [{
    x: -96.872893,
    y: 33.184352
  },{
    x: -83.441568,
    y: 42.404719
  }];
  var options = {
       srid: 4326,
       turnByTurn: true,
       distanceUnit: 'Meter',
       durationUnit: 'Minute'
  };
  var callback = function (status, response) {
      console.log(response);
  };
  routingClient.getRoute(waypoints, callback, options);

Parameters

routingClient.getServiceArea(pointY, pointX, serviceLimits, callback, options)

Get the reachable service area (isochrones) for a coordinate point, based on the specified time or distance constraints.

Syntax


  var serviceLimits = [10, 30, 60];
  var callback = function (status, response) {
    console.log(response);
  };
  var options = {
    srid = 3857,
    serviceLimitsType = 'Time',
    durationUnit = 'minute',
    distanceUnit = 'meter'
  };
  routingClient.getServiceArea(33.184352, -96.872893, serviceLimits, callback, options);

Parameters

===== tg.MapsQueryClient =====

A class provides the methods to access the Maps Query APIs. Perform spatial query against each types of data.

Syntax


var mapsQueryClient = new tg.MapsQueryClient ('Your-Cloud-Service-Api-Key');

Parameters

Return Value

a Maps Query object to access the Maps Query APIs in ThinkGeo Cloud service.

mapsQueryClient.getFeaturesWithin(queryLayer, wkt, callback, options)

Get the features that are within the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POLYGON((15.609372854233 56.62500500679, 1.8984353542334 42.56250500679, 30.023435354233 41.15625500679, 15.609372854233 56.62500500679))';
  var options = {
       srid: 4326,
       maxResults: 100,
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesWithin(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesContaining(queryLayer, wkt, callback, options)

Get the features that contain the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POINT(-95.484377145767 36.93750500679)';
  var options = {
       srid: 4326,
       maxResults: 100,
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesContaining(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesIntersecting(queryLayer, wkt, callback, options)

Get the features that intersect the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POLYGON((15.609372854233 56.62500500679, 1.8984353542334 42.56250500679, 30.023435354233 41.15625500679, 15.609372854233 56.62500500679))';
  var options = {
       srid: 4326,
       maxResults: 100,
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesIntersecting(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesOverlapping(queryLayer, wkt, callback, options)

Get the features that overlap the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POLYGON((15.609372854233 56.62500500679, 1.8984353542334 42.56250500679, 30.023435354233 41.15625500679, 15.609372854233 56.62500500679))';
  var options = {
       srid: 4326,
       maxResults: 100,
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesOverlapping(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesTouching(queryLayer, wkt, callback, options)

Get the features that touch the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POLYGON((7595881.1058614058 -585345.10944436956,7595881.1058614058 2704373.8120167661,-3939883.7747361474 2704373.8120167661,-3939883.7747361474 -585345.10944436956,7595881.1058614058 -585345.10944436956))';
  var options = {
       srid: 3857,
       maxResults: 100,
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesTouching(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesNearest(queryLayer, wkt, callback, options)

Get the features that are nearest to the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POINT(17.367185354233 47.83594250679)';
  var options = {
       srid: 4326,
       maxResults: 100,
       searchRadius: 200,
       searchRadiusUnit: 'Kilometer',
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesNearest(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesWithinDistance(queryLayer, wkt, callback, options)

Get the features that are within a certain distance of the target shape.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POINT(17.367185354233 47.83594250679)';
  var options = {
       srid: 4326,
       maxResults: 100,
       distance: 200,
       distanceUnit: 'Kilometer',
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesWithinDistance(queryLayer, wkt, callback, options);

Parameters

mapsQueryClient.getFeaturesCustom(queryLayer, wkt, callback, options)

Perform a custom spatial query, using the specified query layer, spatial relationship type, and query feature.

Syntax


  var queryLayer = 'countries';
  var wkt = 'POLYGON((15.609372854233 56.62500500679, 1.8984353542334 42.56250500679, 30.023435354233 41.15625500679, 15.609372854233 56.62500500679))';
  var options = {
       srid: 4326,
       maxResults: 100,
       returnFeatureAttributes: true,
       featureAttributesToReturn: ['id', 'name']
  };
  var callback = function (status, response) {
      console.log(response);
  };
  mapsQueryClient.getFeaturesCustom(queryLayer, wkt, 'within', callback, options);

Parameters

===== tg.BaseClient=====

A class provides the basic methods to send request to ThinkGeo Cloud services. Subclasses: ColorClient, Elevation, GeocodingClient, MapsClient, ProjectionClient, ReverseGeocodingClient.

* sendingrequest * sentrequest


// For example elevationClient
elevationClient.on("sendingrequest", function (e){
    console.log(e);
});
elevationClient.on("sentrequest", function (e){
    console.log(e);
})