@@ -15,15 +15,11 @@ def directional_rose(
15
15
self ,
16
16
position : Sequence [str | float ] | AnchorCode ,
17
17
position_type : Literal [
18
- "mapcoords" ,
19
- "boxcoords" ,
20
- "plotcoords" ,
21
- "inside" ,
22
- "outside" ,
18
+ "mapcoords" , "boxcoords" , "plotcoords" , "inside" , "outside"
23
19
] = "plotcoords" ,
24
- width : float | str | None = None ,
25
20
anchor : AnchorCode | None = None ,
26
21
anchor_offset : Sequence [float | str ] | None = None ,
22
+ width : float | str | None = None ,
27
23
label : Sequence [str ] | bool = False ,
28
24
fancy : Literal [1 , 2 , 3 ] | bool = False ,
29
25
verbose : Literal ["quiet" , "error" , "warning" , "timing" , "info" , "compat" , "debug" ]
@@ -35,7 +31,8 @@ def directional_rose(
35
31
36
32
The directional rose is plotted at the location defined by the reference point
37
33
(specified by the **position** and *position_type** parameters) and anchor point
38
- (set by the **anchor** and **anchor_offset** parameters).
34
+ (specified by the **anchor** and **anchor_offset** parameters). Refer to
35
+ :doc:`/techref/reference_anchor_points` for details about the positioning.
39
36
40
37
Parameters
41
38
----------
@@ -53,21 +50,22 @@ def directional_rose(
53
50
- ``"inside"`` or ``"outside"``: **position** is the justification code, meaning
54
51
the anchor point of the rose is inside or outside the plot bounding box.
55
52
anchor
56
- The anchor point of the rose, set by a 2-character justification code.
53
+ Anchor point of the directional rose, set by a
54
+ :doc:`2-character justification code </techref/justification_codes>`.
57
55
The default value depends on the **position_type** parameter.
58
56
59
- - ``position_type="inside"``, **anchor** defaults to the same as **position**.
60
- - ``position_type="outside"``, **anchor** defaults to the mirror opposite of
57
+ - ``position_type="inside"``: **anchor** defaults to the same as **position**.
58
+ - ``position_type="outside"``: **anchor** defaults to the mirror opposite of
61
59
**position**.
62
60
- Otherwise, **anchor** defaults to ``"MC"`` (middle center).
63
61
anchor_offset
64
62
*offset* or (*offset_x*, *offset_y*).
65
63
Offset the anchor point by *offset_x* and *offset_y*. If a single value *offset*
66
64
is given, *offset_y* = *offset_x* = *offset*.
67
65
width
68
- Width of the rose in plot coordinates (append **i** (inch),
69
- **cm** (centimeters), or **p** (points)), or append % for a size in percentage
70
- of map width [Default is 10 %].
66
+ Width of the rose in plot coordinates (append **i** (inch), **cm**
67
+ (centimeters), or **p** (points)), or append % for a size in percentage of map
68
+ width [Default is 10 %].
71
69
label
72
70
A sequence of four strings to label the cardinal points W,E,S,N. Use an empty
73
71
string to skip a specific label. If set to ``True``, use the default labels
@@ -80,7 +78,7 @@ def directional_rose(
80
78
- Level 3 adds the four minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and
81
79
ENE-WSW
82
80
83
- If set to ``True``, it defaults to level 1.
81
+ If set to ``True``, defaults to level 1.
84
82
{perspective}
85
83
{verbose}
86
84
{transparency}
@@ -109,10 +107,10 @@ def directional_rose(
109
107
},
110
108
),
111
109
Alias (position , name = "position" , sep = "/" , size = 2 ),
112
- Alias (fancy , name = "fancy" , prefix = "+f" ), # +F is not supported yet.
113
110
Alias (anchor , name = "anchor" , prefix = "+j" ),
114
- Alias (label , name = "label" , prefix = "+l" , sep = "," , size = 4 ),
115
111
Alias (anchor_offset , name = "anchor_offset" , prefix = "+o" , sep = "/" , size = 2 ),
112
+ Alias (fancy , name = "fancy" , prefix = "+f" ), # +F is not supported yet.
113
+ Alias (label , name = "label" , prefix = "+l" , sep = "," , size = 4 ),
116
114
Alias (width , name = "width" , prefix = "+w" ),
117
115
],
118
116
).add_common (
0 commit comments