Changeset 8935:9bd443b27036 in orange


Ignore:
Timestamp:
09/09/11 12:55:28 (3 years ago)
Author:
matejd <matejd@…>
Branch:
default
Convert:
667370d9d240f543ae56e86f3cf57fdd54913c65
Message:

Started writing plot3d documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • orange/OrangeWidgets/plot/owplot3d.py

    r8933 r8935  
    11''' 
    2     .. class:: OWPlot3D 
    3         Base class for 3D plots. 
    4  
    5     .. attribute:: show_legend 
    6         Determines whether to display the legend or not. 
    7  
    8     .. method:: clear() 
    9         Removes everything from the graph. 
     2 
     3################# 
     4Plot3D (``owplot3D``) 
     5################# 
     6 
     7.. autoclass:: OrangeWidgets.plot.OWPlot3D 
     8     
    109''' 
    1110 
     
    145144 
    146145class OWPlot3D(orangeqt.Plot3D): 
     146    ''' 
     147    The base class behind 3D plots in Orange. Uses OpenGL as its rendering platform. 
     148 
     149    **Plot layout** 
     150 
     151        .. attribute:: show_legend 
     152     
     153            A boolean controlling whether the legend is displayed or not 
     154 
     155    **Settings** 
     156     
     157    .. attribute:: gui 
     158     
     159            An :obj:`.OWPlotGUI` object associated with this graph 
     160 
     161    **Data** 
     162        This is the most important part of the class API. :meth:`set_plot_data` is 
     163        used to (not surprisingly) set the data which will be drawn. 
     164        :meth:`set_features` tells Plot3D how to interpret the data (this method must 
     165        be called after :meth:`set_plot_data` and can be called multiple times). 
     166        :meth:`set_valid_data` optionally informs the plot which examples are invalid and 
     167        should not be drawn. It should be called after set_plot_data, but before set_features. 
     168 
     169        .. automethod:: set_plot_data 
     170 
     171        .. automethod:: set_valid_data 
     172 
     173        .. automethod:: set_features 
     174 
     175    **Selections** 
     176 
     177        .. method: get_selected_indices 
     178 
     179        .. method: get_min_max_selected 
     180 
     181        .. method: set_selection_behavior 
     182 
     183        .. method: unselect_all_points 
     184 
     185    **Callbacks** 
     186 
     187        Plot3D provides several callbacks which can be used to perform additional tasks ( 
     188        such as drawing geometry before the data is drawn). Callback provided: 
     189 
     190        auto_send_selection_callback 
     191        mouseover_callback 
     192        before_draw_callback 
     193        after_draw_callback 
     194 
     195    **Coordinate transformations** 
     196 
     197        .. automethod:: map_to_plot 
     198 
     199        .. automethod:: map_to_data 
     200 
     201    **Colors** 
     202 
     203        Colors are specified with two palettes, one for continuous attributes, and one for 
     204        discrete ones.  Both are created by 
     205        :obj:`.OWColorPalette.ColorPaletteGenerator` 
     206         
     207        .. attribute:: continuous_palette 
     208         
     209            The palette used when point color represents a continuous attribute 
     210         
     211        .. attribute:: discrete_palette 
     212         
     213            The palette used when point color represents a discrete attribute 
     214 
     215    ''' 
    147216    def __init__(self, parent=None): 
    148217        orangeqt.Plot3D.__init__(self, parent) 
Note: See TracChangeset for help on using the changeset viewer.