python-igraph API reference

List of all classes, functions and methods in python-igraph

igraph.drawing.utils.BoundingBox

class documentation

class BoundingBox(Rectangle):

View In Hierarchy

Class representing a bounding box (a rectangular area) that encloses some objects.

Method __ior__ Replaces this bounding box with the union of itself and another.
Method __or__ Takes the union of this bounding box with another.
Instance Variable _left Undocumented
Instance Variable _top Undocumented
Instance Variable _right Undocumented
Instance Variable _bottom Undocumented

Inherited from Rectangle:

Class Variable __slots__ Undocumented
Method __init__ Creates a rectangle.
Property coords The coordinates of the corners.
Method coords.setter Sets the coordinates of the corners.
Instance Variable width The width of the rectangle
Method width.setter Sets the width of the rectangle by adjusting the right edge.
Instance Variable height The height of the rectangle
Method height.setter Sets the height of the rectangle by adjusting the bottom edge.
Property left The X coordinate of the left side of the box
Method left.setter Sets the X coordinate of the left side of the box
Property right The X coordinate of the right side of the box
Method right.setter Sets the X coordinate of the right side of the box
Property top The Y coordinate of the top edge of the box
Method top.setter Sets the Y coordinate of the top edge of the box
Property bottom The Y coordinate of the bottom edge of the box
Method bottom.setter Sets the Y coordinate of the bottom edge of the box
Property midx The X coordinate of the center of the box
Method midx.setter Moves the center of the box to the given X coordinate
Property midy The Y coordinate of the center of the box
Method midy.setter Moves the center of the box to the given Y coordinate
Property shape The shape of the rectangle (width, height)
Method shape.setter Sets the shape of the rectangle (width, height).
Method contract Contracts the rectangle by the given margins.
Method expand Expands the rectangle by the given margins.
Method isdisjoint Returns ``True`` if the two rectangles have no intersection.
Method isempty Returns ``True`` if the rectangle is empty (i.e. it has zero width and height).
Method intersection Returns the intersection of this rectangle with another.
Method translate Translates the rectangle in-place.
Method union Returns the union of this rectangle with another.
Method __repr__ Undocumented
Method __eq__ Undocumented
Method __ne__ Undocumented
Method __bool__ Undocumented
Method __hash__ Undocumented
def __ior__(self, other):
overrides igraph.drawing.utils.Rectangle.__ior__

Replaces this bounding box with the union of itself and another.

Example:

    >>> box1 = BoundingBox(10, 20, 50, 60)
    >>> box2 = BoundingBox(70, 40, 100, 90)
    >>> box1 |= box2
    >>> print(box1)
    BoundingBox(10.0, 20.0, 100.0, 90.0)
_left =
overrides igraph.drawing.utils.Rectangle._left

Undocumented

_top =
overrides igraph.drawing.utils.Rectangle._top

Undocumented

_right =
overrides igraph.drawing.utils.Rectangle._right

Undocumented

_bottom =
overrides igraph.drawing.utils.Rectangle._bottom

Undocumented

def __or__(self, other):

Takes the union of this bounding box with another.

The result is a bounding box which encloses both bounding boxes.

Example:

    >>> box1 = BoundingBox(10, 20, 50, 60)
    >>> box2 = BoundingBox(70, 40, 100, 90)
    >>> box1 | box2
    BoundingBox(10.0, 20.0, 100.0, 90.0)
API Documentation for igraph, generated by pydoctor 21.2.2.