Bridges-Python  3.4.4
Bridges(Python API)
Public Member Functions | Public Attributes | List of all members
bridges.text.Text Class Reference
Inheritance diagram for bridges.text.Text:
bridges.symbol.Symbol

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

Public Member Functions

def __init__ (self, label=None)
 
def get_shape_type (self)
 
def text (self)
 
def text (self, t)
 
def font_size (self)
 
def font_size (self, s)
 
def set_anchor_alignment (self, typeLR, typeTB)
 Sets the alignment parameters for the text label. More...
 
def set_anchor_location (self, x, y)
 sets the origin for the label More...
 
Tuple[float, float] anchor_location (self)
 
None anchor_location (self, Tuple[float, float] l)
 
def get_json_representation (self)
 Get the json representation of the Symbol class. More...
 
- Public Member Functions inherited from bridges.symbol.Symbol
def __init__ (self)
 Constructor for a Symbol. More...
 
str label (self)
 Getter for symbol label. More...
 
None label (self, str label)
 Setter for symbol label. More...
 
Color fill_color (self)
 Getter for the fill color. More...
 
None fill_color (self, *args, **kwargs)
 Setter for the fill color. More...
 
Color stroke_color (self)
 Getter for the stroke color. More...
 
None stroke_color (self, *args, **kwargs)
 Setter for the stroke color. More...
 
float stroke_width (self)
 Getter for the stroke width. More...
 
None stroke_width (self, float width)
 Setter for the stroke width. More...
 
float opacity (self)
 Getter for opacity. More...
 
def opacity (self, float o)
 Setter for opacity. More...
 
float stroke_dash (self)
 Getter for stroke_dash. More...
 
def stroke_dash (self, float dash)
 Setter for stroke_dash. More...
 
int layer (self)
 
def layer (self, int l)
 
def xform (self)
 
def print_mat (self, list m)
 
list identity (self, list m)
 
list mat_mult (self, list m1, list m2)
 
list vec_mat_mult (self, list m, list v)
 
def translate (self, float tx, float ty)
 
def scale (self, *args)
 scale the symbol from a particular center location More...
 
def rotate (self, *args)
 
def set_transform (self, float a, float b, float c, float d, float e, float f)
 
def add_all_json (self, symbol_json, parent)
 

Public Attributes

 stroke_width
 

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ anchor_location() [1/2]

Tuple[float, float] bridges.text.Text.anchor_location (   self)

◆ anchor_location() [2/2]

None bridges.text.Text.anchor_location (   self,
Tuple[float, float]   l 
)

◆ font_size() [1/2]

def bridges.text.Text.font_size (   self)

◆ font_size() [2/2]

def bridges.text.Text.font_size (   self,
  s 
)

◆ get_json_representation()

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

def bridges.text.Text.get_shape_type (   self)

Reimplemented from bridges.symbol.Symbol.

◆ set_anchor_alignment()

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

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

◆ text() [1/2]

def bridges.text.Text.text (   self)

◆ text() [2/2]

def bridges.text.Text.text (   self,
  t 
)

Member Data Documentation

◆ stroke_width

bridges.text.Text.stroke_width

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