seisplotjs.fdsnevent 2.0.0-alpha.4

seisplotjs.fdsnevent

2.0.0-alpha.4

SERVICE_VERSION
SERVICE_NAME
QML_NS
BED_NS
IRIS_NS
ANSS_NS
ANSS_CATALOG_NS
USGS_HOST
FAKE_EMPTY_XML
EventQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #port
- #nodata
- #eventId
- #startTime
- #endTime
- #timeWindow
- #updatedAfter
- #minMag
- #maxMag
- #magnitudeType
- #minDepth
- #maxDepth
- #minLat
- #maxLat
- #minLon
- #maxLon
- #latitude
- #longitude
- #minRadius
- #maxRadius
- #includearrivals
- #includeArrivals
- #includeAllOrigins
- #includeAllMagnitudes
- #format
- #limit
- #offset
- #orderBy
- #catalog
- #contributor
- #timeout
- #isSomeParameterSet
- #convertToQuake
- #extractEventId
- #convertToOrigin
- #convertToMagnitude
- #convertToArrival
- #convertToPick
- #query
- #parseQuakeML
- #queryRawXml
- #formBaseURL
- #formCatalogsURL
- #queryCatalogs
- #formContributorsURL
- #queryContributors
- #formVersionURL
- #queryVersion
- #makeParam
- #formURL
util ▸
- Static members
- ._grabFirstEl
- ._grabFirstElNS
- ._grabFirstElText
- ._grabFirstElFloat
- ._grabFirstElInt
- ._grabAttribute
- ._grabAttributeNS

Need help reading this?

SERVICE_VERSION

src/fdsnevent.js

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

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsnevent.js

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

SERVICE_NAME

QML_NS

src/fdsnevent.js

QML_NS

BED_NS

src/fdsnevent.js

BED_NS

IRIS_NS

src/fdsnevent.js

IRIS_NS

ANSS_NS

src/fdsnevent.js

ANSS_NS

ANSS_CATALOG_NS

src/fdsnevent.js

ANSS_CATALOG_NS

USGS_HOST

src/fdsnevent.js

USGS_HOST

FAKE_EMPTY_XML

src/fdsnevent.js

FAKE_EMPTY_XML

Type: string

EventQuery

src/fdsnevent.js

Query to a FDSN Event web service.

new EventQuery(host: string?)

Parameters

host (string?)

Instance Members

▸ specVersion(value?)

src/fdsnevent.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 | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ protocol(value?)

src/fdsnevent.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 | EventQuery)

Parameters

value (string?)

Returns

(string | EventQuery)

▸ host(value?)

src/fdsnevent.js

Gets/Sets the remote host to connect to.

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

Parameters

value (string?)

Returns

(string | EventQuery)

▸ port(value?)

src/fdsnevent.js

Gets/Sets the remote port to connect to.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ nodata(value?)

src/fdsnevent.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 | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ eventId(value?)

src/fdsnevent.js

Get/Set the eventid query parameter.

eventId(value: string?): (string | EventQuery)

Parameters

value (string?)

Returns

(string | EventQuery)

▸ startTime(value?)

src/fdsnevent.js

Get/Set the starttime query parameter.

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

Parameters

value (moment?)

Returns

(moment | EventQuery)

▸ endTime(value?)

src/fdsnevent.js

Get/Set the endtime query parameter.

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

Parameters

value (moment?)

Returns

(moment | EventQuery)

▸ timeWindow(se)

src/fdsnevent.js

Sets startTime and endTime using the given time window

timeWindow(se: StartEndDuration): any

Parameters

se (StartEndDuration) time window

Returns

any: this

▸ updatedAfter(value?)

src/fdsnevent.js

Get/Set the updatedafter query parameter.

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

Parameters

value (moment?)

Returns

(moment | EventQuery)

▸ minMag(value?)

src/fdsnevent.js

Get/Set the minmag query parameter.

