seisplotjs 3.1.3 | Documentation

▸ 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?): DataSelectQuery

Parameters

value (string?) spec version, usually 1

Returns

DataSelectQuery: new value if getting, this if setting

▸ getSpecVersion()

src/fdsndataselect.ts

getSpecVersion(): string

Returns

string

▸ protocol(value?)

src/fdsndataselect.ts

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?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getProtocol()

src/fdsndataselect.ts

getProtocol(): string

Returns

string

▸ host(value?)

src/fdsndataselect.ts

Gets/Sets the remote host to connect to.

host(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getHost()

src/fdsndataselect.ts

getHost(): string

Returns

string

▸ nodata(value?)

src/fdsndataselect.ts

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?): DataSelectQuery

Parameters

value (number?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getNodata()

src/fdsndataselect.ts

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ port(value?)

src/fdsndataselect.ts

Gets/Sets the remote port to connect to.

port(value: number?): DataSelectQuery

Parameters

value (number?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getPort()

src/fdsndataselect.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ networkCode(value?)

src/fdsndataselect.ts

Get/Set the network query parameter.

networkCode(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getNetworkCode()

src/fdsndataselect.ts

getNetworkCode(): (string | undefined)

Returns

(string | undefined)

▸ stationCode(value?)

src/fdsndataselect.ts

Get/Set the station query parameter.

stationCode(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getStationCode()

src/fdsndataselect.ts

getStationCode(): (string | undefined)

Returns

(string | undefined)

▸ locationCode(value?)

src/fdsndataselect.ts

Get/Set the location code query parameter.

locationCode(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getLocationCode()

src/fdsndataselect.ts

getLocationCode(): (string | undefined)

Returns

(string | undefined)

▸ channelCode(value?)

src/fdsndataselect.ts

Get/Set the channel query parameter.

channelCode(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getChannelCode()

src/fdsndataselect.ts

getChannelCode(): (string | undefined)

Returns

(string | undefined)

▸ nslcCodes(channelId)

src/fdsndataselect.ts

nslcCodes(channelId: NslcId): DataSelectQuery

Parameters

channelId (NslcId)

Returns

DataSelectQuery

▸ startTime(value?)

src/fdsndataselect.ts

Get/Set the starttime query parameter.

startTime(value: DateTime?): DataSelectQuery

Parameters

value (DateTime?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getStartTime()

src/fdsndataselect.ts

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

src/fdsndataselect.ts

Get/Set the endtime query parameter.

endTime(value: DateTime?): DataSelectQuery

Parameters

value (DateTime?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getEndTime()

src/fdsndataselect.ts

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ timeRange(se)

src/fdsndataselect.ts

Sets startTime and endTime using the given time range

timeRange(se: Interval): DataSelectQuery

Parameters

se (Interval) time range

Returns

DataSelectQuery: this

▸ quality(value?)

src/fdsndataselect.ts

Get/Set the quality query parameter.

quality(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getQuality()

src/fdsndataselect.ts

getQuality(): (string | undefined)

Returns

(string | undefined)

▸ minimumLength(value?)

src/fdsndataselect.ts

Get/Set the minimum length query parameter.

minimumLength(value: number?): DataSelectQuery

Parameters

value (number?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getMinimumLength()

src/fdsndataselect.ts

getMinimumLength(): (number | undefined)

Returns

(number | undefined)

▸ longestOnly(value?)

src/fdsndataselect.ts

Get/Set the longest only query parameter.

longestOnly(value: boolean?): DataSelectQuery

Parameters

value (boolean?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getLongestOnly()

src/fdsndataselect.ts

getLongestOnly(): (boolean | undefined)

Returns

(boolean | undefined)

▸ repository(value?)

src/fdsndataselect.ts

set or get the repository paramter. This is an IRIS-specific parameter that will not work with other dataselect web services.

repository(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getRepository()

src/fdsndataselect.ts

getRepository(): (string | undefined)

Returns

(string | undefined)

▸ format(value?)

src/fdsndataselect.ts

Get/Set the format query parameter.

format(value: string?): DataSelectQuery

Parameters

value (string?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getFormat()

src/fdsndataselect.ts

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ timeout(value?)

src/fdsndataselect.ts

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

timeout(value: number?): DataSelectQuery

Parameters

value (number?) optional new value if setting

Returns

DataSelectQuery: new value if getting, this if setting

▸ getTimeout()

src/fdsndataselect.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ queryDataRecords()

src/fdsndataselect.ts

queries the web service using the configured parameters, parsing the response into miniseed data records.

queryDataRecords(): Promise<Array<miniseed.DataRecord>>

Returns

Promise<Array<miniseed.DataRecord>>: Promise to Array of miniseed.DataRecords

▸ queryMS3Records()

src/fdsndataselect.ts

queries the web service using the configured parameters, parsing the response into miniseed data records.

queryMS3Records(): Promise<Array<mseed3.MSeed3Record>>

Returns

Promise<Array<mseed3.MSeed3Record>>: Promise to Array of miniseed.DataRecords

▸ querySeismograms()

src/fdsndataselect.ts

queries the web service using the configured parameters, parsing the response into miniseed data records and then combining the data records into Seismogram objects.

querySeismograms(): Promise<Array<Seismogram>>

Returns

Promise<Array<Seismogram>>: Promise to Array of Seismogram objects

▸ postQueryDataRecords(channelTimeList)

src/fdsndataselect.ts

postQueryDataRecords(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<miniseed.DataRecord>>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Array<miniseed.DataRecord>>

▸ postQueryMS3Records(channelTimeList)

src/fdsndataselect.ts

postQueryMS3Records(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<mseed3.MSeed3Record>>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Array<mseed3.MSeed3Record>>

▸ postQuerySeismograms(sddList)

src/fdsndataselect.ts

query the dataselect server using post, which allows for multiple channel-timeranges at once. This assumes that there are not multiple time ranges for the same channel as the results, encapsulated as SeismogramDisplayData objects, are returned one seismogram per channel, which may contain gaps. The original channel and timerange are also populated with each result.

postQuerySeismograms(sddList: Array<SeismogramDisplayData>): Promise<Array<SeismogramDisplayData>>

Parameters

sddList (Array<SeismogramDisplayData>) array of SeismogramDisplayData objects that will be filled in with the resulting seismogram

Returns

Promise<Array<SeismogramDisplayData>>: Promise to the input Array of SeismogramDisplayData objects, each with the seismogram containing the data returned from the server

▸ postQueryRaw(sddList)

src/fdsndataselect.ts

postQueryRaw(sddList: Array<SeismogramDisplayData>): Promise<Response>

Parameters

sddList (Array<SeismogramDisplayData>)

Returns

Promise<Response>

▸ postQueryRawWithBody(body)

src/fdsndataselect.ts

postQueryRawWithBody(body: string): Promise<Response>

Parameters

body (string)

Returns

Promise<Response>

▸ formBaseURL()

src/fdsndataselect.ts

formBaseURL(): string

Returns

string

▸ formVersionURL()

src/fdsndataselect.ts

formVersionURL(): string

Returns

string

▸ queryVersion()

src/fdsndataselect.ts

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formPostURL()

src/fdsndataselect.ts

formPostURL(): string

Returns

string

▸ formURL()

src/fdsndataselect.ts

formURL(): string

Returns

string

seisplotjs

IRIS_HOST

FORMAT_MINISEED

FORMAT_MINISEED_THREE

SERVICE_VERSION

SERVICE_NAME

DataSelectQuery

createDataSelectQuery