bridges.world_map.WorldMap Class Reference

This class provides an API to displaying world maps in BRIDGES. More...

Inheritance diagram for bridges.world_map.WorldMap:

Public Member Functions
def	get_projection (self)
def	get_overlay (self)
def	get_data_structure_type (self)
def	get_data_structure_representation (self)
	Getter for the data structure's JSON representatoin. More...
def	get_map_representation (self)
	gets the JSON representation of the map data More...
def	__init__ (self)
	Constructor: creates an object. More...

Detailed Description

This class provides an API to displaying world maps in BRIDGES.

See the Maps tutorials for examples of the usage of the US Map API at https://bridgesuncc.github.io/tutorials/Map.html

Constructor & Destructor Documentation

__init__()

def bridges.world_map.WorldMap.__init__

(

self

)

Constructor: creates an object.

Reimplemented from bridges.map.Map.

Member Function Documentation

get_data_structure_representation()

def bridges.world_map.WorldMap.get_data_structure_representation

(

self

)

Getter for the data structure's JSON representatoin.

Returns

str the data structure representation

get_data_structure_type()

def bridges.world_map.WorldMap.get_data_structure_type

(

self

)

get_map_representation()

def bridges.world_map.WorldMap.get_map_representation

(

self

)

gets the JSON representation of the map data

   Uses functions to convert the state and country attributes to objects
   before serialization into a JSON string

Reimplemented from bridges.map.Map.

get_overlay()

def bridges.world_map.WorldMap.get_overlay

(

self

)

Reimplemented from bridges.map.Map.

get_projection()

def bridges.world_map.WorldMap.get_projection

(

self

)

Reimplemented from bridges.map.Map.

---

The documentation for this class was generated from the following file:

• bridges-python/bridges/world_map.py