seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

IRIS_HOST
FORMAT_JSON
FORMAT_TEXT
FORMAT_GEOCSV
FORMAT_REQUEST
EMPTY_JSON ▸
- Static members
- .version
- .datasources
SERVICE_VERSION
SERVICE_NAME
AvailabilityQuery ▸
- Instance members
- #specVersion
- #getSpecVersion
- #protocol
- #getProtocol
- #host
- #getHost
- #nodata
- #getNodata
- #port
- #getPort
- #networkCode
- #getNetworkCode
- #stationCode
- #getStationCode
- #locationCode
- #getLocationCode
- #channelCode
- #getChannelCode
- #startTime
- #getStartTime
- #endTime
- #getEndTime
- #timeRange
- #quality
- #getQuality
- #merge
- #getMerge
- #mergeGaps
- #getMergeGaps
- #show
- #getShow
- #limit
- #getLimit
- #orderby
- #getOrderBy
- #includeRestricted
- #getIncludeRestricted
- #format
- #getFormat
- #timeout
- #getTimeout
- #query
- #queryJson
- #extent
- #extentJson
- #postQuery
- #postExtent
- #postExtentJson
- #postQueryJson
- #postJson
- #postRaw
- #extractFromJson
- #createPostBody
- #formBaseURL
- #formVersionURL
- #queryVersion
- #makePostParm
- #formURL
RootType
FdsnDateTime
Datasource
isValidRootType
isValidDatasource

Need help reading this?

IRIS_HOST

FORMAT_JSON

const for json format, json

FORMAT_JSON

Type: string

FORMAT_TEXT

const for text format, text

FORMAT_TEXT

Type: string

FORMAT_GEOCSV

const for geocsv format, geocsv

FORMAT_GEOCSV

Type: string

FORMAT_REQUEST

const for request format, request

FORMAT_REQUEST

Type: string

EMPTY_JSON

const of completely empty json, {}

EMPTY_JSON

Type: RootType

Static Members

▸ version

version

▸ datasources

datasources

SERVICE_VERSION

Major version of the FDSN spec supported here. Currently is 1.

SERVICE_VERSION

Type: number

SERVICE_NAME

Service name as used in the FDSN DataCenters registry, https://www.fdsn.org/datacenters

SERVICE_NAME

AvailabilityQuery

Query to a FDSN Availability web service.

const avail = AvailabilityQuery()
   .networkCode("CO")
   .stationCode("BIRD")
   .startTime("2021-12-27T19:18:54Z")
   .endTime("2021-12-27T19:22:54Z");
avail.query().then(sddList => {
  sddList.forEach(sdd => console.log(sdd))
});

new AvailabilityQuery(host: string?)

Extends FDSNCommon

Parameters

host (string?) optional host to connect to, defaults to IRIS

https://www.fdsn.org/webservices/

Instance Members

▸ specVersion(value?)

Gets/Sets the version of the fdsnws spec, 1 is currently the only value. Setting this is probably a bad idea as the code may not be compatible with the web service.

specVersion(value: string?): AvailabilityQuery

Parameters

value (string?) spec version, usually 1

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getSpecVersion()

getSpecVersion(): string

Returns

string

▸ protocol(value?)

Gets/Sets the protocol, http or https. This should match the protocol of the page loaded, but is autocalculated and generally need not be set.

protocol(value: string?): AvailabilityQuery

Parameters

value (string?) protocol, usually http or https

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getProtocol()

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

Gets/Sets the remote host to connect to.

host(value: string?): AvailabilityQuery

Parameters

value (string?) host

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getHost()

getHost(): string

Returns

string

▸ nodata(value?)

Gets/Sets the nodata parameter, usually 404 or 204 (default), controlling the status code when no matching data is found by the service.

nodata(value: number?): AvailabilityQuery

Parameters

value (number?) number for nodata, usually 404 or 204

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getNodata()

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ port(value?)

Gets/Sets the port, not usually set unless not on standard http or https ports

port(value: number?): AvailabilityQuery

Parameters

value (number?) port

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getPort()

getPort(): number

Returns

number

▸ networkCode(value?)

Gets/Sets the network code to check.

networkCode(value: string?): AvailabilityQuery

Parameters

value (string?) network code like IU

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getNetworkCode()

getNetworkCode(): (string | undefined)

Returns

(string | undefined)

▸ stationCode(value?)

Gets/Sets the station code to check.

stationCode(value: string?): AvailabilityQuery

Parameters

value (string?) station code like ANMO

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getStationCode()

getStationCode(): (string | undefined)

Returns

(string | undefined)

▸ locationCode(value?)

Gets/Sets the location code to check.

locationCode(value: string?): AvailabilityQuery

Parameters

value (string?) location code like 00

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getLocationCode()

getLocationCode(): (string | undefined)

Returns

(string | undefined)

▸ channelCode(value?)

Gets/Sets the channel code to check.

channelCode(value: string?): AvailabilityQuery

Parameters

value (string?) channel code like BHZ

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getChannelCode()

getChannelCode(): (string | undefined)

Returns

(string | undefined)

▸ startTime(value?)

Gets/Sets the start time parameter for the query.

startTime(value: (DateTime | string)?): AvailabilityQuery

Parameters

value ((DateTime | string)?) start time

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getStartTime()

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

Gets/Sets the end time parameter for the query.

endTime(value: (DateTime | string)?): AvailabilityQuery

Parameters

value ((DateTime | string)?) end time

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getEndTime()

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ timeRange(se)

Sets startTime and endTime using the given time window

