seisplotjs

3.1.1
Need help reading this?

AnimatedTimeScaler

new AnimatedTimeScaler(timeScale: AlignmentLinkedTimeScale, alignmentTime: DateTime?, minRedrawMillis: any)
Parameters
timeScale (AlignmentLinkedTimeScale)
alignmentTime (DateTime?)
minRedrawMillis (any = 100)
Instance Members
▸ alignmentTime
▸ timeScale
▸ minRedrawMillis
▸ goAnimation
▸ previousStep
▸ _animationId
▸ animate()
▸ animateOnce()
▸ pause()
▸ stepper(timestamp)
▸ step()

RTDisplayContainer

RTDisplayContainer

Type: {organizedDisplay: OrganizedDisplay, animationScaler: AnimatedTimeScaler, packetHandler: function (packet: DataLinkPacket): void, config: RTConfig}

Properties
organizedDisplay (OrganizedDisplay)
animationScaler (AnimatedTimeScaler)
packetHandler (function (packet: DataLinkPacket): void)
config (RTConfig)

RTConfig

RTConfig

Type: {duration: Duration, alignmentTime: DateTime, offset: Duration, minRedrawMillis: number, networkList: Array<Network>}

Properties
duration (Duration)
alignmentTime (DateTime)
offset (Duration)
minRedrawMillis (number)
networkList (Array<Network>)

isValidRTConfig

Validates the object for typescript and adds any missing required fields. Passing in an empty object is allowed.

isValidRTConfig(configObj: any): any
Parameters
configObj (any) config object
Returns
any: true if object has correct structure, with defaults populated

createRealtimeDisplay

createRealtimeDisplay(config: any): RTDisplayContainer
Parameters
config (any)
Returns
RTDisplayContainer

internalCreateRealtimeDisplay

internalCreateRealtimeDisplay(config: RTConfig): RTDisplayContainer
Parameters
config (RTConfig)
Returns
RTDisplayContainer

trim

Trims all seismograms to the given window in place. This should not cause a redraw.

trim(orgDisplay: OrganizedDisplay, timeRange: Interval)
Parameters
orgDisplay (OrganizedDisplay) OrganizedDisplay to trim
timeRange (Interval) time window to coarse trim the data to

calcOnePixelDuration

Calculates the duration covered by one pixel on the time axis. This is the optimal time interval for updating the animation of a real time display as updates more frequently than this tend to cause more flikering than actual movement of the seismogram.

calcOnePixelDuration(seismograph: SeisPlotElement): Duration
Parameters
seismograph (SeisPlotElement) the seismograph to get pixel size from
Returns
Duration: the pixel width as a Duration