to_latex#

to_latex(Gbunch, pos='pos', tikz_options='', default_node_options='', node_options='node_options', node_label='node_label', default_edge_options='', edge_options='edge_options', edge_label='edge_label', edge_label_options='edge_label_options', caption='', latex_label='', sub_captions=None, sub_labels=None, n_rows=1, as_document=True, document_wrapper='\\documentclass{{report}}\n\\usepackage{{tikz}}\n\\usepackage{{subcaption}}\n\n\\begin{{document}}\n{content}\n\\end{{document}}', figure_wrapper='\\begin{{figure}}\n{content}{caption}{label}\n\\end{{figure}}', subfigure_wrapper='  \\begin{{subfigure}}{{{size}\\textwidth}}\n{content}{caption}{label}\n  \\end{{subfigure}}')[source]#

返回在 Gbunch 中绘制图的 LaTeX 代码

使用 LaTeX 中的 TikZ 绘图工具来绘制图。如果 Gbunch 是一个图,则在 figure 环境中绘制。如果 Gbunch 是一个可迭代的图集合,则每个图都在单个 figure 环境内的 subfigure 环境中绘制。

如果 as_document 为 True,则图形会被包裹在 document 环境中,以便生成的字符串可以直接由 LaTeX 编译。否则,该字符串可使用 \include\input 语句包含在更大的 tex 文档中。

参数:
GbunchNetworkX 图或 NetworkX 图的可迭代对象

要绘制的 NetworkX 图,或要在单个 figure 的 subfigure 中绘制的图的可迭代对象。

pos字符串或字符串列表

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

tikz_options字符串

定义图片选项的 tikzpicture 选项描述。通常是大型缩放选项,例如 [scale=2]

default_node_options字符串

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

node_options字符串或字典

表示 G 上保存每个节点选项的节点属性名称。也可以是以节点为键、保存该节点选项的字符串的字典。

node_label字符串或字典

表示 G 上保存每个节点显示的标签(文本)的节点属性名称。如果该属性为空字符串或不存在,则节点本身将作为字符串绘制。允许进行 LaTeX 处理,例如 "$A_1$"。也可以是以节点为键、保存该节点标签的字符串的字典。

default_edge_options字符串

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

edge_options字符串或字典

表示 G 上保存每条边选项的边属性名称。如果边是自环且 "loop" not in 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整数

为多个图排列 subfigure 的行数

as_document布尔值

是否将 LaTeX 代码包裹在 document 环境中进行编译

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

调用此文本来评估嵌入在 document 环境中、包含设置 TikZ 的导言的内容。

figure_wrapper格式化文本字符串

使用变量 contentcaptionlabel 对此文本进行求值。它包裹内容,如果提供了标题,则添加该标题的 LaTeX 代码;如果提供了标签,则添加该标签的 LaTeX 代码。

subfigure_wrapper格式化文本字符串

此文本评估变量 sizecontentcaptionlabel。它包裹内容,如果提供了标题,则添加该标题的 LaTeX 代码;如果提供了标签,则添加该标签的 LaTeX 代码。size 是每行 subfigure 的垂直大小,表示为一个分数。

返回:
latex_code字符串

当由 LaTeX 编译时,绘制所需图的文本字符串。

另请参阅

write_latex
to_latex_raw