App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | Properties | List of all members
google.appengine._internal.graphy.common.BaseChart Class Reference
Inheritance diagram for google.appengine._internal.graphy.common.BaseChart:
google.appengine._internal.graphy.bar_chart.BarChart google.appengine._internal.graphy.line_chart.LineChart google.appengine._internal.graphy.pie_chart.PieChart google.appengine._internal.graphy.line_chart.Sparkline

Public Member Functions

def __init__
 
def AddFormatter
 
def AddSeries
 
def GetDependentAxes
 
def GetIndependentAxes
 
def GetDependentAxis
 
def GetIndependentAxis
 
def GetFormattedChart
 
def GetMinMaxValues
 
def AddAxis
 
def GetAxis
 
def SetAxis
 

Public Attributes

 data
 
 auto_color
 
 auto_scale
 
 auto_legend
 
 formatters
 
 display
 

Properties

 bottom
 
 left
 
 right
 
 top
 

Detailed Description

Base chart object with standard behavior for all other charts.

Object attributes:
  data: List of DataSeries objects. Chart subtypes provide convenience
        functions (like AddLine, AddBars, AddSegment) to add more series
        later.
  left/right/bottom/top: Axis objects for the 4 different axes.
  formatters: A list of callables which will be used to format this chart for
              display.  TODO: Need better documentation for how these
              work.
  auto_scale, auto_color, auto_legend:
    These aliases let users access the default formatters without poking
    around in self.formatters.  If the user removes them from
    self.formatters then they will no longer be enabled, even though they'll
    still be accessible through the aliases.  Similarly, re-assigning the
    aliases has no effect on the contents of self.formatters.
  display: This variable is reserved for backends to populate with a display
           object.  The intention is that the display object would be used to
           render this chart.  The details of what gets put here depends on
           the specific backend you are using.

Constructor & Destructor Documentation

def google.appengine._internal.graphy.common.BaseChart.__init__ (   self)
Construct a BaseChart object.

Member Function Documentation

def google.appengine._internal.graphy.common.BaseChart.AddAxis (   self,
  position,
  axis 
)
Add an axis to this chart in the given position.

Args:
  position: an AxisPosition object specifying the axis's position
  axis: The axis to add, an Axis object
Returns:
  the value of the axis parameter
def google.appengine._internal.graphy.common.BaseChart.AddFormatter (   self,
  formatter 
)
Add a new formatter to the chart (convenience method).
def google.appengine._internal.graphy.common.BaseChart.AddSeries (   self,
  points,
  color = None,
  style = None,
  markers = None,
  label = None 
)
DEPRECATED

Add a new series of data to the chart; return the DataSeries object.
def google.appengine._internal.graphy.common.BaseChart.GetAxis (   self,
  position 
)
Get or create the first available axis in the given position.

This is a helper method for the left, right, top, and bottom properties.
If the specified axis does not exist, it will be created.

Args:
  position: the position to search for
Returns:
  The first axis in the given position
def google.appengine._internal.graphy.common.BaseChart.GetDependentAxes (   self)
Return any dependent axes ('left' and 'right' by default for LineCharts,
although bar charts would use 'bottom' and 'top').
def google.appengine._internal.graphy.common.BaseChart.GetDependentAxis (   self)
Return this chart's main dependent axis (often 'left', but
horizontal bar-charts use 'bottom').
def google.appengine._internal.graphy.common.BaseChart.GetFormattedChart (   self)
Get a copy of the chart with formatting applied.
def google.appengine._internal.graphy.common.BaseChart.GetIndependentAxes (   self)
Return any independent axes (normally top & bottom, although horizontal
bar charts use left & right by default).
def google.appengine._internal.graphy.common.BaseChart.GetIndependentAxis (   self)
Return this chart's main independent axis (often 'bottom', but
horizontal bar-charts use 'left').
def google.appengine._internal.graphy.common.BaseChart.GetMinMaxValues (   self)
Get the largest & smallest values in this chart, returned as
(min_value, max_value).  Takes into account complciations like stacked data
series.

For example, with non-stacked series, a chart with [1, 2, 3] and [4, 5, 6]
would return (1, 6).  If the same chart was stacking the data series, it
would return (5, 9).
def google.appengine._internal.graphy.common.BaseChart.SetAxis (   self,
  position,
  axis 
)
Set the first axis in the given position to the given value.

This is a helper method for the left, right, top, and bottom properties.

Args:
  position: an AxisPosition object specifying the axis's position
  axis: The axis to set, an Axis object
Returns:
  the value of the axis parameter

Property Documentation

google.appengine._internal.graphy.common.BaseChart.bottom
static
Initial value:
1 = property(_GetBottom, _SetBottom,
2  doc="""Get or set the bottom axis""")
google.appengine._internal.graphy.common.BaseChart.left
static
Initial value:
1 = property(_GetLeft, _SetLeft,
2  doc="""Get or set the left axis""")
google.appengine._internal.graphy.common.BaseChart.right
static
Initial value:
1 = property(_GetRight, _SetRight,
2  doc="""Get or set the right axis""")
google.appengine._internal.graphy.common.BaseChart.top
static
Initial value:
1 = property(_GetTop, _SetTop,
2  doc="""Get or set the top axis""")

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