timeRange(se: Interval): AvailabilityQuery

Parameters

se (Interval) time window

Returns

AvailabilityQuery: the query

▸ quality(value?)

Gets/Sets the quality parameter for the query.

quality(value: string?): AvailabilityQuery

Parameters

value (string?) quality

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getQuality()

getQuality(): (string | undefined)

Returns

(string | undefined)

▸ merge(value?)

Gets/Sets the merge parameter for the query.

merge(value: string?): AvailabilityQuery

Parameters

value (string?) merge

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getMerge()

getMerge(): (string | undefined)

Returns

(string | undefined)

▸ mergeGaps(value?)

Gets/Sets the mergegaps parameter for the query.

mergeGaps(value: number?): AvailabilityQuery

Parameters

value (number?) merge gaps

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getMergeGaps()

getMergeGaps(): (number | undefined)

Returns

(number | undefined)

▸ show(value?)

Gets/Sets the show parameter for the query.

show(value: string?): AvailabilityQuery

Parameters

value (string?) show

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getShow()

getShow(): (string | undefined)

Returns

(string | undefined)

▸ limit(value?)

Gets/Sets the limit parameter for the query.

limit(value: number?): AvailabilityQuery

Parameters

value (number?) limit

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getLimit()

getLimit(): (number | undefined)

Returns

(number | undefined)

▸ orderby(value?)

Gets/Sets the order by parameter for the query.

orderby(value: string?): AvailabilityQuery

Parameters

value (string?) order by

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getOrderBy()

getOrderBy(): (string | undefined)

Returns

(string | undefined)

▸ includeRestricted(value?)

Gets/Sets the include restricted data parameter for the query.

includeRestricted(value: boolean?): AvailabilityQuery

Parameters

value (boolean?) true to include restricted data

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getIncludeRestricted()

getIncludeRestricted(): (boolean | undefined)

Returns

(boolean | undefined)

▸ format(value?)

Gets/Sets the format parameter for the query. Usually not needed as is set by the various query methods.

format(value: string?): AvailabilityQuery

Parameters

value (string?) format

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getFormat()

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ timeout(value?)

Get/Set the timeout in seconds for the request. Default is 30.

timeout(value: number?): AvailabilityQuery

Parameters

value (number?) timeout in seconds

Returns

AvailabilityQuery: the query when setting, the current value when no argument

▸ getTimeout()

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ query()

Calls query on the remote service, using configured parameters. Calls queryJson internally, then unpacks the result into array of SeismogramDisplayData objects.

query(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>: promise to array of SeismogramDisplayData, each representing a channel-time window

▸ queryJson()

Calls the query function the remote server and parses the returned data as json.

queryJson(): Promise<RootType>

Returns

Promise<RootType>: promise to the result as json

▸ extent()

Calls extent on the remote service, using configured parameters. Calls extentJson internally, then unpacks the result into array of SeismogramDisplayData objects.

extent(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>: promise to array of SeismogramDisplayData, each representing a channel-time window

▸ extentJson()

Call the extend function on the remote server and parses the returned data as json.

extentJson(): Promise<RootType>

Returns

Promise<RootType>: promise to the result as json

▸ postQuery(channelTimeList)

Calls query on the remote service using POST, using configured parameters and forms the POST body using the channelTimeList. Calls postQueryJson internally, then unpacks the result into array of SeismogramDisplayData objects.

postQuery(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<SeismogramDisplayData>>

Parameters

channelTimeList (Array<SeismogramDisplayData>) array of channel-time windows for the request

Returns

Promise<Array<SeismogramDisplayData>>: promise to array of SeismogramDisplayData, each representing a channel-time window

▸ postExtent(channelTimeList)

postExtent(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<SeismogramDisplayData>>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Array<SeismogramDisplayData>>

▸ postExtentJson(channelTimeList)

postExtentJson(channelTimeList: Array<SeismogramDisplayData>): Promise<RootType>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<RootType>

▸ postQueryJson(channelTimeList)

postQueryJson(channelTimeList: Array<SeismogramDisplayData>): Promise<RootType>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<RootType>

▸ postJson(channelTimeList, method)

postJson(channelTimeList: Array<SeismogramDisplayData>, method: string): Promise<RootType>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

method (string)

Returns

Promise<RootType>

▸ postRaw(channelTimeList, method)

postRaw(channelTimeList: Array<SeismogramDisplayData>, method: string): Promise<Response>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

method (string)

Returns

Promise<Response>

▸ extractFromJson(jsonChanTimes)

extractFromJson(jsonChanTimes: RootType): Array<SeismogramDisplayData>

Parameters

jsonChanTimes (RootType)

Returns

Array<SeismogramDisplayData>

▸ createPostBody(channelTimeList)

createPostBody(channelTimeList: Array<SeismogramDisplayData>): string

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

string

▸ formBaseURL()

formBaseURL(): string

Returns

string

▸ formVersionURL()

formVersionURL(): string

Returns

string

▸ queryVersion()

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ makePostParm(name, val)

makePostParm(name: string, val: any): string

Parameters

name (string)

val (any)

Returns

string

▸ formURL(method?)

formURL(method: string?): string

Parameters

method (string?)

Returns

string

RootType

Root type of availablility json query.

RootType

Type: any

FdsnDateTime

Type: string

Datasource

Type: any

isValidRootType

isValidRootType(jsonValue: any): any

Parameters

jsonValue (any)

Returns

any

isValidDatasource

isValidDatasource(jsonValue: any): any

Parameters

jsonValue (any)

Returns

any