seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

USGS_HOST
SERVICE_VERSION
SERVICE_NAME
FAKE_EMPTY_XML
EventQuery ▸
- Instance members
- #specVersion
- #getSpecVersion
- #protocol
- #getProtocol
- #host
- #getHost
- #port
- #getPort
- #nodata
- #getNodata
- #timeout
- #getTimeout
- #eventId
- #getEventId
- #startTime
- #getStartTime
- #endTime
- #getEndTime
- #timeRange
- #updatedAfter
- #getUpdatedAfter
- #minMag
- #getMinMag
- #maxMag
- #getMaxMag
- #magnitudeType
- #getMagnitudeType
- #minDepth
- #getMinDepth
- #maxDepth
- #getMaxDepth
- #minLat
- #getMinLat
- #maxLat
- #getMaxLat
- #minLon
- #getMinLon
- #maxLon
- #getMaxLon
- #latitude
- #getLatitude
- #longitude
- #getLongitude
- #minRadius
- #getMinRadius
- #maxRadius
- #getMaxRadius
- #includeArrivals
- #getIncludeArrivals
- #includeAllOrigins
- #getIncludeAllOrigins
- #includeAllMagnitudes
- #getIncludeAllMagnitudes
- #format
- #getFormat
- #limit
- #getLimit
- #offset
- #getOffset
- #orderBy
- #getOrderBy
- #catalog
- #getCatalog
- #contributor
- #getContributor
- #latLonRegion
- #isSomeParameterSet
- #query
- #queryEventParameters
- #queryRawXml
- #formBaseURL
- #formCatalogsURL
- #queryCatalogs
- #formContributorsURL
- #queryContributors
- #formVersionURL
- #queryVersion
- #formURL
EarthquakeSearch ▸
- Instance members
- #_registerEvent
- #draw_element
- #populateQuery

Need help reading this?

USGS_HOST

SERVICE_VERSION

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

SERVICE_VERSION

Type: number

SERVICE_NAME

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

SERVICE_NAME

FAKE_EMPTY_XML

Type: string

EventQuery

Query to a FDSN Event web service.

new EventQuery(host: string?)

Extends FDSNCommon

Parameters

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

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

Instance Members

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

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getSpecVersion()

getSpecVersion(): string

Returns

string

▸ protocol(value?)

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

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getProtocol()

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

Gets/Sets the remote host to connect to.

