seisplotjs.fdsnstation 2.0.0

seisplotjs.fdsnstation

2.0.0

LEVEL_NETWORK
LEVEL_STATION
LEVEL_CHANNEL
LEVEL_RESPONSE
LEVELS
SERVICE_VERSION
SERVICE_NAME
IRIS_HOST
FAKE_EMPTY_XML
StationQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #port
- #nodata
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #startTime
- #endTime
- #timeWindow
- #startBefore
- #endBefore
- #startAfter
- #endAfter
- #minLat
- #maxLat
- #minLon
- #maxLon
- #latitude
- #longitude
- #minRadius
- #maxRadius
- #includeRestricted
- #includeAvailability
- #format
- #updatedAfter
- #matchTimeseries
- #timeout
- #isSomeParameterSet
- #queryNetworks
- #queryStations
- #queryChannels
- #queryResponses
- #query
- #queryRawXml
- #formVersionURL
- #queryVersion
- #formBaseURL
- #formURL

Need help reading this?

LEVEL_NETWORK

src/fdsnstation.js

LEVEL_NETWORK

Type: string

LEVEL_STATION

src/fdsnstation.js

LEVEL_STATION

Type: string

LEVEL_CHANNEL

src/fdsnstation.js

LEVEL_CHANNEL

Type: string

LEVEL_RESPONSE

src/fdsnstation.js

LEVEL_RESPONSE

Type: string

LEVELS

src/fdsnstation.js

LEVELS

SERVICE_VERSION

src/fdsnstation.js

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

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsnstation.js

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

SERVICE_NAME

IRIS_HOST

src/fdsnstation.js

IRIS_HOST

Type: string

FAKE_EMPTY_XML

src/fdsnstation.js

a fake, completely empty stationxml document in case of no data.

FAKE_EMPTY_XML

Type: string

StationQuery

src/fdsnstation.js

Query to a FDSN Station web service.

new StationQuery(host: string?)

Parameters

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

Instance Members

▸ specVersion(value?)

src/fdsnstation.js

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

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ protocol(value?)

src/fdsnstation.js

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

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ host(value?)

src/fdsnstation.js

Gets/Sets the remote host to connect to.

host(value: string?): (string | StationQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ port(value?)

src/fdsnstation.js

Gets/Sets the remote port to connect to.

port(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ nodata(value?)

src/fdsnstation.js

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

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ networkCode(value?)

src/fdsnstation.js

Get/Set the network query parameter.

networkCode(value: string?): (string | StationQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ stationCode(value?)

src/fdsnstation.js

Get/Set the station query parameter.

stationCode(value: string?): (string | StationQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ locationCode(value?)

src/fdsnstation.js

Get/Set the location code query parameter.

locationCode(value: string?): (string | StationQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ channelCode(value?)

src/fdsnstation.js

Get/Set the channel query parameter.

channelCode(value: string?): (string | StationQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ startTime(value?)

src/fdsnstation.js

Get/Set the starttime query parameter.

startTime(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ endTime(value?)

src/fdsnstation.js

Get/Set the endtime query parameter.

endTime(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ timeWindow(se)

src/fdsnstation.js

Sets startTime and endTime using the given time window

timeWindow(se: StartEndDuration): any

Parameters

se (StartEndDuration) time window

Returns

any: this

▸ startBefore(value?)

src/fdsnstation.js

Get/Set the startbefore query parameter.

startBefore(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ endBefore(value?)

src/fdsnstation.js

Get/Set the endbefore query parameter.

endBefore(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ startAfter(value?)

src/fdsnstation.js

Get/Set the startafter query parameter.

startAfter(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ endAfter(value?)

src/fdsnstation.js

Get/Set the endafter query parameter.

endAfter(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ minLat(value?)

src/fdsnstation.js

Get/Set the minlat query parameter.

minLat(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ maxLat(value?)

src/fdsnstation.js

Get/Set the maxlon query parameter.

maxLat(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ minLon(value?)

src/fdsnstation.js

Get/Set the minlon query parameter.

minLon(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ maxLon(value?)

src/fdsnstation.js

Get/Set the maxlon query parameter.

maxLon(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ latitude(value?)

src/fdsnstation.js

Get/Set the latitude query parameter.

latitude(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ longitude(value?)

src/fdsnstation.js

Get/Set the longitude query parameter.

longitude(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ minRadius(value?)

src/fdsnstation.js

Get/Set the minradius query parameter.

minRadius(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ maxRadius(value?)

src/fdsnstation.js

Get/Set the maxradius query parameter.

maxRadius(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ includeRestricted(value?)

src/fdsnstation.js

Get/Set the includerestricted query parameter.

includeRestricted(value: boolean?): (boolean | StationQuery)

Parameters

value (boolean?) optional new value if setting

Returns

(boolean | StationQuery): new value if getting, this if setting

▸ includeAvailability(value?)

src/fdsnstation.js

Get/Set the includeavailability query parameter.

includeAvailability(value: boolean?): (boolean | StationQuery)

Parameters

value (boolean?) optional new value if setting

Returns

(boolean | StationQuery): new value if getting, this if setting

▸ format(value?)

src/fdsnstation.js

Get/Set the format query parameter.

format(value: string?): (string | StationQuery)

Parameters

value (string?) optional new value if setting

Returns

(string | StationQuery): new value if getting, this if setting

▸ updatedAfter(value?)

src/fdsnstation.js

Get/Set the updatedafter query parameter.

updatedAfter(value: moment?): (moment | StationQuery)

Parameters

value (moment?) optional new value if setting

Returns

(moment | StationQuery): new value if getting, this if setting

▸ matchTimeseries(value?)

src/fdsnstation.js

Get/Set the matchtimeseries query parameter.

matchTimeseries(value: boolean?): (boolean | StationQuery)

Parameters

value (boolean?) optional new value if setting

Returns

(boolean | StationQuery): new value if getting, this if setting

▸ timeout(value?)

src/fdsnstation.js

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

timeout(value: number?): (number | StationQuery)

Parameters

value (number?) optional new value if setting

Returns

(number | StationQuery): new value if getting, this if setting

▸ isSomeParameterSet()

src/fdsnstation.js

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.js

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.js

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.js

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.js

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.js

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.

▸ queryRawXml(level)

src/fdsnstation.js

Queries the remote web service at the given level for raw xml.

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.

▸ formVersionURL()

src/fdsnstation.js

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

formVersionURL(): any

Returns

any: the url

▸ queryVersion()

src/fdsnstation.js

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formBaseURL()

src/fdsnstation.js

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

formBaseURL(): any

Returns

any: the url

▸ formURL(level)

src/fdsnstation.js

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

formURL(level: string): any

Parameters

level (string) network, station, channel or response

Returns

any: url