bridges.symbol_collection.SymbolCollection Class Reference

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, http://bridgesuncc.github.io/tutorials/Symbol_Collection.html

Public Member Functions
def	__init__ (self)
	Constructor for collection of symbols. More...
def	setviewport (self, xmin, xmax, ymin, ymax)
def	get_data_structure_type (self)
def	add_symbol (self, s)
	Add a symbol to the collection. More...
def	update_axis_domains (self, s)
	Update the bounding box of the symbol collection. More...
def	get_data_structure_representation (self)
	Getter for the data structure's JSON representatoin. More...

Constructor & Destructor Documentation

__init__()

def bridges.symbol_collection.SymbolCollection.__init__

(

self

)

Constructor for collection of symbols.

Member Function Documentation

add_symbol()

def 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()

def 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()

def bridges.symbol_collection.SymbolCollection.get_data_structure_type

(

self

)

setviewport()

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

update_axis_domains()

def 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

---

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

• /home/erik/work/bridges/bridges-python/bridges/symbol_collection.py