host(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getHost()

getHost(): string

Returns

string

▸ port(value?)

Gets/Sets the remote port to connect to.

port(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getPort()

getPort(): (number | undefined)

Returns

(number | undefined)

▸ nodata(value?)

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

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getNodata()

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ timeout(value?)

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

timeout(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getTimeout()

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ eventId(value?)

Get/Set the eventid query parameter.

eventId(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getEventId()

getEventId(): (string | undefined)

Returns

(string | undefined)

▸ startTime(value?)

Get/Set the starttime query parameter.

startTime(value: DateTime?): EventQuery

Parameters

value (DateTime?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getStartTime()

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

Get/Set the endtime query parameter.

endTime(value: DateTime?): EventQuery

Parameters

value (DateTime?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getEndTime()

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ timeRange(se)

Sets startTime and endTime using the given time window

timeRange(se: Interval): EventQuery

Parameters

se (Interval) time window

Returns

EventQuery: this

▸ updatedAfter(value?)

Get/Set the updatedafter query parameter.

updatedAfter(value: DateTime?): EventQuery

Parameters

value (DateTime?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getUpdatedAfter()

getUpdatedAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ minMag(value?)

Get/Set the minmag query parameter.

minMag(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinMag()

getMinMag(): (number | undefined)

Returns

(number | undefined)

▸ maxMag(value?)

Get/Set the maxmag query parameter.

maxMag(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxMag()

getMaxMag(): (number | undefined)

Returns

(number | undefined)

▸ magnitudeType(value?)

Get/Set the magnitudetype query parameter.

magnitudeType(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMagnitudeType()

getMagnitudeType(): (string | undefined)

Returns

(string | undefined)

▸ minDepth(value?)

Get/Set the mindepth query parameter.

minDepth(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinDepth()

getMinDepth(): (number | undefined)

Returns

(number | undefined)

▸ maxDepth(value?)

Get/Set the maxdepth query parameter.

maxDepth(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxDepth()

getMaxDepth(): (number | undefined)

Returns

(number | undefined)

▸ minLat(value?)

Get/Set the minlat query parameter.

minLat(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinLat()

getMinLat(): (number | undefined)

Returns

(number | undefined)

▸ maxLat(value?)

Get/Set the maxlat query parameter.

maxLat(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxLat()

getMaxLat(): (number | undefined)

Returns

(number | undefined)

▸ minLon(value?)

Get/Set the minlon query parameter.

minLon(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinLon()

getMinLon(): (number | undefined)

Returns

(number | undefined)

▸ maxLon(value?)

Get/Set the maxlon query parameter.

maxLon(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxLon()

getMaxLon(): (number | undefined)

Returns

(number | undefined)

▸ latitude(value?)

Get/Set the latitude query parameter.

latitude(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getLatitude()

getLatitude(): (number | undefined)

Returns

(number | undefined)

▸ longitude(value?)

Get/Set the longitude query parameter.

longitude(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getLongitude()

getLongitude(): (number | undefined)

Returns

(number | undefined)

▸ minRadius(value?)

Get/Set the minradius query parameter.

minRadius(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMinRadius()

getMinRadius(): (number | undefined)

Returns

(number | undefined)

▸ maxRadius(value?)

Get/Set the maxradius query parameter.

maxRadius(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getMaxRadius()

getMaxRadius(): (number | undefined)

Returns

(number | undefined)

▸ includeArrivals(value?)

Get/Set the includearrivals query parameter.

includeArrivals(value: boolean?): EventQuery

Parameters

value (boolean?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getIncludeArrivals()

getIncludeArrivals(): (boolean | undefined)

Returns

(boolean | undefined)

▸ includeAllOrigins(value?)

Get/Set the includeallorigins query parameter.

includeAllOrigins(value: boolean?): EventQuery

Parameters

value (boolean?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getIncludeAllOrigins()

getIncludeAllOrigins(): (boolean | undefined)

Returns

(boolean | undefined)

▸ includeAllMagnitudes(value?)

Get/Set the includeallmagnitudes query parameter.

includeAllMagnitudes(value: boolean?): EventQuery

Parameters

value (boolean?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getIncludeAllMagnitudes()

getIncludeAllMagnitudes(): (boolean | undefined)

Returns

(boolean | undefined)

▸ format(value?)

Get/Set the format query parameter.

format(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getFormat()

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ limit(value?)

Get/Set the limit query parameter.

limit(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getLimit()

getLimit(): (number | undefined)

Returns

(number | undefined)

▸ offset(value?)

Get/Set the offset query parameter.

offset(value: number?): EventQuery

Parameters

value (number?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getOffset()

getOffset(): (number | undefined)

Returns

(number | undefined)

▸ orderBy(value?)

Get/Set the orderby query parameter.

orderBy(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getOrderBy()

getOrderBy(): (string | undefined)

Returns

(string | undefined)

▸ catalog(value?)

Get/Set the catalog query parameter.

catalog(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getCatalog()

getCatalog(): (string | undefined)

Returns

(string | undefined)

▸ contributor(value?)

Get/Set the contributor query parameter.

contributor(value: string?): EventQuery

Parameters

value (string?) optional new value if setting

Returns

EventQuery: new value if getting, this if setting

▸ getContributor()

getContributor(): (string | undefined)

Returns

(string | undefined)

▸ latLonRegion(value)

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

Parameters

value ((LatLonRegion | null))

Returns

EventQuery

▸ isSomeParameterSet()

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 is some parameter is set

▸ query()

Queries the remote service and parses the returned xml.

query(): Promise<Array<Quake>>

Returns

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

▸ queryEventParameters()

queryEventParameters(): Promise<EventParameters>

Returns

Promise<EventParameters>

▸ queryRawXml()

Queries the remote server, to get QuakeML xml.

queryRawXml(): Promise<Document>

Returns

Promise<Document>: xml Document

▸ formBaseURL()

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

formBaseURL(): string

Returns

string: the url

▸ formCatalogsURL()

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

formCatalogsURL(): string

Returns

string: the url

▸ queryCatalogs()

Queries the remote web service to get known catalogs

queryCatalogs(): Promise<Array<string>>

Returns

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

▸ formContributorsURL()

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

formContributorsURL(): string

Returns

string: the url

▸ queryContributors()

Queries the remote web service to get known contributors

queryContributors(): Promise<Array<string>>

Returns

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

▸ formVersionURL()

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

formVersionURL(): string

Returns

string: the url

▸ queryVersion()

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formURL()

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

formURL(): string

Returns

string: url

EarthquakeSearch

new EarthquakeSearch()

Extends HTMLElement

Instance Members

▸ _registerEvent(wrapper, sel)

_registerEvent(wrapper: HTMLElement, sel: string)

Parameters

wrapper (HTMLElement)

sel (string)

▸ draw_element(shadow)

draw_element(shadow: ShadowRoot)

Parameters

shadow (ShadowRoot)

▸ populateQuery(query?)

populateQuery(query: EventQuery?): EventQuery

Parameters

query (EventQuery?)

Returns

EventQuery