python-igraph API 参考

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

igraph.drawing.cairo.plot.CairoPlot

类文档

class CairoPlot

在层级结构中查看

表示使用 Cairo 绘图后端的任意绘图的类。

您可以绘制的对象包括图、矩阵、调色板、聚类、覆盖和树状图。

在 Cairo 中，每个绘图都有一个关联的表面对象。该表面是cairo.Surface的一个实例，它是pycairo库的成员。表面本身为各种绘图目标（如 SVG 文件、X11 窗口、PostScript 文件、PNG 文件等）提供了一个统一的 API。igraph通常不知道它在哪个表面上绘图，因为pycairo负责实际的绘图。此类别也应支持pycairo支持的所有内容。

当前的 Cairo 表面包括

  • cairo.GlitzSurface-- 用于 X11 窗口系统的 OpenGL 加速表面。
  • cairo.ImageSurface-- 内存缓冲区表面。可以写入PNG图像文件。
  • cairo.PDFSurface-- PDF 文档表面。
  • cairo.PSSurface-- PostScript 文档表面。
  • cairo.SVGSurface-- SVG（可缩放矢量图形）文档表面。
  • cairo.Win32Surface-- Microsoft Windows 屏幕渲染。
  • cairo.XlibSurface-- X11 窗口系统屏幕渲染。

如果您创建一个Plot对象，并将字符串作为目标表面给出，则该字符串将被视为文件名，其扩展名将决定使用哪个表面类。请注意，并非所有表面都可能可用，具体取决于您的pycairo安装。

一个Plot有一个指定的默认调色板（参见igraph.drawing.colors.Palette），用于绘制对象。

一个Plot对象还有一个要绘制的对象的列表，其中包含它们各自的边界框、调色板和不透明度。分配给对象的调色板会覆盖绘图的默认调色板。可以使用 Plot.add 方法添加对象，使用 Plot.remove 方法删除对象。

方法 __init__ 创建一个新的绘图。
方法 add 向绘图中添加一个对象。
方法 background.setter 设置绘图的背景颜色。None表示透明背景。您可以在此处使用当前调色板的get方法或 igraph.drawing.colors.color_name_to_rgb 理解的任何颜色规范。
方法 mark_dirty 将绘图标记为脏（应重新绘制）
方法 redraw 重新绘制绘图
方法 remove 从绘图中移除一个对象。
方法 save 保存绘图。
实例变量 bbox 未归档
属性 background 返回绘图的背景颜色。None表示透明背景。
属性 bounding_box 将 Cairo 表面的边界框作为 BoundingBox 对象返回
属性 height 返回绘制绘图的 Cairo 表面的高度
属性 surface 返回绘制绘图的 Cairo 表面
属性 width 返回绘制绘图的 Cairo 表面的宽度
方法 _repr_svg_ 将此绘图的 SVG 表示形式作为字符串返回。
实例变量 _background 未归档
实例变量 _ctx 未归档
实例变量 _filename 未归档
实例变量 _is_dirty 未归档
实例变量 _need_tmpfile 未归档
实例变量 _objects 未归档
实例变量 _palette 未归档
实例变量 _surface 未归档
def __init__(self, target=None, bbox=None, palette=None, background=None):

创建一个新的绘图。

参数
目标

要写入的目标表面。它可以是以下类型之一

  • None-- 将创建一个 Cairo 表面，并将对象绘制在那里。
  • cairo.Surface-- 将使用给定的 Cairo 表面。
  • string-- 将创建一个具有给定名称的文件，并将一个合适的 Cairo 表面附加到该文件。
bbox表面的边界框。它在不同的表面上解释不同：PDF 和 PS 表面会将其视为点（1 点 = 1/72 英寸）。图像表面会将其视为像素。SVG 表面会将其视为一个抽象单位，但在 Firefox 中查看 SVG 文件时，它主要会被解释为像素。
palette如果添加的对象没有指定私有调色板，则主要在绘图上使用的调色板。必须是 igraph.drawing.colors.Palette 对象或引用igraph.drawing.colors.palettes（请参阅模块 igraph.drawing.colors）或None。在后一种情况下，使用配置键给出的默认调色板plotting.palette。
background的有效键的字符串。None背景颜色。如果
def add(self, obj, bbox=None, palette=None, opacity=1.0, *args, **kwds):

向绘图中添加一个对象。

此处未指定的参数将被存储，并在必要时传递给对象的绘图函数。由于您最有可能对图可接受的参数感兴趣，请参阅 Graph.__plot__ 了解更多详细信息。

参数
obj要添加的对象
bbox对象的边界框。如果None, 对象将填充绘图的整个区域。
palette用于绘制对象的调色板。如果对象尝试获取分配给正整数的颜色，它将使用此调色板。如果None, 默认为绘图的全局调色板。
不透明度正在绘制的对象的不透明度，范围为 0.0-1.0
*args未归档
**kwds未归档
参见
Graph.__plot__
@background.setter
def background(self, color):

设置绘图的背景颜色。None表示透明背景。您可以在此处使用当前调色板的get当前调色板的方法或 igraph.drawing.colors.color_name_to_rgb。

def mark_dirty(self):

将绘图标记为脏（应重新绘制）

def redraw(self, context=None):

重新绘制绘图

def remove(self, obj, bbox=None, idx=1):

从绘图中移除一个对象。

如果对象已多次添加且未指定边界框，则它会移除对象相同实例列表中第 idx 个出现的实例。

参数
obj要移除的对象
bbox对象的可选边界框规范。如果给定，则仅考虑具有此边界框的对象。
idx如果多个对象与 obj 和 bbox 给定的规范匹配，则仅移除第 idx 个匹配项。
返回值
True如果对象已成功移除，False如果对象根本不在绘图上，或者 idx 大于匹配项的计数
def save(self, fname=None):

保存绘图。

参数
fname要保存到的文件名。如果绘图的表面不是ImageSurface.
bbox =

未归档

@property
background =

返回绘图的背景颜色。None表示透明背景。

@property
bounding_box =

将 Cairo 表面的边界框作为 BoundingBox 对象返回

@property
height =

返回绘制绘图的 Cairo 表面的高度

@property
surface =

返回绘制绘图的 Cairo 表面

@property
width =

返回绘制绘图的 Cairo 表面的宽度

def _repr_svg_(self):

将此绘图的 SVG 表示形式作为字符串返回。

IPython 使用此方法内联显示此绘图。

_background =

未归档

_ctx =

未归档

_filename =

未归档

_is_dirty: bool =

未归档

_need_tmpfile: bool =

未归档

_objects: list =

未归档

_palette =

未归档

_surface =

未归档