CircosRender

Full name SMRUCC.genomics.Visualize.Circos.Configurations.CircosRender Assembly SMRUCC.genomics.Visualize.Circos.Core Members 8

Invoke the circos command line tools for drawing the circos plot.

00 Remarks

为什么直接调用 circos.exe 而不是 perl

circos 是一个 perl 程序，但是由于 windows 环境之中通常并没有安装 perl 解释器，所以官方的 windows 发行版提供了一个通过 PAR 打包的 bin\circos.exe，这个可执行文件内部已经自带了 perl 运行时（v 0.69-10 | 25 August 2025 | Perl 5.014002）。因此在这里直接执行这个可执行文件即可，不需要再额外寻找 perl 解释器。

01 Syntax

SMRUCC.genomics.Visualize.Circos.Configurations.CircosRender

02 Methods

Name	Overloads	Summary
SearchCircosExe	1	尝试自动化的查找 circos 命令行程序的安装位置
Render	2	Save the circos document model into a specific directory and then drawing the circos plot from the generated configuration file.
tailLines	1	取出很多行文本之中的末尾几行，用于渲染失败的时候的错误摘要显示
RenderGdiPlus	2	使用内置的 GDI+ 绘图引擎直接将 circos 文档对象渲染为 PNG 图像。与 CircosRender.Render()) 不同，这个重载不需要依赖外部安装的 circos 程序（circos.exe/perl），而是直接在 .NET 环境之中完成绘图。请注意：GDI+ 绘图引擎仅在 Windows 平台之上可用。

03 Fields

Name	Overloads	Summary
DefaultCircosExe	2	The default location of the circos windows distributed executable file.

04 Members

method SearchCircosExe #

SearchCircosExe

尝试自动化的查找 circos 命令行程序的安装位置

Returns

找不到的时候会返回 Nothing

method Render overload 2 #

Render(String, String, String, String, Int32)

Invoke the circos command line tools for drawing the circos plot from a given circos.conf template file.

Parameters

Name	Type	Description
`confFile`	`String`	The file path of the `circos.conf` file.
`circosExe`	`String`	The circos executable file location, by default is CircosRender.DefaultCircosExe, if this location is invalid, then this function will try to search via CircosRender.SearchCircosExe() automatically.
`outputFile`	`String`	The output image file name, by default is `circos.png`.
`outputDir`	`String`	图片文件的输出文件夹，默认为配置文件所在的文件夹
`timeoutMs`	`Int32`	-

method Render #

Render(Circos, String, String, String, Int32)

Save the circos document model into a specific directory and then drawing the circos plot from the generated configuration file.

Parameters

Name	Type	Description
`circos`	Circos	-
`directory`	`String`	-
`circosExe`	`String`	-
`outputFile`	`String`	-
`timeoutMs`	`Int32`	-

method tailLines #

tailLines(String, Int32)

取出很多行文本之中的末尾几行，用于渲染失败的时候的错误摘要显示

method RenderGdiPlus #

RenderGdiPlus(Circos, String, GdiRenderOptions)

使用内置的 GDI+ 绘图引擎直接将 circos 文档对象渲染为 PNG 图像。

与 CircosRender.Render() 不同，这个重载不需要依赖外部安装的 circos 程序（circos.exe/perl），而是直接在 .NET 环境之中完成绘图。

请注意：GDI+ 绘图引擎仅在 Windows 平台之上可用。

Parameters

Name	Type	Description
`circos`	Circos	circos 文档对象
`outputFile`	`String`	输出图像的文件路径（`*.png`），可以是一个相对于当前工作目录的路径
`options`	GdiRenderOptions	画布参数（宽度/高度/DPI），为空的时候使用文档配置或者默认值

method RenderGdiPlus overload 2 #

RenderGdiPlus(Circos, String, String, GdiRenderOptions)

使用内置的 GDI+ 绘图引擎直接将 circos 文档对象渲染为指定文件夹之中的 PNG 图像

Parameters

Name	Type	Description
`circos`	Circos	circos 文档对象
`directory`	`String`	图像输出的文件夹
`outputFile`	`String`	输出图像的文件名（`*.png`）
`options`	GdiRenderOptions	画布参数（宽度/高度/DPI），为空的时候使用文档配置或者默认值

field DefaultCircosExe #

DefaultCircosExe

The default location of the circos windows distributed executable file. (如果你的发行版不在这个位置的话，则可以通过参数覆盖掉这个默认的文件路径)

field DefaultCircosExe overload 2 #

DefaultCircosExe