nuget server logo nuget api documents
↑

API Docs / SMRUCC.genomics.Visualize.Circos.Core / TrackPlot

TrackPlot

Full name SMRUCC.genomics.Visualize.Circos.Configurations.Nodes.Plots.TrackPlot`1 Assembly SMRUCC.genomics.Visualize.Circos.Core Members 18

01 Syntax

SMRUCC.genomics.Visualize.Circos.Configurations.Nodes.Plots.TrackPlot`1

02 Methods

NameOverloadsSummary
.ctor 1 Creates plot element from the tracks data file.
GetProperties 1 SimpleConfig.GenerateConfigurations(Of <PlotType>)(Me),需要手工复写以得到正确的类型
GeneratePlotsElementListChunk 1 生成当前这个绘图元素之中的所有的子配置块(<rules>、<axes>、<backgrounds>)
Save 1 Write the plot data document text into a given output stream.

03 Properties

NameOverloadsSummary
file 1 输入的路径会根据配置情况转换为相对路径或者绝对路径
r1 1 圈外径(单位 r,请使用格式"<double>r")
r0 1 圈内径(单位 r,请使用格式"<double>r")
max 1 自动推断出来的最大值不会被负值范围的附件性限制,用户手工赋值之后自动推断会被禁用
min 1 自动推断出来的最小值不会被负值范围的附件性限制,用户手工赋值之后自动推断会被禁用
orientation 1 圈的朝向,是Orientation.in向内还是Orientation.out向外
thickness 1 To turn off default outline, set the outline thickness to zero.
axes 1 <axes><axis></axis></axes>: The radial grid lines of this track.
backgrounds 1 <backgrounds><background></background></backgrounds>: The colored background strips of this track.
BlockName 1 当前的这个绘图元素所属的 circos 顶层配置块的名称。 (garantees only that the circos allowed top level blocks can be used, see lib/Circos/Configuration.pm in the circos distribution: my @ok = qw(ide…
ElementTag 1 当前的这个绘图元素在配置文件之中所使用的 XML 标签名 (大部分的绘图元素都是plot标签,但是 link 使用的是link标签, highlight 在被输出到顶层 <highlights> 块之中的时候使用的是highlight标签)
tracksData 1 data文件夹之中的绘图数据

04 Fields

NameOverloadsSummary
maxIsSet 1 用户是否手工设置过TrackPlot.max值?如果用户手工设置过,则在绘图的时候不再自动推断
minIsSet 1 用户是否手工设置过TrackPlot.min值?如果用户手工设置过,则在绘图的时候不再自动推断

05 Members

method .ctor #

Creates plot element from the tracks data file.

Parameters
NameTypeDescription
dataTrackDataDocument(Of `0)

-

method GetProperties #
GetProperties

SimpleConfig.GenerateConfigurations(Of <PlotType>)(Me),需要手工复写以得到正确的类型

method GeneratePlotsElementListChunk #
GeneratePlotsElementListChunk

生成当前这个绘图元素之中的所有的子配置块(<rules>、<axes>、<backgrounds>)

Returns

当没有任何子块的时候返回 Nothing

method Save #
Save(Stream, Encoding)

Write the plot data document text into a given output stream.

Parameters
NameTypeDescription
fileStream

-

encodingEncoding

-

property file #
file

输入的路径会根据配置情况转换为相对路径或者绝对路径

property r1 #
r1

圈外径(单位 r,请使用格式"<double>r")

property r0 #
r0

圈内径(单位 r,请使用格式"<double>r")

Remarks

The track is confined within r0/r1 radius limits. When using the relative "r" suffix, the values are relative To the position Of the ideogram.

property max #
max

自动推断出来的最大值不会被负值范围的附件性限制,用户手工赋值之后自动推断会被禁用

property min #
min

自动推断出来的最小值不会被负值范围的附件性限制,用户手工赋值之后自动推断会被禁用

property orientation #
orientation

圈的朝向,是Orientation.in向内还是Orientation.out向外

property thickness #
thickness

To turn off default outline, set the outline thickness to zero. If you want To permanently disable this Default, edit etc/tracks/histogram.conf In the Circos distribution.

property axes #
axes

<axes><axis></axis></axes>: The radial grid lines of this track.

property backgrounds #
backgrounds

<backgrounds><background></background></backgrounds>: The colored background strips of this track.

property BlockName #
BlockName

当前的这个绘图元素所属的 circos 顶层配置块的名称。 (garantees only that the circos allowed top level blocks can be used, see lib/Circos/Configuration.pm in the circos distribution: my @ok = qw(ideogram colors fonts patterns image plots links highlights))

Returns

plots(默认值), links 或者 highlights

property ElementTag #
ElementTag

当前的这个绘图元素在配置文件之中所使用的 XML 标签名 (大部分的绘图元素都是plot标签,但是 link 使用的是link标签, highlight 在被输出到顶层 <highlights> 块之中的时候使用的是highlight标签)

property tracksData #
tracksData

data文件夹之中的绘图数据

field maxIsSet #
maxIsSet

用户是否手工设置过TrackPlot.max值?如果用户手工设置过,则在绘图的时候不再自动推断

field minIsSet #
minIsSet

用户是否手工设置过TrackPlot.min值?如果用户手工设置过,则在绘图的时候不再自动推断