bridges.symbol_collection.SymbolCollection Class Reference

the SymbolCollection object is a container object to hold a collection of symbols (rectangles, polygons, circles, labels). More...

Public Member Functions
	__init__ (self)
	Constructor for collection of symbols.
	setviewport (self, xmin, xmax, ymin, ymax)
	Set the display size.
	get_data_structure_type (self)
	Getter for the data structure type as a JSON string Returns str the data structure type.
	add_symbol (self, s)
	Add a symbol to the collection.
	update_axis_domains (self, s)
	Update the bounding box of the symbol collection.
	get_data_structure_representation (self)
	Getter for the data structure's JSON representatoin.

Protected Attributes
	_symbols
	_domainxmin
	_domainxmax
	_domainymin
	_domainymax
	_autoupdateviewport

Detailed Description

the SymbolCollection object is a container object to hold a collection of symbols (rectangles, polygons, circles, labels).

Author

Matthew Mcquaigue

Date

2018, 7/23/19

See also

Symbol Collection tutorial, https://bridgesuncc.github.io/tutorials/Symbol_Collection.html

Constructor & Destructor Documentation

__init__()

bridges.symbol_collection.SymbolCollection.__init__

(

self

)

Constructor for collection of symbols.

Member Function Documentation

add_symbol()

bridges.symbol_collection.SymbolCollection.add_symbol	(		self,
			s
	)

Add a symbol to the collection.

Parameters

s	symbol to be added

Returns

none

get_data_structure_representation()

bridges.symbol_collection.SymbolCollection.get_data_structure_representation

(

self

)

Getter for the data structure's JSON representatoin.

Returns

str the data structure representation

get_data_structure_type()

bridges.symbol_collection.SymbolCollection.get_data_structure_type

(

self

)

Getter for the data structure type as a JSON string Returns str the data structure type.

setviewport()

bridges.symbol_collection.SymbolCollection.setviewport	(		self,
			xmin,
			xmax,
			ymin,
			ymax
	)

Set the display size.

Parameters

xmin	min x coordinate
xmax	max x coordinate
ymin	min y coordinate
ymax	max y coordinate

update_axis_domains()

bridges.symbol_collection.SymbolCollection.update_axis_domains	(		self,
			s
	)

Update the bounding box of the symbol collection.

Parameters

s	input symbol to update dimensions

Returns

none

Member Data Documentation

_autoupdateviewport

bridges.symbol_collection.SymbolCollection._autoupdateviewport

protected

_domainxmax

bridges.symbol_collection.SymbolCollection._domainxmax

protected

_domainxmin

bridges.symbol_collection.SymbolCollection._domainxmin

protected

_domainymax

bridges.symbol_collection.SymbolCollection._domainymax

protected

_domainymin

bridges.symbol_collection.SymbolCollection._domainymin

protected

_symbols

bridges.symbol_collection.SymbolCollection._symbols

protected

---

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

• bridges-python/bridges/symbol_collection.py