seisplotjs-fdsnstation 1.1.1

seisplotjs-fdsnstation

1.1.1

Usage
Core Functionality
StationQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #nodata
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #startTime
- #endTime
- #startBefore
- #endBefore
- #startAfter
- #endAfter
- #minLat
- #maxLat
- #minLon
- #maxLon
- #latitude
- #longitude
- #minRadius
- #maxRadius
- #includeRestricted
- #includeAvailability
- #format
- #updatedAfter
- #matchTimeseries
- #convertToNetwork
- #convertToStation
- #convertToChannel
- #convertToResponse
- #convertToInstrumentSensitivity
- #convertToStage
- #convertToDecimation
- #convertToGain
- #queryNetworks
- #queryStations
- #queryChannels
- #queryResponse
- #query
- #parseRawXml
- #queryRawXml
- #formVersionURL
- #queryVersion
- #makeParam
- #formBaseURL
- #formURL
Core Classes and Constants
IRIS_HOST
LEVEL_NETWORK
LEVEL_STATION
LEVEL_CHANNEL
LEVEL_RESPONSE
LEVELS
STAML_NS
Re-export
moment
model
RSVP
Other
FAKE_EMPTY_XML

Usage

Generally either

import * as fdsnstation from 'seisplotjs-fdsnstation'
fdsnstation.xxxx

import * as seisplotjs from 'seisplotjs'
seisplotjs.fdsnstation.xxxx

Core Functionality

Core functions for using the IRIS FDSN Station web service

StationQuery

src/fdsnstation.js

new StationQuery(host: string)

Parameters

host (string)

Instance Members

▸ specVersion(value)

src/fdsnstation.js

specVersion(value: number): (number | StationQuery)

Parameters

value (number)

Returns

(number | StationQuery)

▸ protocol(value)

src/fdsnstation.js

protocol(value: string): (string | StationQuery)

Parameters

value (string)

Returns

(string | StationQuery)

▸ host(value)

src/fdsnstation.js

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

Parameters

value (string)

Returns

(string | StationQuery)

▸ nodata(value)

src/fdsnstation.js

nodata(value: number): (number | StationQuery)

Parameters

value (number)

Returns

(number | StationQuery)

▸ networkCode(value)

src/fdsnstation.js

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

Parameters

value (string)

Returns

(string | StationQuery)

▸ stationCode(value)

src/fdsnstation.js

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

Parameters

value (string)

Returns

(string | StationQuery)

▸ locationCode(value)

src/fdsnstation.js

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

Parameters

value (string)

Returns

(string | StationQuery)

▸ channelCode(value)

src/fdsnstation.js

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

Parameters

value (string)

Returns

(string | StationQuery)

▸ startTime(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ endTime(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ startBefore(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ endBefore(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ startAfter(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ endAfter(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ minLat(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ maxLat(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ minLon(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ maxLon(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ latitude(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ longitude(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ minRadius(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ maxRadius(value)

src/fdsnstation.js

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

Parameters

value (number)

Returns

(number | StationQuery)

▸ includeRestricted(value)

src/fdsnstation.js

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

Parameters

value (boolean)

Returns

(boolean | StationQuery)

▸ includeAvailability(value)

src/fdsnstation.js

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

Parameters

value (boolean)

Returns

(boolean | StationQuery)

▸ format(value)

src/fdsnstation.js

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

Parameters

value (string)

Returns

(string | StationQuery)

▸ updatedAfter(value)

src/fdsnstation.js

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

Parameters

value (moment)

Returns

(moment | StationQuery)

▸ matchTimeseries(value)

src/fdsnstation.js

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

Parameters

value (boolean)

Returns

(boolean | StationQuery)

▸ convertToNetwork(xml)

src/fdsnstation.js

convertToNetwork(xml: Element): model.Network

Parameters

xml (Element)

Returns

model.Network

▸ convertToStation(network, xml)

src/fdsnstation.js

convertToStation(network: model.Network, xml: Element): model.Station

Parameters

network (model.Network)

xml (Element)

Returns

model.Station

▸ convertToChannel(station, xml)

src/fdsnstation.js

convertToChannel(station: model.Station, xml: Element): model.Channel

Parameters

station (model.Station)

xml (Element)

Returns

model.Channel

▸ convertToResponse(responseXml)

src/fdsnstation.js

convertToResponse(responseXml: Element): model.Response

Parameters

responseXml (Element)

Returns

model.Response

▸ convertToInstrumentSensitivity(xml)

src/fdsnstation.js

convertToInstrumentSensitivity(xml: Element): model.InstrumentSensitivity

Parameters

xml (Element)

Returns

model.InstrumentSensitivity

▸ convertToStage(stageXml)

src/fdsnstation.js

convertToStage(stageXml: Element): model.Stage

Parameters

stageXml (Element)

Returns

model.Stage

▸ convertToDecimation(decXml)

src/fdsnstation.js

convertToDecimation(decXml: Element): model.Decimation

Parameters

decXml (Element)

Returns

model.Decimation

▸ convertToGain(gainXml)

src/fdsnstation.js

convertToGain(gainXml: Element): model.Gain

Parameters

gainXml (Element)

Returns

model.Gain

▸ queryNetworks()

src/fdsnstation.js

queryNetworks(): Promise<Array<model.Network>>

Returns

Promise<Array<model.Network>>

▸ queryStations()

src/fdsnstation.js

queryStations(): Promise<Array<model.Network>>

Returns

Promise<Array<model.Network>>

▸ queryChannels()

src/fdsnstation.js

queryChannels(): Promise<Array<model.Network>>

Returns

Promise<Array<model.Network>>

▸ queryResponse()

src/fdsnstation.js

queryResponse(): Promise<Array<model.Network>>

Returns

Promise<Array<model.Network>>

▸ query(level)

src/fdsnstation.js

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

Parameters

level (string)

Returns

Promise<Array<model.Network>>

▸ parseRawXml(rawXml)

src/fdsnstation.js

parseRawXml(rawXml: Document): Array<model.Network>

Parameters

rawXml (Document)

Returns

Array<model.Network>

▸ queryRawXml(level)

src/fdsnstation.js

queryRawXml(level: string): Promise<Document>

Parameters

level (string)

Returns

Promise<Document>

▸ formVersionURL()

src/fdsnstation.js

formVersionURL()

▸ queryVersion()

src/fdsnstation.js

queryVersion()

▸ makeParam(name, val)

src/fdsnstation.js

makeParam(name: string, val: any)

Parameters

name (string)

val (any)

▸ formBaseURL()

src/fdsnstation.js

formBaseURL()

▸ formURL(level)

src/fdsnstation.js

formURL(level: string)

Parameters

level (string)

Core Classes and Constants

Core classes returned from the above functions.

IRIS_HOST

src/fdsnstation.js

IRIS_HOST

Type: string

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

STAML_NS

src/fdsnstation.js

STAML_NS

Type: string

Re-export

Re-exporting imported modules for easier reuse.

moment

src/fdsnstation.js

moment

model

src/fdsnstation.js

model

RSVP

src/fdsnstation.js

RSVP

Other

Stuff I forgot to put in the TOC.

FAKE_EMPTY_XML

src/fdsnstation.js

FAKE_EMPTY_XML

Type: string