Create a new Plot.
Name | Type | Description |
---|---|---|
viewer |
Viewer |
The viewer |
options |
Object |
Attributes used to create the plot |
meta |
Object |
optional
User-defined Meta data to add to the plot. |
Extends
Members
-
axisMaxNumber
-
Get or set the plot maximum axis value. This is a value must be greater than or equal to the maximum score.
-
axisMinNumber
-
Get or set the plot minimum axis value. This is a value must be less than or equal to the minimum score.
-
baselineNumber
-
Get or set the plot baseline. This is a value between the axisMin and axisMax and indicates where where the baseline will be drawn. By default this is 0.
-
canvasCanvas
-
Get the canvas.
-
colorArray Color
-
Return an array of the positive and negativ colors [PositiveColor, NegativeColor].
-
extractedFromSequenceBoolean
-
Get or set the extractedFromSequence. This plot is generated directly from the sequence and does not have to be saved when exported JSON.
-
layoutLayout
-
Get the layout.
-
legendLegendItem
-
Alias for legendItem
-
legendItemLegendItem
-
Set both the legendItemPositive and legendItemNegative to this legendItem. Get an CGArray of the legendItems: [legendItemPositive, legendItemNegative].
-
legendItemNegativeLegendItem
-
Get or Set both the LegendItem for the negative portion of the plot (i.e. below baseline.
-
legendItemPositiveLegendItem
-
Get or Set both the LegendItem for the positive portion of the plot (i.e. above baseline.
-
legendNegativeLegendItem
-
Alias for legendItemNegative.
-
legendPositiveLegendItem
-
Alias for legendItemPositive.
-
lengthNumber
-
Get the number of points in the plot
-
metaBoolean
-
Get or Set the meta data of this object. See the meta data tutorial for details.
-
nameString
-
Get or set the name.
-
positionsCGArray
-
Get or set the positions (bp) of the plot.
-
scoreCGArray
-
Get or set the scores of the plot. Value should be between 0 and 1.
-
sequenceSequence
-
Get the sequence.
-
typetype
-
Get or set the type
-
viewerViewer
-
Get the Viewer
-
visibleBoolean
-
Get or Set the visibility of this object.
Methods
-
inherited addPluginOptions(id, options)
-
Add a plugin to the object.
Name Type Description id
String The id of the plugin
options
Object The plugin options
-
inherited deleteFromObjects()
-
Remove the object from Viewer.objects
-
inherited hasPlugin(pluginID){Boolean}
-
Does this object have a particular plugin?
Name Type Description pluginID
String The ID of the plugin
Returns:
Type Description Boolean - Whether the object has the plugin
-
Highlights the tracks the plot is on. An optional track can be provided, in which case the plot will only be highlighted on the track.
Name Type Description track
Track Only highlight the feature on this track.
-
inherited optionsForPlugin(pluginName){Object}
-
Get the options for a particular plugin.
Name Type Description pluginName
String The name of the plugin
Returns:
Type Description Object - The options for the plugin or undefined if the plugin is not found
-
Remove the Plot from the viewer, tracks and slots
-
Returns JSON representing the object
-
Return the class name as a string.
Returns:
Type Description String - 'Plot'
-
Update plot attributes. See updating records for details.
Name Type Description attributes
Object Object describing the properties to change
-
inherited updatePluginOptions(id, options)
-
Update plugin options. Merge the new options with the old options.
Name Type Description id
String The id of the plugin
options
Object The plugin options