`ArrowStyle` is a container class which defines several arrowstyle classes, which is used to create an arrow path along a given path. These are mainly used with `FancyArrowPatch`. An arrowstyle object can be either created as:: ArrowStyle.Fancy(head_length=.4, head_wid
| 3312 | |
| 3313 | @_docstring.interpd |
| 3314 | class ArrowStyle(_Style): |
| 3315 | """ |
| 3316 | `ArrowStyle` is a container class which defines several |
| 3317 | arrowstyle classes, which is used to create an arrow path along a |
| 3318 | given path. These are mainly used with `FancyArrowPatch`. |
| 3319 | |
| 3320 | An arrowstyle object can be either created as:: |
| 3321 | |
| 3322 | ArrowStyle.Fancy(head_length=.4, head_width=.4, tail_width=.4) |
| 3323 | |
| 3324 | or:: |
| 3325 | |
| 3326 | ArrowStyle("Fancy", head_length=.4, head_width=.4, tail_width=.4) |
| 3327 | |
| 3328 | or:: |
| 3329 | |
| 3330 | ArrowStyle("Fancy, head_length=.4, head_width=.4, tail_width=.4") |
| 3331 | |
| 3332 | The following classes are defined |
| 3333 | |
| 3334 | %(ArrowStyle:table)s |
| 3335 | |
| 3336 | For an overview of the visual appearance, see |
| 3337 | :doc:`/gallery/text_labels_and_annotations/fancyarrow_demo`. |
| 3338 | |
| 3339 | An instance of any arrow style class is a callable object, |
| 3340 | whose call signature is:: |
| 3341 | |
| 3342 | __call__(self, path, mutation_size, linewidth, aspect_ratio=1.) |
| 3343 | |
| 3344 | and it returns a tuple of a `.Path` instance and a boolean |
| 3345 | value. *path* is a `.Path` instance along which the arrow |
| 3346 | will be drawn. *mutation_size* and *aspect_ratio* have the same |
| 3347 | meaning as in `BoxStyle`. *linewidth* is a line width to be |
| 3348 | stroked. This is meant to be used to correct the location of the |
| 3349 | head so that it does not overshoot the destination point, but not all |
| 3350 | classes support it. |
| 3351 | |
| 3352 | Notes |
| 3353 | ----- |
| 3354 | *angleA* and *angleB* specify the orientation of the bracket, as either a |
| 3355 | clockwise or counterclockwise angle depending on the arrow type. 0 degrees |
| 3356 | means perpendicular to the line connecting the arrow's head and tail. |
| 3357 | |
| 3358 | .. plot:: gallery/text_labels_and_annotations/angles_on_bracket_arrows.py |
| 3359 | """ |
| 3360 | |
| 3361 | _style_list = {} |
| 3362 | |
| 3363 | class _Base: |
| 3364 | """ |
| 3365 | Arrow Transmuter Base class |
| 3366 | |
| 3367 | ArrowTransmuterBase and its derivatives are used to make a fancy |
| 3368 | arrow around a given path. The __call__ method returns a path |
| 3369 | (which will be used to create a PathPatch instance) and a boolean |
| 3370 | value indicating the path is open therefore is not fillable. This |
| 3371 | class is not an artist and actual drawing of the fancy arrow is |
no outgoing calls
no test coverage detected
searching dependent graphs…