File tree Expand file tree Collapse file tree 1 file changed +10
-7
lines changed Expand file tree Collapse file tree 1 file changed +10
-7
lines changed Original file line number Diff line number Diff line change @@ -931,19 +931,22 @@ def set_zorder(self, level):
931
931
@property
932
932
def sticky_edges (self ):
933
933
"""
934
- The `x` and `y` sticky edge lists for the artist .
934
+ `x` and `y` sticky edge lists.
935
935
936
- When autoscaling, if a data limit coincides with a value
937
- in the corresponding sticky_edges list, then no margin
938
- will be added--the view limit "sticks" to the edge.
936
+ When performing autoscaling, if a data limit coincides with a value in
937
+ the corresponding sticky_edges list, then no margin will be added--the
938
+ view limit "sticks" to the edge. A typical usecase is histograms,
939
+ where one usually expects no margin on the bottom edge (0) of the
940
+ histogram.
939
941
940
942
This attribute cannot be assigned to; however, the `x` and `y` lists
941
943
can be modified in place as needed.
942
944
943
- Example usage::
945
+ Examples
946
+ --------
944
947
945
- artist.sticky_edges.x[:] = (xmin, xmax)
946
- artist.sticky_edges.y[:] = (ymin, ymax)
948
+ >>> artist.sticky_edges.x[:] = (xmin, xmax)
949
+ >>> artist.sticky_edges.y[:] = (ymin, ymax)
947
950
948
951
"""
949
952
return self ._sticky_edges
You can’t perform that action at this time.
0 commit comments