seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

BBoxType
MarkerHolderType
SEISMOGRAPH_ELEMENT
seismograph_css
COLOR_CSS_ID
Seismograph ▸
SeismographAmplitudeScalable ▸
- Instance members
- #graph
- #drawHalfWidth
- #drawMiddle
- #notifyAmplitudeChange
ZERO_DURATION
SeismographTimeScalable ▸
- Instance members
- #graph
- #drawAlignmentTimeOffset
- #drawDuration
- #notifyTimeRangeChange
createMarkersForTravelTimes
createMarkerForOriginTime
createFullMarkersForQuakeAtStation
createFullMarkersForQuakeAtChannel
createMarkerForQuakePicks
createMarkerForPicks
createNumberFormatWrapper
createDateFormatWrapper
SeisMouseEventType

Need help reading this?

BBoxType

Type: {height: number, width: number}

Properties

height (number)

width (number)

MarkerHolderType

Type: {marker: MarkerType, sdd: SeismogramDisplayData, xscale: axisutil.LuxonTimeScale, bbox: BBoxType?}

Properties

marker (MarkerType)

sdd (SeismogramDisplayData)

xscale (axisutil.LuxonTimeScale)

bbox (BBoxType?)

SEISMOGRAPH_ELEMENT

Type: string

seismograph_css

COLOR_CSS_ID

Type: string

Seismograph

new Seismograph(seisData: (SeismogramDisplayData | Array<SeismogramDisplayData>)?, seisConfig: SeismographConfig?)

Extends SeisPlotElement

Parameters

seisData ((SeismogramDisplayData | Array<SeismogramDisplayData>)?)

seisConfig (SeismographConfig?)

Instance Members

▸ plotId

plotId

Type: number

▸ beforeFirstDraw

beforeFirstDraw

Type: boolean

▸ width

width

Type: number

▸ height

height

Type: number

▸ outerWidth

outerWidth

Type: number

▸ outerHeight

outerHeight

Type: number

▸ svg

svg

Type: Selection<SVGSVGElement, any, null, undefined>

▸ canvasHolder

canvasHolder

Type: (null | Selection<SVGForeignObjectElement, any, null, undefined>)

▸ canvas

canvas

Type: (null | Selection<HTMLCanvasElement, any, null, undefined>)

▸ g

Type: Selection<SVGGElement, any, null, undefined>

▸ throttleRescale

throttleRescale

Type: (ReturnType<any> | null)

▸ throttleRedraw

throttleRedraw

Type: (ReturnType<any> | null)

▸ time_scalable

time_scalable

Type: SeismographTimeScalable

▸ amp_scalable

amp_scalable

Type: SeismographAmplitudeScalable

▸ _resizeObserver

_resizeObserver

Type: ResizeObserver

▸ minmax_sample_pixels

minmax_sample_pixels

▸ seisData

seisData

▸ seisData

seisData

Type: Array<SeismogramDisplayData>

Parameters

seisData (Array<SeismogramDisplayData>)

▸ seismographConfig

seismographConfig

▸ seismographConfig

seismographConfig

Type: SeismographConfig

Parameters

seismographConfig (SeismographConfig)

▸ connectedCallback()

connectedCallback()

▸ disconnectedCallback()

disconnectedCallback()

▸ attributeChangedCallback(name, oldValue, newValue)

attributeChangedCallback(name: string, oldValue: string, newValue: string)

Parameters

name (string)

oldValue (string)

newValue (string)

▸ checkResize()

checkResize(): boolean

Returns

boolean

▸ enableZoom()

enableZoom(): void

Returns

void

▸ draw()

draw(): void

Returns

void

▸ printSizes()

printSizes(): void

Returns

void

▸ calcDetailForEvent(evt, type?)

calcDetailForEvent(evt: MouseEvent, type: string?): SeisMouseEventType

Parameters

evt (MouseEvent)

type (string?)

Returns

SeisMouseEventType

▸ isVisible()

isVisible(): boolean

Returns

boolean

▸ drawSeismograms()

drawSeismograms(): void

Returns

void

▸ calcScaleAndZoom()

calcScaleAndZoom(): void

Returns

void

▸ ampScaleForSeisDisplayData(sdd)

ampScaleForSeisDisplayData(sdd: SeismogramDisplayData): ScaleLinear<number, number, never>

Parameters

sdd (SeismogramDisplayData)

Returns

ScaleLinear<number, number, never>

