Phoenix Logo

phoenix_title wx.lib.plot.utils.DisplaySide

Generic class for storing booleans describing which sides of a box are displayed. Used for fine-tuning the axis, ticks, and values of a graph.

This class somewhat mimics a collections.namedtuple factory function in that it is an iterable and can have indiviual elements accessible by name. It differs from a namedtuple in a few ways:

  • it’s mutable
  • it’s not a factory function but a full-fledged class
  • it contains type checking, only allowing boolean values
  • it contains name checking, only allowing valid_names as attributes
param bottom:Display the bottom side?
type bottom:bool
param left:Display the left side?
type left:bool
param top:Display the top side?
type top:bool
param right:Display the right side?
type right:bool

class_hierarchy Class Hierarchy

Inheritance diagram for class DisplaySide:


method_summary Methods Summary

__init__  

api Class API



class DisplaySide(object)

Generic class for storing booleans describing which sides of a box are displayed. Used for fine-tuning the axis, ticks, and values of a graph.

This class somewhat mimics a collections.namedtuple factory function in that it is an iterable and can have indiviual elements accessible by name. It differs from a namedtuple in a few ways:

  • it’s mutable
  • it’s not a factory function but a full-fledged class
  • it contains type checking, only allowing boolean values
  • it contains name checking, only allowing valid_names as attributes
Parameters:
  • bottom (bool) – Display the bottom side?
  • left (bool) – Display the left side?
  • top (bool) – Display the top side?
  • right (bool) – Display the right side?

Methods



__init__(self, bottom, left, top, right)