minMag(value: number?): (number | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ maxMag(value?)

src/fdsnevent.js

Get/Set the maxmag query parameter.

maxMag(value: number?): (number | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ magnitudeType(value?)

src/fdsnevent.js

Get/Set the magnitudetype query parameter.

magnitudeType(value: string?): (string | EventQuery)

Parameters

value (string?)

Returns

(string | EventQuery)

▸ minDepth(value?)

src/fdsnevent.js

Get/Set the mindepth query parameter.

minDepth(value: number?): (number | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ maxDepth(value?)

src/fdsnevent.js

Get/Set the maxdepth query parameter.

maxDepth(value: number?): (number | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ minLat(value?)

src/fdsnevent.js

Get/Set the minlat query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ maxLat(value?)

src/fdsnevent.js

Get/Set the maxlat query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ minLon(value?)

src/fdsnevent.js

Get/Set the minlon query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ maxLon(value?)

src/fdsnevent.js

Get/Set the maxlon query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ latitude(value?)

src/fdsnevent.js

Get/Set the latitude query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ longitude(value?)

src/fdsnevent.js

Get/Set the longitude query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ minRadius(value?)

src/fdsnevent.js

Get/Set the minradius query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ maxRadius(value?)

src/fdsnevent.js

Get/Set the maxradius query parameter.

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ includearrivals(value?)

src/fdsnevent.js

includearrivals(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?)

Returns

(boolean | EventQuery)

▸ includeArrivals(value?)

src/fdsnevent.js

Get/Set the includearrivals query parameter.

includeArrivals(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?)

Returns

(boolean | EventQuery)

▸ includeAllOrigins(value?)

src/fdsnevent.js

Get/Set the includeallorigins query parameter.

includeAllOrigins(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?)

Returns

(boolean | EventQuery)

▸ includeAllMagnitudes(value?)

src/fdsnevent.js

Get/Set the includeallmagnitudes query parameter.

includeAllMagnitudes(value: boolean?): (boolean | EventQuery)

Parameters

value (boolean?)

Returns

(boolean | EventQuery)

▸ format(value?)

src/fdsnevent.js

Get/Set the format query parameter.

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

Parameters

value (string?)

Returns

(string | EventQuery)

▸ limit(value?)

src/fdsnevent.js

Get/Set the limit query parameter.

limit(value: number?): (number | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ offset(value?)

src/fdsnevent.js

Get/Set the offset query parameter.

offset(value: number?): (number | EventQuery)

Parameters

value (number?)

Returns

(number | EventQuery)

▸ orderBy(value?)

src/fdsnevent.js

Get/Set the orderby query parameter.

orderBy(value: string?): (string | EventQuery)

Parameters

value (string?)

Returns

(string | EventQuery)

▸ catalog(value?)

src/fdsnevent.js

Get/Set the catalog query parameter.

catalog(value: string?): (string | EventQuery)

Parameters

value (string?)

Returns

(string | EventQuery)

▸ contributor(value?)

src/fdsnevent.js

Get/Set the contributor query parameter.

contributor(value: string?): (string | EventQuery)

Parameters

value (string?)

Returns

(string | EventQuery)

▸ timeout(value?)

src/fdsnevent.js

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

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

Parameters

value (number?)

Returns

(number | EventQuery)

▸ isSomeParameterSet()

src/fdsnevent.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

▸ convertToQuake(qml)

src/fdsnevent.js

Parses a QuakeML event xml element into a Quake object.

convertToQuake(qml: Element): Quake

Parameters

qml (Element) the event xml Element

Returns

Quake

▸ extractEventId(qml)

src/fdsnevent.js

extractEventId(qml: Element): string

Parameters

qml (Element)

Returns

string

▸ convertToOrigin(qml, allPicks)

src/fdsnevent.js

Parses a QuakeML origin xml element into a Origin object.

convertToOrigin(qml: Element, allPicks: Array<Pick>): Origin

Parameters

qml (Element) the origin xml Element

allPicks (Array<Pick>) picks already extracted from the xml for linking arrivals with picks

Returns

Origin

▸ convertToMagnitude(qml)

src/fdsnevent.js

Parses a QuakeML magnitude xml element into a Magnitude object.

convertToMagnitude(qml: Element): Magnitude

Parameters

qml (Element) the magnitude xml Element

Returns

Magnitude

▸ convertToArrival(arrivalQML, allPicks)

src/fdsnevent.js

Parses a QuakeML arrival xml element into a Arrival object.

convertToArrival(arrivalQML: Element, allPicks: Array<Pick>): Arrival

Parameters

arrivalQML (Element) the arrival xml Element

allPicks (Array<Pick>) picks already extracted from the xml for linking arrivals with picks

Returns

Arrival

▸ convertToPick(pickQML)

src/fdsnevent.js

Parses a QuakeML pick xml element into a Pick object.

convertToPick(pickQML: Element): Pick

Parameters

pickQML (Element) the pick xml Element

Returns

Pick

▸ query()

src/fdsnevent.js

Queries the remote service and parses the returned xml.

query(): Promise<Array<Quake>>

Returns

Promise<Array<Quake>>: Promise to an Array of Quake objects.

▸ parseQuakeML(rawXml)

src/fdsnevent.js

Parses a QuakeML xml document into seisplotjs objects

parseQuakeML(rawXml: Document): Array<Quake>

Parameters

rawXml (Document) the xml Document to parse

Returns

Array<Quake>: array of Quake objects

▸ queryRawXml()

src/fdsnevent.js

Queries the remote server, to get QuakeML xml.

queryRawXml(): Promise<Document>

Returns

Promise<Document>: xml Document

▸ formBaseURL()

src/fdsnevent.js

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

formBaseURL(): string

Returns

string: the url

▸ formCatalogsURL()

src/fdsnevent.js

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

formCatalogsURL(): string

Returns

string: the url

▸ queryCatalogs()

src/fdsnevent.js

Queries the remote web service to get known catalogs

queryCatalogs(): Promise<Array<string>>

Returns

Promise<Array<string>>: Promise to Array of catalog names

▸ formContributorsURL()

src/fdsnevent.js

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

formContributorsURL(): string

Returns

string: the url

▸ queryContributors()

src/fdsnevent.js

Queries the remote web service to get known contributors

queryContributors(): Promise<Array<string>>

Returns

Promise<Array<string>>: Promise to Array of contributor names

▸ formVersionURL()

src/fdsnevent.js

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

formVersionURL(): string

Returns

string: the url

▸ queryVersion()

src/fdsnevent.js

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ makeParam(name, val)

src/fdsnevent.js

Create a name=value parameter to add to a URL, including trailing ampersand

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

Parameters

name (string)

val (any)

Returns

string

▸ formURL()

src/fdsnevent.js

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

formURL(): string

Returns

string

util

src/fdsnevent.js

util

Static Members

▸ _grabFirstEl

src/fdsnevent.js

_grabFirstEl

▸ _grabFirstElNS

src/fdsnevent.js

_grabFirstElNS

▸ _grabFirstElText

src/fdsnevent.js

_grabFirstElText

▸ _grabFirstElFloat

src/fdsnevent.js

_grabFirstElFloat

▸ _grabFirstElInt

src/fdsnevent.js

_grabFirstElInt

▸ _grabAttribute

src/fdsnevent.js

_grabAttribute

▸ _grabAttributeNS

src/fdsnevent.js

_grabAttributeNS