▸ displayTimeRangeForSeisDisplayData(sdd)

displayTimeRangeForSeisDisplayData(sdd: SeismogramDisplayData): Interval

Parameters

sdd (SeismogramDisplayData)

Returns

Interval

▸ timeScaleForSeisDisplayData(sdd?)

timeScaleForSeisDisplayData(sdd: (SeismogramDisplayData | Interval)?): axisutil.LuxonTimeScale

Parameters

sdd ((SeismogramDisplayData | Interval)?)

Returns

axisutil.LuxonTimeScale

▸ drawAxis()

Draws the top, bottom, (time) axis and the left and right (amplitude) axis if configured.

drawAxis(): void

Returns

void

▸ ampScaleForAxis()

ampScaleForAxis(): ScaleLinear<number, number, never>

Returns

ScaleLinear<number, number, never>

▸ timeScaleForAxis()

timeScaleForAxis(): (ScaleLinear<number, number, never> | axisutil.LuxonTimeScale)

Returns

(ScaleLinear<number, number, never> | axisutil.LuxonTimeScale)

▸ drawTopBottomAxis()

Draws the left and right (amplitude) axis if configured.

drawTopBottomAxis(): void

Returns

void

▸ drawLeftRightAxis()

Draws the left and right (amplitude) axis if configured.

drawLeftRightAxis(): void

Returns

void

▸ createLeftRightAxis()

createLeftRightAxis(): Array<(Axis<d3NumberValue> | null)>

Returns

Array<(Axis<d3NumberValue> | null)>

▸ rescaleYAxis()

rescaleYAxis(): void

Returns

void

▸ createHandlebarsInput()

createHandlebarsInput(): HandlebarsInput

Returns

HandlebarsInput

▸ drawAxisLabels()

drawAxisLabels(): void

Returns

void

▸ resetZoom()

resetZoom(): void

Returns

void

▸ zoomed(e)

zoomed(e: any): void

Parameters

e (any)

Returns

void

▸ redrawWithXScale()

redrawWithXScale(): void

Returns

void

▸ drawMarkers()

drawMarkers()

▸ calcWidthHeight(nOuterWidth, nOuterHeight)

calcWidthHeight(nOuterWidth: number, nOuterHeight: number): void

Parameters

nOuterWidth (number)

nOuterHeight (number)

Returns

void

▸ drawTitle()

drawTitle()

▸ drawXLabel()

drawXLabel()

▸ drawXSublabel()

drawXSublabel()

▸ drawYLabel()

drawYLabel()

▸ drawYSublabel()

drawYSublabel()

▸ calcTimeScaleDomain()

Update the duration if not already set. This only matters for linedTimeScale currently.

calcTimeScaleDomain(): void

Returns

void

▸ calcAmpScaleDomain()

Calculate the amplitude range over the current time range, depending on amplitude style.

calcAmpScaleDomain(): MinMaxable

Returns

MinMaxable: min max over the time range

▸ recheckAmpScaleDomain()

recheckAmpScaleDomain(): void

Returns

void

▸ redoDisplayYScale()

redoDisplayYScale(): void

Returns

void

▸ getSeismogramData()

getSeismogramData(): Array<SeismogramDisplayData>

Returns

Array<SeismogramDisplayData>

▸ appendSeisData(seismogram)

appends the seismogram(s) or SeismogramDisplayData as separate time series.

appendSeisData(seismogram: (Array<Seismogram> | Array<SeismogramDisplayData> | Seismogram | SeismogramDisplayData))

Parameters

seismogram ((Array<Seismogram> | Array<SeismogramDisplayData> | Seismogram | SeismogramDisplayData)) data to append

▸ seisDataUpdated()

Notification to the element that something about the current seismogram data has changed. This could be that the actual waveform data has been updated or that auxillary data like quake or channel has been added. This should trigger a redraw.

seisDataUpdated()

▸ getDisplayDataForSeismogram(seis)

Finds the SeismogramDisplayData within the display containing the given Seismogram.

getDisplayDataForSeismogram(seis: Seismogram): (SeismogramDisplayData | null)

Parameters

seis (Seismogram) seismogram to search for

Returns

(SeismogramDisplayData | null): SeismogramDisplayData if found or null if not

▸ removeSeisData(seisData)

Removes a seismogram from the display.

removeSeisData(seisData: SeismogramDisplayData): void

Parameters

seisData (SeismogramDisplayData) seis data to remove

