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

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (159 lines) | stat: -rw-r--r-- 6,156 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
.. wxPython Phoenix documentation

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

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

.. include:: headings.inc

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

.. highlight:: python



.. _wx.lib.plot.polyobjects.PolyMarker:

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

Creates a PolyMarker object.

:param points: The marker coordinates.
:type points: list of ``[x, y]`` values
:param **attr: keyword attributes

=================================  =============  ====================
Keyword and Default                Description    Type
=================================  =============  ====================
``marker='circle'``                see below      str
``size=2``                         Marker size    float
``colour='black'``                 Outline color  :class:`wx.Colour`
``width=1``                        Outline width  float
``style=wx.PENSTYLE_SOLID``        Outline style  :class:`wx.PenStyle`
``fillcolour=colour``              fill color     :class:`wx.Colour`
``fillstyle=wx.BRUSHSTYLE_SOLID``  fill style     :class:`wx.BrushStyle`
``legend=''``                      Legend string  str
=================================  =============  ====================

===================  ==================================
Marker               Description
===================  ==================================
``'circle'``         A circle of diameter ``size``
``'dot'``            A dot. Does not have a size.
``'square'``         A square with side length ``size``
``'triangle'``       An upward-pointed triangle
``'triangle_down'``  A downward-pointed triangle
``'cross'``          An "X" shape
``'plus'``           A "+" shape
===================  ==================================

.. 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>PolyMarker</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.PolyMarker_inheritance.png" alt="Inheritance diagram of PolyMarker" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.plot.polyobjects.PolyMarker.html" title="wx.lib.plot.polyobjects.PolyMarker" alt="" coords="5,83,252,112"/> <area shape="rect" id="node2" href="wx.lib.plot.polyobjects.PolyPoints.html" title="wx.lib.plot.polyobjects.PolyPoints" alt="" coords="8,5,249,35"/> </map> 
   </p>
   </div>

|


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

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

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.plot.polyobjects.PolyMarker.__init__`                             Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.plot.polyobjects.PolyMarker.draw`                                 Draw the points
:meth:`~wx.lib.plot.polyobjects.PolyMarker.getSymExtent`                         Width and Height of Marker
================================================================================ ================================================================================


|


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


.. class:: PolyMarker(PolyPoints)

   Creates a PolyMarker object.
   
   :param points: The marker coordinates.
   :type points: list of ``[x, y]`` values
   :param **attr: keyword attributes
   
   =================================  =============  ====================
   Keyword and Default                Description    Type
   =================================  =============  ====================
   ``marker='circle'``                see below      str
   ``size=2``                         Marker size    float
   ``colour='black'``                 Outline color  :class:`wx.Colour`
   ``width=1``                        Outline width  float
   ``style=wx.PENSTYLE_SOLID``        Outline style  :class:`wx.PenStyle`
   ``fillcolour=colour``              fill color     :class:`wx.Colour`
   ``fillstyle=wx.BRUSHSTYLE_SOLID``  fill style     :class:`wx.BrushStyle`
   ``legend=''``                      Legend string  str
   =================================  =============  ====================
   
   ===================  ==================================
   Marker               Description
   ===================  ==================================
   ``'circle'``         A circle of diameter ``size``
   ``'dot'``            A dot. Does not have a size.
   ``'square'``         A square with side length ``size``
   ``'triangle'``       An upward-pointed triangle
   ``'triangle_down'``  A downward-pointed triangle
   ``'cross'``          An "X" shape
   ``'plus'``           A "+" shape
   ===================  ==================================
   
   .. warning::
   
      All methods except ``__init__`` are private.

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

      Initialize self.  See help(type(self)) for accurate signature.


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

      Draw the points 


   .. method:: getSymExtent(self, printerScale)

      Width and Height of Marker