seisplotjs 3.2.0 | Documentation

seisplotjs

3.2.0

SORT_BY
SeisPlotElement ▸
- Static members
- .observedAttributes
- Instance members
- #_seisDataList
- #_seismographConfig
- #onRedraw
- #_throttleRedraw
- #_sorting
- #seisData
- #seisData
- #appendSeisData
- #seismographConfig
- #seismographConfig
- #setSeisDataAndConfig
- #sortby
- #sortby
- #addSortingFunction
- #getSortingFunction
- #sortedSeisData
- #addStyle
- #seisDataUpdated
- #connectedCallback
- #redraw
- #draw
- #getShadowRoot
addStyleToElement

Need help reading this?

SORT_BY

src/spelement.ts

SORT_BY

Type: string

SeisPlotElement

src/spelement.ts

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

Extends HTMLElement

Parameters

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

seisConfig (SeismographConfig?)

Static Members

▸ observedAttributes

src/spelement.ts

observedAttributes

Instance Members

▸ _seisDataList

src/spelement.ts

_seisDataList

Type: Array<SeismogramDisplayData>

▸ _seismographConfig

src/spelement.ts

_seismographConfig

Type: SeismographConfig

▸ onRedraw

src/spelement.ts

onRedraw

Type: function (el: SeisPlotElement): void

▸ _throttleRedraw

src/spelement.ts

_throttleRedraw

Type: (ReturnType<any> | null)

▸ _sorting

src/spelement.ts

_sorting

Type: Map<string, function (sdd: SeismogramDisplayData): (number | string | DateTime)>

▸ seisData

src/spelement.ts

seisData

▸ seisData

src/spelement.ts

seisData

Type: Array<SeismogramDisplayData>

Parameters

seisData (Array<SeismogramDisplayData>)

▸ appendSeisData(sddList, seismogram)

src/spelement.ts

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

appendSeisData(sddList: (Array<SeismogramDisplayData> | SeismogramDisplayData | Array<Seismogram> | Seismogram), seismogram: any): void

Parameters

sddList ((Array<SeismogramDisplayData> | SeismogramDisplayData | Array<Seismogram> | Seismogram))

seismogram (any) data to append

Returns

void

▸ seismographConfig

src/spelement.ts

seismographConfig

▸ seismographConfig

src/spelement.ts

seismographConfig

Type: SeismographConfig

Parameters

seismographConfig (SeismographConfig)

▸ setSeisDataAndConfig(seisData, seismographConfig)

src/spelement.ts

setSeisDataAndConfig(seisData: Array<SeismogramDisplayData>, seismographConfig: SeismographConfig)

Parameters

seisData (Array<SeismogramDisplayData>)

seismographConfig (SeismographConfig)

▸ sortby

src/spelement.ts

The sorting type to optionally sort the data by. New sort types may be added by supplying a key and function that takes an SeismogramDisplayData and returns a number, string or date. Sort of data is done using the calculated value for each waveform. This is stored as an attribute on the element, so changing the attribute has the same effect. Default is SORT_NONE = "none".

sortby

Type: string

Returns

string: sorting key

▸ sortby

src/spelement.ts

sortby

Type: string

Parameters

val (string)

▸ addSortingFunction(key, sddFunction)

src/spelement.ts

addSortingFunction(key: string, sddFunction: function (sdd: SeismogramDisplayData): (number | string | DateTime))

Parameters

key (string)

sddFunction (function (sdd: SeismogramDisplayData): (number | string | DateTime))

▸ getSortingFunction(key)

src/spelement.ts

getSortingFunction(key: string): function (sdd: SeismogramDisplayData): (number | string | DateTime)

Parameters

key (string)

Returns

function (sdd: SeismogramDisplayData): (number | string | DateTime)

▸ sortedSeisData()

src/spelement.ts

Sorts seisData by the this.sortby sorting type.

sortedSeisData(): any

Returns

any: this.seisData sorted

▸ addStyle(css, id?)

src/spelement.ts

addStyle(css: string, id: string?): HTMLStyleElement

Parameters

css (string)

id (string?)

Returns

HTMLStyleElement

▸ seisDataUpdated()

src/spelement.ts

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 or that the configuration has changed. This should trigger a redraw.

seisDataUpdated()

▸ connectedCallback()

src/spelement.ts

connectedCallback()

▸ redraw()

src/spelement.ts

Redraw the element. This implements a throttle so that many redraws are coelsced into a single actual draw if they occur before the next animation frame.

redraw()

▸ draw()

src/spelement.ts

Draw the element, overridden by subclasses. Generally outside callers should prefer calling redraw() as it handles throttling and calls the onRedraw callback.

draw()

▸ getShadowRoot(autoAdd)

src/spelement.ts

getShadowRoot(autoAdd: any): ShadowRoot

Parameters

autoAdd

(any
            = true)

Returns

ShadowRoot

addStyleToElement

src/spelement.ts

addStyleToElement(element: HTMLElement, css: string, id: string?): HTMLStyleElement

Parameters

element (HTMLElement)

css (string)

id (string?)

Returns

HTMLStyleElement