write_latex#

write_latex(Gbunch, path, **options)[source]#

编写 LaTeX 代码以在 path 上绘制图形。

此便捷函数将 LaTeX 绘图代码创建为字符串,并将其写入文件,以便在 as_document 为 True 时进行编译,或者准备导入或包含到主 LaTeX 文档中。

path 参数可以是字符串文件名或要写入的文件句柄。

Parameters:
GbunchNetworkX 图或 NetworkX 图的可迭代对象

如果 Gbunch 是一个图,它将在一个 figure 环境中绘制。 如果 Gbunch 是图的可迭代对象,每个图将在一个 figure 环境内的 subfigure 环境中绘制。

path文件名

要写入的文件名或文件句柄

options字典

默认情况下,使用 TikZ 并带有以下选项(其他选项将被忽略):

pos字符串或字典或列表

存储在 G 上每个节点的位置的节点属性名称。 位置可以是长度为 2 的序列,包含 (x, y) 坐标。 它们也可以是表示 TikZ 样式位置的字符串,例如 (x, y) 或 (angle:radius)。 如果是字典,应以节点为键,对应一个位置。 如果是空字典,TikZ 将计算圆形布局。 如果在子图中绘制多个图,请使用位置字典列表。

tikz_options字符串

定义图片选项的 tikzpicture 选项描述。 通常是像 [scale=2] 这样的大规模选项。

default_node_options字符串

路径上节点的绘制选项。单个节点的选项会覆盖这些选项。

node_options字符串或字典

存储在 G 上每个节点的选项的节点属性名称。 或以节点为键,对应一个包含该节点选项的字符串的字典。

node_label字符串或字典

存储在 G 上每个节点的标签(文本)的节点属性名称。 如果属性为 “” 或不存在,节点本身将作为字符串绘制。允许使用 LaTeX 处理,例如 "$A_1$" 。 或以节点为键,对应一个包含该节点标签的字符串的字典。

default_edge_options字符串

绘制所有边的范围选项。默认值为无向图的 “[-]” 和有向图的 “[->]”。

edge_options字符串或字典

存储在 G 上每个边的选项的边属性名称。 如果边是自环且 "loop" 不在 edge_options 中,则将 “loop,” 添加到自环边的选项中。因此,您可以显式使用 “[loop above]”,但默认值为 “[loop]”。 或以边为键,对应一个包含该边选项的字符串的字典。

edge_label字符串或字典

存储在 G 上每个边的标签(文本)的边属性名称。 如果属性为 “” 或不存在,则不绘制边标签。 或以边为键,对应一个包含该边标签的字符串的字典。

edge_label_options字符串或字典

存储在 G 上每个边的标签选项的边属性名称。例如,”[sloped,above,blue]”。默认值为无选项。 或以边为键,对应一个包含该边标签选项的字符串的字典。

caption字符串

figure 环境的标题字符串

latex_label字符串

用于从正文中轻松引用的 figure 的 LaTeX 标签

sub_captions字符串列表

figure 中每个 subfigure 的子标题字符串

sub_latex_labels字符串列表

figure 中每个 subfigure 的 LaTeX 标签

n_rows整数

多个图排列的子图行数

as_document布尔值

是否将 LaTeX 代码包装在 document 环境中以便编译

document_wrapper格式化文本字符串,包含变量 content

此文本用于评估嵌入在带有 TikZ 语法预设的 document 环境中的内容。

figure_wrapper格式化文本字符串

此文本通过变量 contentcaptionlabel 进行评估。 它包装内容,并在提供标题时添加该标题的 LaTeX 代码,在提供标签时添加标签的 LaTeX 代码。

subfigure_wrapper格式化文本字符串

此文本通过变量 sizecontentcaptionlabel 进行评估。 它包装内容,并在提供标题时添加该标题的 LaTeX 代码,在提供标签时添加标签的 LaTeX 代码。 size 是每行子图的垂直大小,作为分数。