Home Reference Source
public class | source

Gisplay

Gisplay API entry point with one method for each map available.

Constructor Summary

Public Constructor
public

Creates an instance of the Gisplay API.

Member Summary

Public Members
public

TimeStamp at the beginning.

Method Summary

Public Methods
public

makeChangeMap(bgmap: Object, geometry: JSON, options: Object)

Creates a Change Map.

public

makeChorochromaticMap(bgmap: Object, geometry: JSON, options: Object)

Creates a Chorocromatic Map.

public

makeChoropleth(bgmap: Object, geometry: JSON, options: Object)

Creates a map of type Choropleth.

public

makeDotMap(bgmap: Object, geometry: JSON, options: Object)

Creates a Dot Map.

public

makeMap(gismap: Map, options: Object)

Function that executes all the process associated with the creation of thematic maps.

public

makeProportionalSymbolsMap(bgmap: Object, geometry: JSON, options: Object)

Creates a Proportional Symbols Map.

Public Constructors

public constructor() source

Creates an instance of the Gisplay API.

Public Members

public startTimeStamp: number source

TimeStamp at the beginning.

Public Methods

public makeChangeMap(bgmap: Object, geometry: JSON, options: Object) source

Creates a Change Map.

Params:

NameTypeAttributeDescription
bgmap Object

Background map object be used(atm only MapBox being used).

geometry JSON

The object that contains the data.

options Object

Object that contains user personalization options.

public makeChorochromaticMap(bgmap: Object, geometry: JSON, options: Object) source

Creates a Chorocromatic Map.

Params:

NameTypeAttributeDescription
bgmap Object

Background map object be used(atm only MapBox being used).

geometry JSON

The object that contains the data.

options Object

Object that contains user personalization options.

public makeChoropleth(bgmap: Object, geometry: JSON, options: Object) source

Creates a map of type Choropleth.

Params:

NameTypeAttributeDescription
bgmap Object

Background map object be used(atm only MapBox being used).- Background map object be used(atm only MapBox being used).

geometry JSON

The object that contains the data.

options Object

Object that contains user personalization options.

public makeDotMap(bgmap: Object, geometry: JSON, options: Object) source

Creates a Dot Map.

Params:

NameTypeAttributeDescription
bgmap Object

Background map object be used(atm only MapBox being used).

geometry JSON

The object that contains the data.

options Object

Object that contains user personalization options.

public makeMap(gismap: Map, options: Object) source

Function that executes all the process associated with the creation of thematic maps.

Params:

NameTypeAttributeDescription
gismap Map

The Gisplay Map to use (Choropleth, DotMap,etc).

options Object

Object that contains user personalization options.

TODO:

  • Should clean up this removing profiling code?

public makeProportionalSymbolsMap(bgmap: Object, geometry: JSON, options: Object) source

Creates a Proportional Symbols Map.

Params:

NameTypeAttributeDescription
bgmap Object

Background map object be used(atm only MapBox being used).

geometry JSON

The object that contains the data.

options Object

Object that contains user personalization options.