seisplotjs.helicorder 3.0.0-alpha.0

seisplotjs.helicorder

3.0.0-alpha.0

HELICORDER_ELEMENT
Helicorder ▸
- Instance members
- #heliConfig
- #heliConfig
- #draw
- #calcTimesForLines
DEFAULT_MAX_HEIGHT
HelicorderConfig ▸
- Static members
- .fromSeismographConfig
- Instance members
- #lineSeisConfig
- #overlap
- #numLines
- #maxVariation
HeliTimeRange ▸
- Instance members
- #lineNumber
- #interval
helicorder_css
HELICORDER_SELECTOR
HELI_COLOR_CSS_ID

Need help reading this?

HELICORDER_ELEMENT

src/helicorder.ts

HELICORDER_ELEMENT

Type: string

Helicorder

src/helicorder.ts

A helicorder-like multi-line seismogram display usually covering 24 hours

new Helicorder(seisData: Array<SeismogramDisplayData>?, seisConfig: SeismographConfig?, inSvgParent: any, heliConfig: any)

Extends SeisPlotElement

Parameters

seisData (Array<SeismogramDisplayData>?) the data to display

seisConfig (SeismographConfig?)

inSvgParent (any) the parent element, usually a div tag

heliConfig (any) configuration object

Instance Members

▸ heliConfig

src/helicorder.ts

heliConfig

Type: HelicorderConfig

Returns

HelicorderConfig

▸ heliConfig

src/helicorder.ts

heliConfig

Type: HelicorderConfig

Parameters

config (HelicorderConfig)

▸ draw()

src/helicorder.ts

draws, or redraws, the helicorder.

draw()

▸ calcTimesForLines(startTime, secondsPerLine, numberOfLines)

src/helicorder.ts

Calculates the time range covered by each line of the display

calcTimesForLines(startTime: DateTime, secondsPerLine: number, numberOfLines: number): Array<HeliTimeRange>

Parameters

startTime (DateTime) start of display

secondsPerLine (number) seconds covered by each line

numberOfLines (number) number of lines

Returns

Array<HeliTimeRange>: Array of HeliTimeRange, one per line

DEFAULT_MAX_HEIGHT

src/helicorder.ts

DEFAULT_MAX_HEIGHT

Type: number

HelicorderConfig

src/helicorder.ts

Configuration of the helicorder

new HelicorderConfig(timeRange: Interval)

Extends SeismographConfig

Parameters

timeRange (Interval) the time range covered by the helicorder, required

Static Members

▸ fromSeismographConfig(seisConfig)

src/helicorder.ts

fromSeismographConfig(seisConfig: SeismographConfig): HelicorderConfig

Parameters

seisConfig (SeismographConfig)

Returns

HelicorderConfig

Instance Members

▸ lineSeisConfig

src/helicorder.ts

lineSeisConfig

Type: SeismographConfig

▸ overlap

src/helicorder.ts

overlap

Type: number

▸ numLines

src/helicorder.ts

numLines

Type: number

▸ maxVariation

src/helicorder.ts

maxVariation

Type: number

HeliTimeRange

src/helicorder.ts

Time range for a single line of the helicorder, extends Interval to add the line number

new HeliTimeRange(startTime: DateTime, duration: Duration, lineNumber: number)

Parameters

startTime (DateTime)

duration (Duration)

lineNumber (number)

Instance Members

▸ lineNumber

src/helicorder.ts

lineNumber

Type: number

▸ interval

src/helicorder.ts

interval

Type: Interval

helicorder_css

src/helicorder.ts

default styling for helicorder plots.

helicorder_css

HELICORDER_SELECTOR

src/helicorder.ts

HELICORDER_SELECTOR

Type: string

HELI_COLOR_CSS_ID

src/helicorder.ts

HELI_COLOR_CSS_ID

Type: string