bridges.text.Text Class Reference

This is an object for defining text labels as part of the symbol collection. More...

Inheritance diagram for bridges.text.Text:

Public Member Functions
	__init__ (self, label=None)
	Constructor for a Symbol.
	get_shape_type (self)
	set_anchor_alignment (self, typeLR, typeTB)
	Sets the alignment parameters for the text label.
	set_anchor_location (self, x, y)
	sets the origin for the label
	get_json_representation (self)
	Get the json representation of the Symbol class.
Public Member Functions inherited from bridges.symbol.Symbol
	print_mat (self, list m)
	print the current matrix for debugging
list	identity (self, list m)
	create the identity matrix
list	mat_mult (self, list m1, list m2)
list	vec_mat_mult (self, list m, list v)
	translate (self, float tx, float ty)
	scale (self, *args)
	scale the symbol from a particular center location
	rotate (self, *args)
	set_transform (self, float a, float b, float c, float d, float e, float f)
	add_all_json (self, symbol_json, parent)

Public Attributes
	stroke_width

Protected Attributes
	_text
	_font_size
	_anchor_alignment_lr
	_anchor_alignment_tb
	_locx
	_locy
Protected Attributes inherited from bridges.symbol.Symbol
	_label
	_fill_color
	_stroke_color
	_opacity
	_stroke_width
	_stroke_dash
	_layer
	_transform
	_xform
	_xform_flag

Properties
	text = property
	font_size = property
	anchor_location = property
Properties inherited from bridges.symbol.Symbol
	label = property
	Getter for symbol label.
	fill_color = property
	Getter for the fill color.
	stroke_color = property
	Getter for the stroke color.
	stroke_width = property
	Getter for the stroke width.
	opacity = property
	Getter for opacity.
	stroke_dash = property
	Getter for stroke_dash.
	layer = property
	xform = property

Detailed Description

This is an object for defining text labels as part of the symbol collection.

Author

Matthew Mcquaigue, Erik Saule

Date

7/18/22 (last modified)

\sa Symbol Collection tutorial : http://bridgesuncc.github.io/tutorials/Symbol_Collection.html

Constructor & Destructor Documentation

__init__()

bridges.text.Text.__init__	(		self,
			label = None
	)

Constructor for a Symbol.

Reimplemented from bridges.symbol.Symbol.

Member Function Documentation

get_json_representation()

bridges.text.Text.get_json_representation

(

self

)

Get the json representation of the Symbol class.

Returns

dict the JSON representation

Reimplemented from bridges.symbol.Symbol.

get_shape_type()

bridges.text.Text.get_shape_type

(

self

)

Reimplemented from bridges.symbol.Symbol.

set_anchor_alignment()

bridges.text.Text.set_anchor_alignment	(		self,
			typeLR,
			typeTB
	)

Sets the alignment parameters for the text label.

   @param typeLR valid parameters are "left", "middle", and "right"
   @param typeTB valid parameters are "top", "bottom",  "embottom", "emtop", "middle"

   @return  symbol

set_anchor_location()

bridges.text.Text.set_anchor_location	(		self,
			x,
			y
	)

sets the origin for the label

   @param x x coordinate (in pixels)
   @param y y coordinate (in pixels)

Member Data Documentation

_anchor_alignment_lr

bridges.text.Text._anchor_alignment_lr

protected

_anchor_alignment_tb

bridges.text.Text._anchor_alignment_tb

protected

_font_size

bridges.text.Text._font_size

protected

_locx

bridges.text.Text._locx

protected

_locy

bridges.text.Text._locy

protected

_text

bridges.text.Text._text

protected

stroke_width

bridges.text.Text.stroke_width

Property Documentation

anchor_location

bridges.text.Text.anchor_location = property

static

font_size

bridges.text.Text.font_size = property

static

text

bridges.text.Text.text = property

static

---

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

• bridges-python/bridges/text.py