GRASS Programmer's Manual  6.5.svn(2014)-r66266
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
base.BasePlotFrame Class Reference

Abstract PyPlot display frame class. More...

Inheritance diagram for base.BasePlotFrame:
Collaboration diagram for base.BasePlotFrame:

Public Member Functions

def __init__
 
def InitPlotOpts
 Initialize options for entire plot. More...
 
def InitRasterOpts
 Initialize or update raster dictionary for plotting. More...
 
def SetGraphStyle
 Set plot and text options. More...
 
def DrawPlot
 Draw line and point plot from list plot elements. More...
 
def DrawPointLabel
 This is the fuction that defines how the pointLabels are plotted dc - DC that will be passed mDataDict - Dictionary of data that you want to use for the pointLabel. More...
 
def OnZoom
 Enable zooming and disable dragging. More...
 
def OnDrag
 Enable dragging and disable zooming. More...
 
def OnRedraw
 Redraw the plot window. More...
 
def OnErase
 Erase the plot window. More...
 
def SaveToFile
 Save plot to graphics file. More...
 
def OnMouseLeftDown
 
def OnMotion
 Indicate when mouse is outside the plot area. More...
 
def PlotOptionsMenu
 Popup menu for plot and text options. More...
 
def NotFunctional
 Creates a 'not functional' message dialog. More...
 
def OnPlotText
 Custom text settings. More...
 
def PlotText
 Set custom text values for profile title and axis labels. More...
 
def PlotOptions
 Set various profile options, including: line width, color, style; marker size, color, fill, and style; grid and legend options. More...
 
def PrintMenu
 Print options and output menu. More...
 
def OnPageSetup
 
def OnPrintPreview
 
def OnDoPrint
 
def OnQuit
 
def OnCloseWindow
 Close plot window and clean up. More...
 

Data Fields

 parent
 
 mapwin
 
 Map
 
 rasterList
 
 raster
 
 plottype
 
 linestyledict
 
 ptfilldict
 
 statusbar
 
 client
 
 plotlist
 
 plot
 
 ptitle
 
 xlabel
 
 ylabel
 
 colorDict
 
 properties
 
 zoom
 
 drag
 

Detailed Description

Abstract PyPlot display frame class.

Definition at line 47 of file wxplot/base.py.

Constructor & Destructor Documentation

def base.BasePlotFrame.__init__ (   self,
  parent = None,
  id = wx.ID_ANY,
  size = wx.Size(700, 400,
  style = wx.DEFAULT_FRAME_STYLE,
  rasterList = [],
  kwargs 
)

Definition at line 50 of file wxplot/base.py.

Member Function Documentation

def base.BasePlotFrame.DrawPointLabel (   self,
  dc,
  mDataDict 
)

This is the fuction that defines how the pointLabels are plotted dc - DC that will be passed mDataDict - Dictionary of data that you want to use for the pointLabel.

As an example I have decided I want a box at the curve point with some text information about the curve plotted below. Any wxDC method can be used.

Definition at line 322 of file wxplot/base.py.

def base.BasePlotFrame.InitPlotOpts (   self,
  plottype 
)

Initialize options for entire plot.

Definition at line 124 of file wxplot/base.py.

References base.BasePlotFrame.plottype.

def base.BasePlotFrame.NotFunctional (   self)

Creates a 'not functional' message dialog.

Definition at line 424 of file wxplot/base.py.

def base.BasePlotFrame.OnCloseWindow (   self,
  event 
)

Close plot window and clean up.

Definition at line 507 of file wxplot/base.py.

def base.BasePlotFrame.OnDoPrint (   self,
  event 
)

Definition at line 501 of file wxplot/base.py.

Referenced by base.BasePlotFrame.PrintMenu().

def base.BasePlotFrame.OnDrag (   self,
  event 
)

Enable dragging and disable zooming.

Definition at line 352 of file wxplot/base.py.

References base.BasePlotFrame.drag, and base.BasePlotFrame.zoom.

def base.BasePlotFrame.OnErase (   self,
  event 
)

Erase the plot window.

Definition at line 366 of file wxplot/base.py.

def base.BasePlotFrame.OnMotion (   self,
  event 
)

Indicate when mouse is outside the plot area.

Definition at line 385 of file wxplot/base.py.

def base.BasePlotFrame.OnMouseLeftDown (   self,
  event 
)

Definition at line 380 of file wxplot/base.py.

def base.BasePlotFrame.OnPageSetup (   self,
  event 
)

Definition at line 495 of file wxplot/base.py.

Referenced by base.BasePlotFrame.PrintMenu().

def base.BasePlotFrame.OnPrintPreview (   self,
  event 
)

Definition at line 498 of file wxplot/base.py.

Referenced by base.BasePlotFrame.PrintMenu().

def base.BasePlotFrame.OnQuit (   self,
  event 
)

Definition at line 504 of file wxplot/base.py.

def base.BasePlotFrame.OnRedraw (   self,
  event 
)

Redraw the plot window.

Unzoom to original size

Definition at line 360 of file wxplot/base.py.

Referenced by base.BasePlotFrame.OnPlotText().

def base.BasePlotFrame.OnZoom (   self,
  event 
)

Enable zooming and disable dragging.

Definition at line 344 of file wxplot/base.py.

References base.BasePlotFrame.drag, and base.BasePlotFrame.zoom.

def base.BasePlotFrame.PlotOptions (   self,
  event 
)

Set various profile options, including: line width, color, style; marker size, color, fill, and style; grid and legend options.

Calls OptDialog class.

Definition at line 463 of file wxplot/base.py.

References base.BasePlotFrame.plottype.

Referenced by base.BasePlotFrame.PlotOptionsMenu().

def base.BasePlotFrame.PlotOptionsMenu (   self,
  event 
)

Popup menu for plot and text options.

Definition at line 404 of file wxplot/base.py.

References base.BasePlotFrame.PlotOptions(), and base.BasePlotFrame.PlotText().

def base.BasePlotFrame.PlotText (   self,
  event 
)

Set custom text values for profile title and axis labels.

Definition at line 452 of file wxplot/base.py.

References base.BasePlotFrame.plottype.

Referenced by base.BasePlotFrame.PlotOptionsMenu().

def base.BasePlotFrame.SaveToFile (   self,
  event 
)

Save plot to graphics file.

Definition at line 375 of file wxplot/base.py.

Field Documentation

base.BasePlotFrame.client

Definition at line 85 of file wxplot/base.py.

base.BasePlotFrame.colorDict

Definition at line 116 of file wxplot/base.py.

Referenced by base.BasePlotFrame.InitRasterOpts().

base.BasePlotFrame.drag
base.BasePlotFrame.linestyledict

Definition at line 61 of file wxplot/base.py.

base.BasePlotFrame.Map
base.BasePlotFrame.mapwin

Definition at line 55 of file wxplot/base.py.

base.BasePlotFrame.parent

Definition at line 54 of file wxplot/base.py.

base.BasePlotFrame.plot

Definition at line 97 of file wxplot/base.py.

Referenced by base.BasePlotFrame.DrawPlot(), and base.BasePlotFrame.OnPlotText().

base.BasePlotFrame.plotlist

Definition at line 96 of file wxplot/base.py.

base.BasePlotFrame.ptfilldict

Definition at line 67 of file wxplot/base.py.

base.BasePlotFrame.statusbar

Definition at line 78 of file wxplot/base.py.

base.BasePlotFrame.xlabel
base.BasePlotFrame.zoom

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