Bridges-Java  3.4.4-dev2-4-g23cf54b
Bridges(Java API)
Public Member Functions | List of all members
bridges.base.USMap Class Reference

This class provides an API to building, displaying and manipulating US maps and counties in BRIDGES. More...

Inheritance diagram for bridges.base.USMap:
bridges.base.DataStruct bridges.base.AbstrMap

Public Member Functions

 USMap (ArrayList< USState > st_data)
 
String getDataStructureRepresentation ()
 get JSON representation of the data structure - a dummy string More...
 
String getDataStructType ()
 
String getProjection ()
 
Boolean getOverlay ()
 Gets the map overlay flag. More...
 
ArrayList< USStategetMapData ()
 
void setStateData (ArrayList< USState > st_data)
 
String getMapRepresentation ()
 

Additional Inherited Members

- Protected Attributes inherited from bridges.base.DataStruct
String QUOTE = "\""
 
- Package Attributes inherited from bridges.base.DataStruct
String COMMA = ","
 
String COLON = ":"
 
String OPEN_CURLY = "{"
 
String CLOSE_CURLY = "}"
 
String OPEN_PAREN = "("
 
String CLOSE_PAREN = ")"
 
String OPEN_BOX = "["
 
String CLOSE_BOX = "]"
 

Detailed Description

This class provides an API to building, displaying and manipulating US maps and counties in BRIDGES.

In the current implementation, we can draw a US map with all state boundaries, a map with all US state and county boundaries, or specify a set of states and display the state and/or county boundaries.

Functions are provided to access each US state or county and color its boundary or its interior using the stroke color and fill color functions. This lets us build map based applications where the fill fill color can be used to represent different data attributes, such population counts, election statistics or any attribute at the state or county level.

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

◆ USMap()

bridges.base.USMap.USMap ( ArrayList< USState st_data)

Member Function Documentation

◆ getDataStructType()

String bridges.base.USMap.getDataStructType ( )

Reimplemented from bridges.base.DataStruct.

◆ getDataStructureRepresentation()

String bridges.base.USMap.getDataStructureRepresentation ( )

get JSON representation of the data structure - a dummy string

Returns
JSON string

Reimplemented from bridges.base.DataStruct.

◆ getMapData()

ArrayList<USState> bridges.base.USMap.getMapData ( )

◆ getMapRepresentation()

String bridges.base.USMap.getMapRepresentation ( )

Implements bridges.base.AbstrMap.

◆ getOverlay()

Boolean bridges.base.USMap.getOverlay ( )

Gets the map overlay flag.

Returns
boolean

Implements bridges.base.AbstrMap.

◆ getProjection()

String bridges.base.USMap.getProjection ( )

Implements bridges.base.AbstrMap.

◆ setStateData()

void bridges.base.USMap.setStateData ( ArrayList< USState st_data)

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