seisplotjs 3.1.4 | Documentation

seisplotjs

3.1.4

IRIS_HOST
LEVEL_NETWORK
LEVEL_STATION
LEVEL_CHANNEL
LEVEL_RESPONSE
LEVELS
SERVICE_VERSION
SERVICE_NAME
StationQuery ▸
- Instance members
- #specVersion
- #getSpecVersion
- #protocol
- #getProtocol
- #host
- #getHost
- #port
- #getPort
- #nodata
- #getNodata
- #networkCode
- #getNetworkCode
- #stationCode
- #getStationCode
- #locationCode
- #getLocationCode
- #channelCode
- #getChannelCode
- #startTime
- #getStartTime
- #endTime
- #getEndTime
- #timeRange
- #startBefore
- #getStartBefore
- #endBefore
- #getEndBefore
- #startAfter
- #getStartAfter
- #endAfter
- #getEndAfter
- #minLat
- #getMinLat
- #maxLat
- #getMaxLat
- #minLon
- #getMinLon
- #maxLon
- #getMaxLon
- #latitude
- #getLatitude
- #longitude
- #getLongitude
- #minRadius
- #getMinRadius
- #maxRadius
- #getMaxRadius
- #includeRestricted
- #getIncludeRestricted
- #includeAvailability
- #getIncludeAvailability
- #format
- #getFormat
- #updatedAfter
- #getUpdatedAfter
- #matchTimeseries
- #getMatchTimeseries
- #latLonRegion
- #nslcCodes
- #timeout
- #getTimeout
- #isSomeParameterSet
- #queryNetworks
- #queryStations
- #queryChannels
- #queryResponses
- #query
- #postQueryNetworks
- #postQueryStations
- #postQueryChannels
- #postQueryResponses
- #postQuery
- #queryRawXml
- #queryRawXmlText
- #postQueryRawXml
- #createPostBody
- #formVersionURL
- #queryVersion
- #formBaseURL
- #formPostURL
- #formURL

Need help reading this?

IRIS_HOST

src/fdsnstation.ts

IRIS_HOST

LEVEL_NETWORK

src/fdsnstation.ts

LEVEL_NETWORK

Type: string

LEVEL_STATION

src/fdsnstation.ts

LEVEL_STATION

Type: string

LEVEL_CHANNEL

src/fdsnstation.ts

LEVEL_CHANNEL

Type: string

LEVEL_RESPONSE

src/fdsnstation.ts

LEVEL_RESPONSE

Type: string

LEVELS

src/fdsnstation.ts

LEVELS

SERVICE_VERSION

src/fdsnstation.ts

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

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsnstation.ts

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

SERVICE_NAME

StationQuery

src/fdsnstation.ts

Query to a FDSN Station web service.

new StationQuery(host: string?)

Extends FDSNCommon

Parameters

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

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

Instance Members

▸ specVersion(value?)

src/fdsnstation.ts

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

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getSpecVersion()

src/fdsnstation.ts

getSpecVersion(): string

Returns

string

▸ protocol(value?)

src/fdsnstation.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?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getProtocol()

src/fdsnstation.ts

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

src/fdsnstation.ts

Gets/Sets the remote host to connect to.

