doc_content
stringlengths
1
386k
doc_id
stringlengths
5
188
transmute(path, mutation_size, linewidth)[source] The transmute method is the very core of the ArrowStyle class and must be overridden in the subclasses. It receives the path object along which the arrow will be drawn, and the mutation_size, with which the arrow head etc. will be scaled. The linewidth may be used to ...
matplotlib._as_gen.matplotlib.patches.arrowstyle#matplotlib.patches.ArrowStyle.Wedge.transmute
matplotlib.patches.bbox_artist matplotlib.patches.bbox_artist(artist, renderer, props=None, fill=True)[source] A debug function to draw a rectangle around the bounding box returned by an artist's Artist.get_window_extent to test whether the artist is returning the correct bbox. props is a dict of rectangle props wi...
matplotlib._as_gen.matplotlib.patches.bbox_artist
matplotlib.patches.BoxStyle classmatplotlib.patches.BoxStyle(stylename, **kw)[source] Bases: matplotlib.patches._Style BoxStyle is a container class which defines several boxstyle classes, which are used for FancyBboxPatch. A style object can be created as: BoxStyle.Round(pad=0.2) or: BoxStyle("Round", pad=0.2) o...
matplotlib._as_gen.matplotlib.patches.boxstyle
classCircle(pad=0.3)[source] Bases: matplotlib.patches.BoxStyle._Base A circular box. Parameters padfloat, default: 0.3 The amount of padding around the original box. __call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, re...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Circle
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Circle.__call__
classDArrow(pad=0.3)[source] Bases: matplotlib.patches.BoxStyle._Base A box in the shape of a two-way arrow. Parameters padfloat, default: 0.3 The amount of padding around the original box. __call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.DArrow
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.DArrow.__call__
classLArrow(pad=0.3)[source] Bases: matplotlib.patches.BoxStyle._Base A box in the shape of a left-pointing arrow. Parameters padfloat, default: 0.3 The amount of padding around the original box. __call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the loc...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.LArrow
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.LArrow.__call__
classRArrow(pad=0.3)[source] Bases: matplotlib.patches.BoxStyle.LArrow A box in the shape of a right-pointing arrow. Parameters padfloat, default: 0.3 The amount of padding around the original box. __call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the l...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.RArrow
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.RArrow.__call__
classRound(pad=0.3, rounding_size=None)[source] Bases: matplotlib.patches.BoxStyle._Base A box with round corners. Parameters padfloat, default: 0.3 The amount of padding around the original box. rounding_sizefloat, default: pad Radius of the corners. __call__(x0, y0, width, height, mutation_size, mut...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Round
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Round.__call__
classRound4(pad=0.3, rounding_size=None)[source] Bases: matplotlib.patches.BoxStyle._Base A box with rounded edges. Parameters padfloat, default: 0.3 The amount of padding around the original box. rounding_sizefloat, default: pad/2 Rounding of edges. __call__(x0, y0, width, height, mutation_size, muta...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Round4
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Round4.__call__
classRoundtooth(pad=0.3, tooth_size=None)[source] Bases: matplotlib.patches.BoxStyle.Sawtooth A box with a rounded sawtooth outline. Parameters padfloat, default: 0.3 The amount of padding around the original box. tooth_sizefloat, default: pad/2 Size of the sawtooth. __call__(x0, y0, width, height, mu...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Roundtooth
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Roundtooth.__call__
classSawtooth(pad=0.3, tooth_size=None)[source] Bases: matplotlib.patches.BoxStyle._Base A box with a sawtooth outline. Parameters padfloat, default: 0.3 The amount of padding around the original box. tooth_sizefloat, default: pad/2 Size of the sawtooth. __call__(x0, y0, width, height, mutation_size, ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Sawtooth
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Sawtooth.__call__
classSquare(pad=0.3)[source] Bases: matplotlib.patches.BoxStyle._Base A square box. Parameters padfloat, default: 0.3 The amount of padding around the original box. __call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, retu...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Square
__call__(x0, y0, width, height, mutation_size, mutation_aspect=<deprecated parameter>)[source] Given the location and size of the box, return the path of the box around it. Parameters x0, y0, width, heightfloat Location and size of the box. mutation_sizefloat A reference scale for the mutation. Returns ...
matplotlib._as_gen.matplotlib.patches.boxstyle#matplotlib.patches.BoxStyle.Square.__call__
matplotlib.patches.Circle classmatplotlib.patches.Circle(xy, radius=5, **kwargs)[source] Bases: matplotlib.patches.Ellipse A circle patch. Create a true circle at center xy = (x, y) with given radius. Unlike CirclePolygon which is a polygonal approximation, this uses Bezier splines and is much closer to a scale-fre...
matplotlib._as_gen.matplotlib.patches.circle
get_radius()[source] Return the radius of the circle.
matplotlib._as_gen.matplotlib.patches.circle#matplotlib.patches.Circle.get_radius
set(*, agg_filter=<UNSET>, alpha=<UNSET>, angle=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, center=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, height=<UNSET>, in_layout=<UNSET>, joinst...
matplotlib._as_gen.matplotlib.patches.circle#matplotlib.patches.Circle.set
set_radius(radius)[source] Set the radius of the circle. Parameters radiusfloat
matplotlib._as_gen.matplotlib.patches.circle#matplotlib.patches.Circle.set_radius
matplotlib.patches.CirclePolygon classmatplotlib.patches.CirclePolygon(xy, radius=5, resolution=20, **kwargs)[source] Bases: matplotlib.patches.RegularPolygon A polygon-approximation of a circle patch. Create a circle at xy = (x, y) with given radius. This circle is approximated by a regular polygon with resolution...
matplotlib._as_gen.matplotlib.patches.circlepolygon
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, ...
matplotlib._as_gen.matplotlib.patches.circlepolygon#matplotlib.patches.CirclePolygon.set
matplotlib.patches.ConnectionPatch classmatplotlib.patches.ConnectionPatch(xyA, xyB, coordsA, coordsB=None, axesA=None, axesB=None, arrowstyle='-', connectionstyle='arc3', patchA=None, patchB=None, shrinkA=0.0, shrinkB=0.0, mutation_scale=10.0, mutation_aspect=None, clip_on=False, dpi_cor=<deprecated parameter>, **kw...
matplotlib._as_gen.matplotlib.patches.connectionpatch
draw(renderer)[source] Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters rendererRendererBase subclass. Notes This method is overridden in the Artist subclasses.
matplotlib._as_gen.matplotlib.patches.connectionpatch#matplotlib.patches.ConnectionPatch.draw
get_annotation_clip()[source] Return the clipping behavior. See set_annotation_clip for the meaning of the return value.
matplotlib._as_gen.matplotlib.patches.connectionpatch#matplotlib.patches.ConnectionPatch.get_annotation_clip
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, annotation_clip=<UNSET>, antialiased=<UNSET>, arrowstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, connectionstyle=<UNSET>, dpi_cor=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, ...
matplotlib._as_gen.matplotlib.patches.connectionpatch#matplotlib.patches.ConnectionPatch.set
set_annotation_clip(b)[source] Set the clipping behavior. Parameters bbool or None False: The annotation will always be drawn regardless of its position. True: The annotation will only be drawn if self.xy is inside the axes. None: The annotation will only be drawn if self.xy is inside the axes and self.xyco...
matplotlib._as_gen.matplotlib.patches.connectionpatch#matplotlib.patches.ConnectionPatch.set_annotation_clip
matplotlib.patches.ConnectionStyle classmatplotlib.patches.ConnectionStyle(stylename, **kw)[source] Bases: matplotlib.patches._Style ConnectionStyle is a container class which defines several connectionstyle classes, which is used to create a path between two points. These are mainly used with FancyArrowPatch. A co...
matplotlib._as_gen.matplotlib.patches.connectionstyle
classAngle(angleA=90, angleB=0, rad=0.0)[source] Bases: matplotlib.patches.ConnectionStyle._Base Creates a piecewise continuous quadratic Bezier path between two points. The path has a one passing-through point placed at the intersecting point of two lines which cross the start and end point, and have a slope of angl...
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Angle
connect(posA, posB)[source]
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Angle.connect
classAngle3(angleA=90, angleB=0)[source] Bases: matplotlib.patches.ConnectionStyle._Base Creates a simple quadratic Bezier curve between two points. The middle control points is placed at the intersecting point of two lines which cross the start and end point, and have a slope of angleA and angleB, respectively. ang...
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Angle3
connect(posA, posB)[source]
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Angle3.connect
classArc(angleA=0, angleB=0, armA=None, armB=None, rad=0.0)[source] Bases: matplotlib.patches.ConnectionStyle._Base Creates a piecewise continuous quadratic Bezier path between two points. The path can have two passing-through points, a point placed at the distance of armA and angle of angleA from point A, another po...
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Arc
connect(posA, posB)[source]
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Arc.connect
classArc3(rad=0.0)[source] Bases: matplotlib.patches.ConnectionStyle._Base Creates a simple quadratic Bezier curve between two points. The curve is created so that the middle control point (C1) is located at the same distance from the start (C0) and end points(C2) and the distance of the C1 to the line connecting C0-...
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Arc3
connect(posA, posB)[source]
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Arc3.connect
classBar(armA=0.0, armB=0.0, fraction=0.3, angle=None)[source] Bases: matplotlib.patches.ConnectionStyle._Base A line with angle between A and B with armA and armB. One of the arms is extended so that they are connected in a right angle. The length of armA is determined by (armA + fraction x AB distance). Same for ar...
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Bar
connect(posA, posB)[source]
matplotlib._as_gen.matplotlib.patches.connectionstyle#matplotlib.patches.ConnectionStyle.Bar.connect
matplotlib.patches.draw_bbox matplotlib.patches.draw_bbox(bbox, renderer, color='k', trans=None)[source] A debug function to draw a rectangle around the bounding box returned by an artist's Artist.get_window_extent to test whether the artist is returning the correct bbox.
matplotlib._as_gen.matplotlib.patches.draw_bbox
matplotlib.patches.Ellipse classmatplotlib.patches.Ellipse(xy, width, height, angle=0, **kwargs)[source] Bases: matplotlib.patches.Patch A scale-free ellipse. Parameters xy(float, float) xy coordinates of ellipse centre. widthfloat Total length (diameter) of horizontal axis. heightfloat Total length (...
matplotlib._as_gen.matplotlib.patches.ellipse
get_angle()[source] Return the angle of the ellipse.
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.get_angle
get_center()[source] Return the center of the ellipse.
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.get_center
get_height()[source] Return the height of the ellipse.
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.get_height
get_patch_transform()[source] Return the Transform instance mapping patch coordinates to data coordinates. For example, one may define a patch of a circle which represents a radius of 5 by providing coordinates for a unit circle, and a transform which scales the coordinates (the patch coordinate) by 5.
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.get_patch_transform
get_path()[source] Return the path of the ellipse.
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.get_path
get_width()[source] Return the width of the ellipse.
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.get_width
set(*, agg_filter=<UNSET>, alpha=<UNSET>, angle=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, center=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, height=<UNSET>, in_layout=<UNSET>, joinst...
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.set
set_angle(angle)[source] Set the angle of the ellipse. Parameters anglefloat
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.set_angle
set_center(xy)[source] Set the center of the ellipse. Parameters xy(float, float)
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.set_center
set_height(height)[source] Set the height of the ellipse. Parameters heightfloat
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.set_height
set_width(width)[source] Set the width of the ellipse. Parameters widthfloat
matplotlib._as_gen.matplotlib.patches.ellipse#matplotlib.patches.Ellipse.set_width
matplotlib.patches.FancyArrow classmatplotlib.patches.FancyArrow(x, y, dx, dy, width=0.001, length_includes_head=False, head_width=None, head_length=None, shape='full', overhang=0, head_starts_at_zero=False, **kwargs)[source] Bases: matplotlib.patches.Polygon Like Arrow, but lets you set head width and head height ...
matplotlib._as_gen.matplotlib.patches.fancyarrow
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, closed=<UNSET>, color=<UNSET>, data=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, labe...
matplotlib._as_gen.matplotlib.patches.fancyarrow#matplotlib.patches.FancyArrow.set
set_data(*, x=None, y=None, dx=None, dy=None, width=None, head_width=None, head_length=None)[source] Set FancyArrow x, y, dx, dy, width, head_with, and head_length. Values left as None will not be updated. Parameters x, yfloat or None, default: None The x and y coordinates of the arrow base. dx, dyfloat or No...
matplotlib._as_gen.matplotlib.patches.fancyarrow#matplotlib.patches.FancyArrow.set_data
matplotlib.patches.FancyArrowPatch classmatplotlib.patches.FancyArrowPatch(posA=None, posB=None, path=None, arrowstyle='simple', connectionstyle='arc3', patchA=None, patchB=None, shrinkA=2, shrinkB=2, mutation_scale=1, mutation_aspect=1, dpi_cor=<deprecated parameter>, **kwargs)[source] Bases: matplotlib.patches.Pa...
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch
draw(renderer)[source] Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters rendererRendererBase subclass. Notes This method is overridden in the Artist subclasses.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.draw
get_arrowstyle()[source] Return the arrowstyle object.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.get_arrowstyle
get_connectionstyle()[source] Return the ConnectionStyle used.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.get_connectionstyle
get_dpi_cor()[source] [Deprecated] dpi_cor is currently used for linewidth-related things and shrink factor. Mutation scale is affected by this. Returns scalar Notes Deprecated since version 3.4.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.get_dpi_cor
get_mutation_aspect()[source] Return the aspect ratio of the bbox mutation.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.get_mutation_aspect
get_mutation_scale()[source] Return the mutation scale. Returns scalar
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.get_mutation_scale
get_path()[source] Return the path of the arrow in the data coordinates.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.get_path
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, arrowstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, connectionstyle=<UNSET>, dpi_cor=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=...
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set
set_arrowstyle(arrowstyle=None, **kw)[source] Set the arrow style. Old attributes are forgotten. Without arguments (or with arrowstyle=None) returns available box styles as a list of strings. Parameters arrowstyleNone or ArrowStyle or str, default: None Can be a string with arrowstyle name with optional comma-s...
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_arrowstyle
set_connectionstyle(connectionstyle, **kw)[source] Set the connection style. Old attributes are forgotten. Parameters connectionstylestr or ConnectionStyle or None, optional Can be a string with connectionstyle name with optional comma-separated attributes, e.g.: set_connectionstyle("arc,angleA=0,armA=30,rad=10...
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_connectionstyle
set_dpi_cor(dpi_cor)[source] [Deprecated] dpi_cor is currently used for linewidth-related things and shrink factor. Mutation scale is affected by this. Parameters dpi_corfloat Notes Deprecated since version 3.4.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_dpi_cor
set_mutation_aspect(aspect)[source] Set the aspect ratio of the bbox mutation. Parameters aspectfloat
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_mutation_aspect
set_mutation_scale(scale)[source] Set the mutation scale. Parameters scalefloat
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_mutation_scale
set_patchA(patchA)[source] Set the tail patch. Parameters patchApatches.Patch
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_patchA
set_patchB(patchB)[source] Set the head patch. Parameters patchBpatches.Patch
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_patchB
set_positions(posA, posB)[source] Set the begin and end positions of the connecting path. Parameters posA, posBNone, tuple (x, y) coordinates of arrow tail and arrow head respectively. If None use current value.
matplotlib._as_gen.matplotlib.patches.fancyarrowpatch#matplotlib.patches.FancyArrowPatch.set_positions
matplotlib.patches.FancyBboxPatch classmatplotlib.patches.FancyBboxPatch(xy, width, height, boxstyle='round', bbox_transmuter=<deprecated parameter>, mutation_scale=1, mutation_aspect=1, **kwargs)[source] Bases: matplotlib.patches.Patch A fancy box around a rectangle with lower left at xy = (x, y) with specified wi...
matplotlib._as_gen.matplotlib.patches.fancybboxpatch
get_bbox()[source] Return the Bbox.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_bbox
get_boxstyle()[source] Return the boxstyle object.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_boxstyle
get_height()[source] Return the height of the rectangle.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_height
get_mutation_aspect()[source] Return the aspect ratio of the bbox mutation.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_mutation_aspect
get_mutation_scale()[source] Return the mutation scale.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_mutation_scale
get_path()[source] Return the mutated path of the rectangle.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_path
get_width()[source] Return the width of the rectangle.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_width
get_x()[source] Return the left coord of the rectangle.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_x
get_y()[source] Return the bottom coord of the rectangle.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.get_y
set(*, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, bounds=<UNSET>, boxstyle=<UNSET>, capstyle=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, fill=<UNSET>, gid=<UNSET>, hatch=<UNSET>, height=<UNSET>, in_layout=<UNSET>, joi...
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set
set_bounds(*args)[source] Set the bounds of the rectangle. Call signatures: set_bounds(left, bottom, width, height) set_bounds((left, bottom, width, height)) Parameters left, bottomfloat The coordinates of the bottom left corner of the rectangle. width, heightfloat The width/height of the rectangle.
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_bounds
set_boxstyle(boxstyle=None, **kwargs)[source] Set the box style. Most box styles can be further configured using attributes. Attributes from the previous box style are not reused. Without argument (or with boxstyle=None), the available box styles are returned as a human-readable string. Parameters boxstylestr or ...
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_boxstyle
set_height(h)[source] Set the rectangle height. Parameters hfloat
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_height
set_mutation_aspect(aspect)[source] Set the aspect ratio of the bbox mutation. Parameters aspectfloat
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_mutation_aspect
set_mutation_scale(scale)[source] Set the mutation scale. Parameters scalefloat
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_mutation_scale
set_width(w)[source] Set the rectangle width. Parameters wfloat
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_width
set_x(x)[source] Set the left coord of the rectangle. Parameters xfloat
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_x
set_y(y)[source] Set the bottom coord of the rectangle. Parameters yfloat
matplotlib._as_gen.matplotlib.patches.fancybboxpatch#matplotlib.patches.FancyBboxPatch.set_y
matplotlib.patches.Patch classmatplotlib.patches.Patch(edgecolor=None, facecolor=None, color=None, linewidth=None, linestyle=None, antialiased=None, hatch=None, fill=True, capstyle=None, joinstyle=None, **kwargs)[source] Bases: matplotlib.artist.Artist A patch is a 2D artist with a face color and an edge color. If ...
matplotlib._as_gen.matplotlib.patches.patch
contains(mouseevent, radius=None)[source] Test whether the mouse event occurred in the patch. Returns (bool, empty dict)
matplotlib._as_gen.matplotlib.patches.patch#matplotlib.patches.Patch.contains
contains_point(point, radius=None)[source] Return whether the given point is inside the patch. Parameters point(float, float) The point (x, y) to check, in target coordinates of self.get_transform(). These are display coordinates for patches that are added to a figure or axes. radiusfloat, optional Add an a...
matplotlib._as_gen.matplotlib.patches.patch#matplotlib.patches.Patch.contains_point
contains_points(points, radius=None)[source] Return whether the given points are inside the patch. Parameters points(N, 2) array The points to check, in target coordinates of self.get_transform(). These are display coordinates for patches that are added to a figure or axes. Columns contain x and y values. rad...
matplotlib._as_gen.matplotlib.patches.patch#matplotlib.patches.Patch.contains_points
draw(renderer)[source] Draw the Artist (and its children) using the given renderer. This has no effect if the artist is not visible (Artist.get_visible returns False). Parameters rendererRendererBase subclass. Notes This method is overridden in the Artist subclasses.
matplotlib._as_gen.matplotlib.patches.patch#matplotlib.patches.Patch.draw