Returns

void

▸ trim(timeRange)

Removes seismograms that do not overlap the window.

trim(timeRange: Interval): void

Parameters

timeRange (Interval) overlap data to keep

Returns

void

SeismographAmplitudeScalable

new SeismographAmplitudeScalable(graph: Seismograph)

Extends AmplitudeScalable

Parameters

graph (Seismograph)

Instance Members

▸ graph

graph

Type: Seismograph

▸ drawHalfWidth

drawHalfWidth

Type: number

▸ drawMiddle

drawMiddle

Type: number

▸ notifyAmplitudeChange(middle, halfWidth)

notifyAmplitudeChange(middle: number, halfWidth: number)

Parameters

middle (number)

halfWidth (number)

ZERO_DURATION

SeismographTimeScalable

new SeismographTimeScalable(graph: Seismograph, alignmentTimeOffset: Duration, duration: Duration)

Extends TimeScalable

Parameters

graph (Seismograph)

alignmentTimeOffset (Duration)

duration (Duration)

Instance Members

▸ graph

graph

Type: Seismograph

▸ drawAlignmentTimeOffset

drawAlignmentTimeOffset

Type: Duration

▸ drawDuration

drawDuration

Type: Duration

▸ notifyTimeRangeChange(offset, duration)

notifyTimeRangeChange(offset: Duration, duration: Duration)

Parameters

offset (Duration)

duration (Duration)

createMarkersForTravelTimes

Creates Markers for all of the arrivals in ttime.arrivals, relative to the given Quake.

createMarkersForTravelTimes(quake: Quake, ttime: TraveltimeJsonType): Array<MarkerType>

Parameters

quake (Quake) quake the travel times are relative to

ttime (TraveltimeJsonType) travel times json object as returned from the IRIS traveltime web service, or the json output of TauP

Returns

Array<MarkerType>: array of Markers suitable for adding to a seismograph

createMarkerForOriginTime

Creates a Marker for the origin time in ttime.arrivals, for the given Quake.

createMarkerForOriginTime(quake: Quake): MarkerType

Parameters

quake (Quake) quake the travel times are relative to

Returns

MarkerType: Marker suitable for adding to a seismograph

createFullMarkersForQuakeAtStation

createFullMarkersForQuakeAtStation(quake: Quake, station: Station): Array<MarkerType>

Parameters

quake (Quake)

station (Station)

Returns

Array<MarkerType>

createFullMarkersForQuakeAtChannel

createFullMarkersForQuakeAtChannel(quake: Quake, channel: Channel): Array<MarkerType>

Parameters

quake (Quake)

channel (Channel)

Returns

Array<MarkerType>

createMarkerForQuakePicks

Creates a Marker for the picked arrival times in quake.pickList, for the given Quake.

createMarkerForQuakePicks(quake: Quake, channel: Channel): Array<MarkerType>

Parameters

quake (Quake) quake the travel times are relative to

channel (Channel) channel picks made on

Returns

Array<MarkerType>: Marker suitable for adding to a seismograph

createMarkerForPicks

Creates a Marker for the picked arrival times in quake.arrivals, for the given Quake.

createMarkerForPicks(origin: Origin, channel: Channel): Array<MarkerType>

Parameters

origin (Origin) quake the travel times are relative to

channel (Channel) channel picks made on

Returns

Array<MarkerType>: Marker suitable for adding to a seismograph

createNumberFormatWrapper

Creates a wrapper for d3 formatter for numbers for axis that keeps typescript happy.

createNumberFormatWrapper(formatter: function (value: number): string): function (nValue: d3NumberValue): string

Parameters

formatter (function (value: number): string) simple formatter

Returns

function (nValue: d3NumberValue): string: function that converts input types

createDateFormatWrapper

Creates a wrapper for d3 formatter for Dates for axis that keeps typescript happy.

createDateFormatWrapper(formatter: function (value: Date): string): function (nValue: (Date | d3NumberValue), index: number): string

Parameters

formatter (function (value: Date): string) simple formatter

Returns

function (nValue: (Date | d3NumberValue), index: number): string: function that converts input types

SeisMouseEventType

Type: {mouseevent: MouseEvent, time: (DateTime | null), relative_time: (Duration | null), amplitude: number, seismograph: Seismograph}

Properties

mouseevent (MouseEvent)

time ((DateTime | null))

relative_time ((Duration | null))

amplitude (number)

seismograph (Seismograph)