host(value: string?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getHost()

src/fdsnstation.ts

getHost(): (string | undefined)

Returns

(string | undefined)

▸ port(value?)

src/fdsnstation.ts

Gets/Sets the remote port to connect to.

port(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getPort()

src/fdsnstation.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ nodata(value?)

src/fdsnstation.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?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getNodata()

src/fdsnstation.ts

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ networkCode(value?)

src/fdsnstation.ts

Get/Set the network query parameter.

networkCode(value: string?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getNetworkCode()

src/fdsnstation.ts

getNetworkCode(): (string | undefined)

Returns

(string | undefined)

▸ stationCode(value?)

src/fdsnstation.ts

Get/Set the station query parameter.

stationCode(value: string?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getStationCode()

src/fdsnstation.ts

getStationCode(): (string | undefined)

Returns

(string | undefined)

▸ locationCode(value?)

src/fdsnstation.ts

Get/Set the location code query parameter.

locationCode(value: string?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getLocationCode()

src/fdsnstation.ts

getLocationCode(): (string | undefined)

Returns

(string | undefined)

▸ channelCode(value?)

src/fdsnstation.ts

Get/Set the channel query parameter.

channelCode(value: string?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getChannelCode()

src/fdsnstation.ts

getChannelCode(): (string | undefined)

Returns

(string | undefined)

▸ startTime(value?)

src/fdsnstation.ts

Get/Set the starttime query parameter.

startTime(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getStartTime()

src/fdsnstation.ts

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

src/fdsnstation.ts

Get/Set the endtime query parameter.

endTime(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getEndTime()

src/fdsnstation.ts

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ timeRange(se)

src/fdsnstation.ts

Sets startTime and endTime using the given time window

timeRange(se: Interval): StationQuery

Parameters

se (Interval) time window

Returns

StationQuery: this

▸ startBefore(value?)

src/fdsnstation.ts

Get/Set the startbefore query parameter.

startBefore(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getStartBefore()

src/fdsnstation.ts

getStartBefore(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endBefore(value?)

src/fdsnstation.ts

Get/Set the endbefore query parameter.

endBefore(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getEndBefore()

src/fdsnstation.ts

getEndBefore(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ startAfter(value?)

src/fdsnstation.ts

Get/Set the startafter query parameter.

startAfter(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getStartAfter()

src/fdsnstation.ts

getStartAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endAfter(value?)

src/fdsnstation.ts

Get/Set the endafter query parameter.

endAfter(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getEndAfter()

src/fdsnstation.ts

getEndAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ minLat(value?)

src/fdsnstation.ts

Get/Set the minlat query parameter.

minLat(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMinLat()

src/fdsnstation.ts

getMinLat(): (number | undefined)

Returns

(number | undefined)

▸ maxLat(value?)

src/fdsnstation.ts

Get/Set the maxlon query parameter.

maxLat(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMaxLat()

src/fdsnstation.ts

getMaxLat(): (number | undefined)

Returns

(number | undefined)

▸ minLon(value?)

src/fdsnstation.ts

Get/Set the minlon query parameter.

minLon(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMinLon()

src/fdsnstation.ts

getMinLon(): (number | undefined)

Returns

(number | undefined)

▸ maxLon(value?)

src/fdsnstation.ts

Get/Set the maxlon query parameter.

maxLon(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMaxLon()

src/fdsnstation.ts

getMaxLon(): (number | undefined)

Returns

(number | undefined)

▸ latitude(value?)

src/fdsnstation.ts

Get/Set the latitude query parameter.

latitude(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getLatitude()

src/fdsnstation.ts

getLatitude(): (number | undefined)

Returns

(number | undefined)

▸ longitude(value?)

src/fdsnstation.ts

Get/Set the longitude query parameter.

longitude(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getLongitude()

src/fdsnstation.ts

getLongitude(): (number | undefined)

Returns

(number | undefined)

▸ minRadius(value?)

src/fdsnstation.ts

Get/Set the minradius query parameter.

minRadius(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMinRadius()

src/fdsnstation.ts

getMinRadius(): (number | undefined)

Returns

(number | undefined)

▸ maxRadius(value?)

src/fdsnstation.ts

Get/Set the maxradius query parameter.

maxRadius(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMaxRadius()

src/fdsnstation.ts

getMaxRadius(): (number | undefined)

Returns

(number | undefined)

▸ includeRestricted(value?)

src/fdsnstation.ts

Get/Set the includerestricted query parameter.

includeRestricted(value: boolean?): StationQuery

Parameters

value (boolean?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getIncludeRestricted()

src/fdsnstation.ts

getIncludeRestricted(): (boolean | undefined)

Returns

(boolean | undefined)

▸ includeAvailability(value?)

src/fdsnstation.ts

Get/Set the includeavailability query parameter.

includeAvailability(value: boolean?): StationQuery

Parameters

value (boolean?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getIncludeAvailability()

src/fdsnstation.ts

getIncludeAvailability(): (boolean | undefined)

Returns

(boolean | undefined)

▸ format(value?)

src/fdsnstation.ts

Get/Set the format query parameter.

format(value: string?): StationQuery

Parameters

value (string?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getFormat()

src/fdsnstation.ts

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ updatedAfter(value?)

src/fdsnstation.ts

Get/Set the updatedafter query parameter.

updatedAfter(value: DateTime?): StationQuery

Parameters

value (DateTime?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getUpdatedAfter()

src/fdsnstation.ts

getUpdatedAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ matchTimeseries(value?)

src/fdsnstation.ts

Get/Set the matchtimeseries query parameter.

matchTimeseries(value: boolean?): StationQuery

Parameters

value (boolean?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getMatchTimeseries()

src/fdsnstation.ts

getMatchTimeseries(): (boolean | undefined)

Returns

(boolean | undefined)

▸ latLonRegion(value)

src/fdsnstation.ts

latLonRegion(value: (LatLonRegion | null)): StationQuery

Parameters

value ((LatLonRegion | null))

Returns

StationQuery

▸ nslcCodes(channelId)

src/fdsnstation.ts

nslcCodes(channelId: NslcId): StationQuery

Parameters

channelId (NslcId)

Returns

StationQuery

▸ timeout(value?)

src/fdsnstation.ts

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

timeout(value: number?): StationQuery

Parameters

value (number?) optional new value if setting

Returns

StationQuery: new value if getting, this if setting

▸ getTimeout()

src/fdsnstation.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ isSomeParameterSet()

src/fdsnstation.ts

Checks to see if any parameter that would limit the data returned is set. This is a crude, coarse check to make sure the client doesn't ask for EVERYTHING the server has.

isSomeParameterSet(): boolean

Returns

boolean: true if some parameter set

▸ queryNetworks()

src/fdsnstation.ts

Queries the remote web service for networks.

queryNetworks(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryStations()

src/fdsnstation.ts

Queries the remote web service for stations. The stations are contained within their respective Networks.

queryStations(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryChannels()

src/fdsnstation.ts

Queries the remote web service for channels. The Channels are contained within their respective Stations which are in Networks.

queryChannels(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryResponses()

src/fdsnstation.ts

Queries the remote web service for responses. The Responses are contained within their respective Channels, which are in Stations which are in Networks.

queryResponses(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ query(level)

src/fdsnstation.ts

Queries the remote web service at the given level.

query(level: string): Promise<Array<Network>>

Parameters

level (string) the level to query at, networ, station, channel or response.

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ postQueryNetworks(postLines)

src/fdsnstation.ts

Execute POST request for networks, using params defined in this, and with channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

postQueryNetworks(postLines: Array<string>): Promise<Array<Network>>

Parameters

postLines (Array<string>) array of channel selection lines

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ postQueryStations(postLines)

src/fdsnstation.ts

Execute POST request for stations, using params defined in this, and with channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

postQueryStations(postLines: Array<string>): Promise<Array<Network>>

Parameters

postLines (Array<string>) array of channel selection lines

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ postQueryChannels(postLines)

src/fdsnstation.ts

Execute POST request for channels, using params defined in this, and with channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

postQueryChannels(postLines: Array<string>): Promise<Array<Network>>

Parameters

postLines (Array<string>) array of channel selection lines

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ postQueryResponses(postLines)

src/fdsnstation.ts

Execute POST request for responses, using params defined in this, and with channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

postQueryResponses(postLines: Array<string>): Promise<Array<Network>>

Parameters

postLines (Array<string>) array of channel selection lines

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ postQuery(level, postLines)

src/fdsnstation.ts

Execute POST request using params defined in this, for given level, and with channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

postQuery(level: string, postLines: Array<string>): Promise<Array<Network>>

Parameters

level (string) level to request, one of network, station, channel, response

postLines (Array<string>) array of channel selection lines

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryRawXml(level)

src/fdsnstation.ts

Queries the remote web service at the given level for raw xml. Note that in the case of a nodata status code, xml that represents a valid stationxml but with zero <Network> elements will be returned as this simplifies parsing.

queryRawXml(level: string): Promise<Document>

Parameters

level (string) the level to query at, network, station, channel or response.

Returns

Promise<Document>: a Promise to an xml Document.

▸ queryRawXmlText(level)

src/fdsnstation.ts

Queries the remote web service at the given level for unparsed xml as text. Note that in the case of a nodata status code, text that represents a valid stationxml but with zero <Network> elements will be returned as this simplifies parsing.

queryRawXmlText(level: string): Promise<string>

Parameters

level (string) the level to query at, network, station, channel or response.

Returns

Promise<string>: a Promise to string.

▸ postQueryRawXml(level, postLines)

src/fdsnstation.ts

Execute POST request using params defined in this, for given level, and with channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

postQueryRawXml(level: string, postLines: Array<string>): Promise<Document>

Parameters

level (string) level to request, one of network, station, channel, response

postLines (Array<string>) array of channel selection lines

Returns

Promise<Document>: string suitable for POST to fdsn station web service.

▸ createPostBody(level, postLines)

src/fdsnstation.ts

Creates post body using params defined in this, for given level, and with optional channel lines of the form:

NET STA LOC CHA STARTTIME ENDTIME

Note that empty LOC should be encoded as dash-dash

createPostBody(level: string, postLines: Array<string>): string

Parameters

level (string) level to request, one of network, station, channel, response

postLines

(Array<string>
            = [])

optional array of channel selection lines

Returns

string: string suitable for POST to fdsn station web service.

▸ formVersionURL()

src/fdsnstation.ts

Forms the URL to get version from the web service, without any query paramters

formVersionURL(): string

Returns

string: the url

▸ queryVersion()

src/fdsnstation.ts

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formBaseURL()

src/fdsnstation.ts

Forms the basic URL to contact the web service, without any query paramters

formBaseURL(): string

Returns

string: the url

▸ formPostURL()

src/fdsnstation.ts

formPostURL(): string

Returns

string

▸ formURL(level)

src/fdsnstation.ts

Form URL to query the remote web service, encoding the query parameters.

formURL(level: string): string

Parameters

level (string) network, station, channel or response

Returns

string: url