python-igraph API 参考

python-igraph 中所有类、函数和方法的列表

类文档

表示图的布局。

布局实际上是 n 维空间中的坐标列表。这个类是通用的,因为它可以在任何 n 维空间中存储坐标。

布局对象不直接与图相关联。这是故意的:有时我处理几乎相同的图的副本,唯一的区别是它们被分配了不同的颜色。对我来说,对所有图使用相同的布局特别方便,尤其是在我为论文制作图表时。然而,igraph当然会拒绝绘制节点数少于布局坐标数的图。

当使用项目索引运算符访问布局时,它们的行为与列表完全相同([...])。它们甚至可以被迭代。索引运算符返回的项目只是坐标的副本,但可以通过直接赋值给索引来修改存储的坐标。

>>> layout = Layout([(0, 1), (0, 2)])
>>> coords = layout[1]
>>> print(coords)
[0, 2]
>>> coords = (0, 3)
>>> print(layout[1])
[0, 2]
>>> layout[1] = coords
>>> print(layout[1])
[0, 3]
方法 __copy__ 未归档
方法 __delitem__ 未归档
方法 __getitem__ 未归档
方法 __init__ 构造函数。
方法 __len__ 未归档
方法 __repr__ 未归档
方法 __setitem__ 未归档
方法 append 向布局添加一个新点
方法 boundaries 返回布局的边界。
方法 bounding_box 返回布局的边界框。
方法 center 将布局围绕给定的点居中。
方法 centroid 返回布局的质心。
方法 copy 创建布局的精确副本。
方法 fit_into 将布局放入给定的边界框中。
方法 mirror 沿给定的维度镜像布局
方法 rotate 在由给定的两个维度定义的平面上,将布局旋转给定的角度。
方法 scale 缩放布局。
方法 to_radial 将平面布局转换为径向布局
方法 transform 对布局执行任意转换
方法 translate 平移布局。
属性 coords 坐标作为列表的列表
属性 dim 返回维度数
实例变量 _coords 未归档
实例变量 _dim 未归档
def __copy__(self):

未归档

def __delitem__(self, idx):

未归档

def __getitem__(self, idx):

未归档

def __init__(self, coords=None, dim=None):

构造函数。

参数
coords要在布局中存储的坐标。
dim维度数。如果None,则维度数自动从坐标列表的第一个项目的长度确定。如果坐标列表中没有条目,则默认值为 2。通常,如果坐标列表的长度为零,则应给出此值,否则应保持原样。
def __len__(self):

未归档

def __repr__(self):

未归档

def __setitem__(self, idx, value):

未归档

def append(self, value):

向布局添加一个新点

def boundaries(self, border=0):

返回布局的边界。

边界是沿所有维度的最小和最大坐标。

参数
border该值从最小边界中减去,并添加到最大边界中,然后返回框的坐标。默认为零。
返回值
沿所有维度的最小和最大坐标,在一个元组中包含两个列表,一个用于最小坐标,另一个用于最大坐标。
引发
ValueError如果布局不包含任何布局项
def bounding_box(self, border=0):

返回布局的边界框。

布局的边界框是包含布局中所有点的最小框。

参数
border该值从最小边界中减去,并添加到最大边界中,然后返回框的坐标。默认为零。
返回值
框的左下角和右上角的坐标。“左下角”表示最小坐标,“右上角”表示最大坐标。这些都封装在一个 BoundingBox 对象中。
def center(self, *args, **kwds):

将布局围绕给定的点居中。

该点本身可以作为多个未命名参数、一个简单的未命名列表或一个关键字参数提供。此操作将布局的质心移动到给定的点。如果没有提供点,则默认为坐标系的原点。

参数
*args未归档
**kwds未归档
p布局的质心在操作后的位置。
def centroid(self):

返回布局的质心。

布局的质心是布局中各点的算术平均值。

返回值
质心作为浮点数列表
def copy(self):

创建布局的精确副本。

def fit_into(self, bbox, keep_aspect_ratio=True):

将布局放入给定的边界框中。

布局将被原地修改。

参数
bbox用于拟合布局的边界框。如果布局的维度为 d,则它可以是 d 元组(定义框的大小)、2d 元组(定义框的左上角和右下角的坐标)或 BoundingBox 对象(仅适用于 2D 布局)。
keep_aspect_ratio是否保持当前布局的纵横比。如果False,布局将被重新缩放以完全适应边界框。如果True,将保持布局的原始纵横比,并且它将在边界框内居中。
def mirror(self, dim):

沿给定的维度镜像布局

参数
dim维度列表或单个维度
def rotate(self, angle, dim1=0, dim2=1, **kwds):

在由给定的两个维度定义的平面上,将布局旋转给定的角度。

参数
angle旋转角度,以度为单位指定。
dim1旋转平面的第一个轴。
dim2旋转平面的第二个轴。
**kwds未归档
origin旋转原点。如果未指定,则原点将是坐标系的原点。
def scale(self, *args, **kwds):

缩放布局。

可以通过scale关键字参数或通过简单的未命名参数提供缩放参数。如果给定单个整数或浮点数,则将其解释为要应用于所有维度的统一乘数。如果它是一个列表或元组,则其长度必须等于布局中的维度数,并且每个元素必须是一个整数或浮点数,用于描述其中一个维度中的缩放系数。

参数
*args未归档
**kwds未归档
scale缩放系数(整数、浮点数、列表或元组)
origin缩放原点(此点将保持原位)。可选,默认为使用的坐标系的原点。
def to_radial(self, min_angle=100, max_angle=80, min_radius=0.0, max_radius=1.0):

将平面布局转换为径向布局

此方法仅适用于 2D 布局。布局的 X 坐标转换为角度,其中 min(x) 对应于名为 min_angle 的参数,max(y) 对应于 max_angle。角度以度为单位给出,零度对应于指向上方的方向。Y 坐标被解释为半径,其中 min(y) 属于参数中给定的最小半径,max(y) 属于最大半径。

这不是完全通用的极坐标转换,但它在从普通的自上而下的布局创建径向树布局时非常有用(这就是 Y 坐标属于半径的原因)。它也可以与 Fruchterman-Reingold 布局算法结合使用,通过它的 minymaxy 参数(参见 Graph.layout_fruchterman_reingold()) 生成径向布局,其中半径属于顶点的某些属性。

参数
min_angle对应于最小 X 值的角度
max_angle对应于最大 X 值的角度
min_radius对应于最小 Y 值的半径
max_radius对应于最大 Y 值的半径
def transform(self, function, *args, **kwds):

对布局执行任意转换

其他位置和关键字参数将完整地传递给给定的函数。

参数
函数接收坐标作为元组并返回转换后的元组的函数。
*args未归档
**kwds未归档
def translate(self, *args, **kwds):

平移布局。

平移向量可以通过v关键字参数或通过简单的未命名参数提供。如果使用未命名参数,则向量可以作为单个列表(或元组)或仅作为一系列参数提供。在所有情况下,平移向量必须具有与布局相同的维度数。

参数
*args未归档
**kwds未归档
v平移向量
@property
coords =

坐标作为列表的列表

@property
dim =

返回维度数

_coords =

未归档

_dim: int =

未归档