|
63 | 63 |
|
64 | 64 | Keyword arguments: |
65 | 65 |
|
66 | | - *units*: [ 'width' | 'height' | 'dots' | 'inches' | 'x' | 'y' | 'xy'] |
67 | | - arrow units; the arrow dimensions *except for length* are in |
| 66 | + *units*: [ 'width' | 'height' | 'dots' | 'inches' | 'x' | 'y' | 'xy' ] |
| 67 | + Arrow units; the arrow dimensions *except for length* are in |
68 | 68 | multiples of this unit. |
69 | 69 |
|
70 | 70 | * 'width' or 'height': the width or height of the axes |
|
81 | 81 | for 'dots' or 'inches', resizing does not change the arrows. |
82 | 82 |
|
83 | 83 |
|
84 | | - *angles*: [ 'uv' | 'xy' | array] |
| 84 | + *angles*: [ 'uv' | 'xy' | array ] |
85 | 85 | With the default 'uv', the arrow aspect ratio is 1, so that |
86 | 86 | if *U*==*V* the angle of the arrow on the plot is 45 degrees |
87 | 87 | CCW from the *x*-axis. |
|
90 | 90 | of values in degrees, CCW from the *x*-axis. |
91 | 91 |
|
92 | 92 | *scale*: [ *None* | float ] |
93 | | - data units per arrow length unit, e.g. m/s per plot width; a smaller |
| 93 | + Data units per arrow length unit, e.g. m/s per plot width; a smaller |
94 | 94 | scale parameter makes the arrow longer. If *None*, a simple |
95 | 95 | autoscaling algorithm is used, based on the average vector length |
96 | 96 | and the number of vectors. The arrow length unit is given by |
97 | 97 | the *scale_units* parameter |
98 | 98 |
|
99 | | - *scale_units*: *None*, or any of the *units* options. |
| 99 | + *scale_units*: *None*, or any of the *units* options. |
100 | 100 | For example, if *scale_units* is 'inches', *scale* is 2.0, and |
101 | 101 | ``(u,v) = (1,0)``, then the vector will be 0.5 inches long. |
102 | 102 | If *scale_units* is 'width', then the vector will be half the width |
|
108 | 108 | "angles='xy', scale_units='xy', scale=1". |
109 | 109 |
|
110 | 110 | *width*: |
111 | | - shaft width in arrow units; default depends on choice of units, |
| 111 | + Shaft width in arrow units; default depends on choice of units, |
112 | 112 | above, and number of vectors; a typical starting value is about |
113 | 113 | 0.005 times the width of the plot. |
114 | 114 |
|
115 | 115 | *headwidth*: scalar |
116 | | - head width as multiple of shaft width, default is 3 |
| 116 | + Head width as multiple of shaft width, default is 3 |
117 | 117 |
|
118 | 118 | *headlength*: scalar |
119 | | - head length as multiple of shaft width, default is 5 |
| 119 | + Head length as multiple of shaft width, default is 5 |
120 | 120 |
|
121 | 121 | *headaxislength*: scalar |
122 | | - head length at shaft intersection, default is 4.5 |
| 122 | + Head length at shaft intersection, default is 4.5 |
123 | 123 |
|
124 | 124 | *minshaft*: scalar |
125 | | - length below which arrow scales, in units of head length. Do not |
| 125 | + Length below which arrow scales, in units of head length. Do not |
126 | 126 | set this to less than 1, or small arrows will look terrible! |
127 | 127 | Default is 1 |
128 | 128 |
|
129 | 129 | *minlength*: scalar |
130 | | - minimum length as a multiple of shaft width; if an arrow length |
| 130 | + Minimum length as a multiple of shaft width; if an arrow length |
131 | 131 | is less than this, plot a dot (hexagon) of this diameter instead. |
132 | 132 | Default is 1. |
133 | 133 |
|
|
173 | 173 | The length of the key |
174 | 174 |
|
175 | 175 | *label*: |
176 | | - a string with the length and units of the key |
| 176 | + A string with the length and units of the key |
177 | 177 |
|
178 | 178 | Keyword arguments: |
179 | 179 |
|
|
217 | 217 |
|
218 | 218 |
|
219 | 219 | class QuiverKey(martist.Artist): |
220 | | - """ Labelled arrow for use as a quiver plot scale key. |
221 | | - """ |
| 220 | + """ Labelled arrow for use as a quiver plot scale key.""" |
222 | 221 | halign = {'N': 'center', 'S': 'center', 'E': 'left', 'W': 'right'} |
223 | 222 | valign = {'N': 'bottom', 'S': 'top', 'E': 'center', 'W': 'center'} |
224 | 223 | pivot = {'N': 'mid', 'S': 'mid', 'E': 'tip', 'W': 'tail'} |
|
0 commit comments