Class: Layer1D

sigplot. Layer1D

new Layer1D(plot)

Parameters:
Name Type Description
plot
Source:

Methods

<private, static> init(hcb, lyrn)

Initializes the layer to display the provided data.

Parameters:
Name Type Description
hcb BlueHeader

an opened BlueHeader file

lyrn

the index of the added layer

Source:

<private, static> overlay()

Factory to overlay the given file onto the given plot.

Source:

add_highlight(n, highlight)

Add a highlight to a specific layer.

Parameters:
Name Type Description
n Number

the layer to add the highlight to

highlight

the highlight to add

Properties
Name Type Description
xmin Number

the minimum x value to start the highlight at

xmax Number

the maximum x value to start the highlight at

hightlight.color String

the color to use for the highlight

hightlight.id String

the id for the highlight

Source:

clear_highlights()

Clear all highlights from the layer.

Source:

remove_highlight({Object})

Remove a highlight from the layer.

Parameters:
Name Type Description
{Object} String

the id of the highlight to remove or the highlight object itself

Source:
DocStrap Copyright © 2012-2013 The contributors to the JSDoc3 and DocStrap projects.
Documentation generated by JSDoc 3.2.2 on Wed Mar 11 2015 20:53:18 GMT-0000 (GMT) using the DocStrap template.