File: wx.lib.plot.polyobjects.PolyBars.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (145 lines) | stat: -rw-r--r-- 5,375 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.plot.polyobjects

.. highlight:: python



.. _wx.lib.plot.polyobjects.PolyBars:

==========================================================================================================================================
|phoenix_title|  **wx.lib.plot.polyobjects.PolyBars**
==========================================================================================================================================

Creates a PolyBars object.

:param points: The data to plot.
:type points: sequence of ``(center, height)`` points
:param **attr: keyword attributes

=================================  =============  =======================
Keyword and Default                Description    Type
=================================  =============  =======================
``barwidth=1.0``                   bar width      float or list of floats
``edgecolour='black'``             edge color     :class:`wx.Colour`
``edgewidth=1``                    edge width     float
``edgestyle=wx.PENSTYLE_SOLID``    edge style     :class:`wx.PenStyle`
``fillcolour='red'``               fill color     :class:`wx.Colour`
``fillstyle=wx.BRUSHSTYLE_SOLID``  fill style     :class:`wx.BrushStyle`
``legend=''``                      legend string  str
=================================  =============  =======================

.. important::

   If ``barwidth`` is a list of floats:

   + each bar will have a separate width
   + ``len(barwidth)`` must equal ``len(points)``.

.. warning::

   All methods except ``__init__`` are private.



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>PolyBars</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.plot.polyobjects.PolyBars_inheritance.png" alt="Inheritance diagram of PolyBars" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.plot.polyobjects.PolyPoints.html" title="wx.lib.plot.polyobjects.PolyPoints" alt="" coords="16,5,245,35"/> <area shape="rect" id="node2" href="wx.lib.plot.polyobjects.PolyBarsBase.html" title="wx.lib.plot.polyobjects.PolyBarsBase" alt="" coords="5,83,256,112"/> <area shape="rect" id="node3" href="wx.lib.plot.polyobjects.PolyBars.html" title="wx.lib.plot.polyobjects.PolyBars" alt="" coords="21,160,240,189"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`wx.lib.plot.polyobjects.PolyBarsBase`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.plot.polyobjects.PolyBars.__init__`                               
:meth:`~wx.lib.plot.polyobjects.PolyBars.calc_rect`                              Calculate the rectangle for plotting.
:meth:`~wx.lib.plot.polyobjects.PolyBars.draw`                                   Draw the bars
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: PolyBars(PolyBarsBase)

   Creates a PolyBars object.
   
   :param points: The data to plot.
   :type points: sequence of ``(center, height)`` points
   :param **attr: keyword attributes
   
   =================================  =============  =======================
   Keyword and Default                Description    Type
   =================================  =============  =======================
   ``barwidth=1.0``                   bar width      float or list of floats
   ``edgecolour='black'``             edge color     :class:`wx.Colour`
   ``edgewidth=1``                    edge width     float
   ``edgestyle=wx.PENSTYLE_SOLID``    edge style     :class:`wx.PenStyle`
   ``fillcolour='red'``               fill color     :class:`wx.Colour`
   ``fillstyle=wx.BRUSHSTYLE_SOLID``  fill style     :class:`wx.BrushStyle`
   ``legend=''``                      legend string  str
   =================================  =============  =======================
   
   .. important::
   
      If ``barwidth`` is a list of floats:
   
      + each bar will have a separate width
      + ``len(barwidth)`` must equal ``len(points)``.
   
   .. warning::
   
      All methods except ``__init__`` are private.

   .. method:: __init__(self, points, \*\*attr)


   .. method:: calc_rect(self, x, y, w)

      Calculate the rectangle for plotting. 


   .. method:: draw(self, dc, printerScale, coord=None)

      Draw the bars