seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

FDSN_HOST
DataCentersQuery ▸
- Instance members
- #specVersion
- #getSpecVersion
- #protocol
- #getProtocol
- #host
- #getHost
- #port
- #getPort
- #name
- #getName
- #services
- #getServices
- #includeDataSets
- #getIncludeDataSets
- #timeout
- #getTimeout
- #queryJson
- #findFdsnAvailability
- #findFdsnDataSelect
- #findFdsnEvent
- #findFdsnStation
- #extractCompatibleServices
- #formBaseURL
- #formVersionURL
- #queryVersion
- #formURL
RootType
Repository
Dataset
Service
isValidRootType

Need help reading this?

FDSN_HOST

const for fdsn web service host, www.fdsn.org

FDSN_HOST

Type: string

DataCentersQuery

Query to a FDSN Data Centers Registry web service.

new DataCentersQuery(host: string?)

Extends FDSNCommon

Parameters

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

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

Parameters

value (string?) optional new value if setting

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

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

Parameters

value (string?) optional new value if setting

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getProtocol()

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

Gets/Sets the remote host to connect to. This defaults to www.fdsn.org and generally should not be set.

host(value: string?): DataCentersQuery

Parameters

value (string?) optional new value if setting

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getHost()

getHost(): string

Returns

string

▸ port(value?)

Gets/Sets the remote port to connect to. This defaults to the standard port for the protocol and generally should not be set.

port(value: number?): DataCentersQuery

Parameters

value (number?) optional new value if setting

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getPort()

getPort(): (number | undefined)

Returns

(number | undefined)

▸ name(value?)

limits results to the named data center, default is all data centers

name(value: string?): DataCentersQuery

Parameters

value (string?) names to search for

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getName()

getName(): (string | undefined)

Returns

(string | undefined)

▸ services(value?)

limits results to services that match the glob style pattern

services(value: string?): DataCentersQuery

Parameters

value (string?) glob style pattern to match against

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getServices()

getServices(): (string | undefined)

Returns

(string | undefined)

▸ includeDataSets(value?)

whether the results include detailed information about the data sets offered by each center, default is false

includeDataSets(value: boolean?): DataCentersQuery

Parameters

value (boolean?) true to include datasets

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getIncludeDataSets()

getIncludeDataSets(): (boolean | undefined)

Returns

(boolean | undefined)

▸ timeout(value?)

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

timeout(value: number?): DataCentersQuery

Parameters

value (number?) timeout seconds

Returns

DataCentersQuery: the query when setting, the current value os services if no arguments

▸ getTimeout()

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ queryJson()

queries the fdsn registry web service, returning the result as a parsed json object.

queryJson(): Promise<RootType>

Returns

Promise<RootType>: Promise to the json object.

▸ findFdsnAvailability(name, repoName?)

queries the registry to find fdsn availability compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnAvailability(name: string, repoName: string?): Promise<Array<fdsnavailability.AvailabilityQuery>>

Parameters

name (string) datacenter name

repoName (string?) optional repository name

Returns

Promise<Array<fdsnavailability.AvailabilityQuery>>: Promise to Array of fdsnavailability.AvailabilityQuery objects

▸ findFdsnDataSelect(name, repoName?)

queries the registry to find fdsn dataselect compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnDataSelect(name: string, repoName: string?): Promise<Array<fdsndataselect.DataSelectQuery>>

Parameters

name (string) datacenter name

repoName (string?) optional repository name

Returns

Promise<Array<fdsndataselect.DataSelectQuery>>: Promise to Array of fdsndataselect.DataSelectQuery objects

▸ findFdsnEvent(dcname, repoName?)

queries the registry to find a fdsn event compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnEvent(dcname: string, repoName: string?): Promise<Array<fdsnevent.EventQuery>>

Parameters

dcname (string) datacenter name

repoName (string?) optional repository name

Returns

Promise<Array<fdsnevent.EventQuery>>: Promise to Array of fdsnevent.EventQuery objects

▸ findFdsnStation(dcname, repoName?)

queries the registry to find a fdsn station compatible web services within a datacenter of the given name, optionally within the repository with the repo name.

findFdsnStation(dcname: string, repoName: string?): Promise<Array<fdsnstation.StationQuery>>

Parameters

dcname (string) datacenter name

repoName (string?) optional repository name

Returns

Promise<Array<fdsnstation.StationQuery>>: Promise to Array of fdsnstation.StationQuery objects

▸ extractCompatibleServices(json, compatibleName, repoName?)

Extracts services comaptible with the given service name, optionally within the given repository, from the json.

extractCompatibleServices(json: RootType, compatibleName: string, repoName: string?): Array<Service>

Parameters

json (RootType) json containing services

compatibleName (string) service name to be compatible with

repoName (string?) optional repository within the json to search

Returns

Array<Service>: array of services found

▸ formBaseURL()

Forms the base of the url for accessing the datacenters service.

formBaseURL(): string

Returns

string: URL

▸ formVersionURL()

Forms version url, not part of spec and so may not be supported.

formVersionURL(): string

Returns

string: version

▸ queryVersion()

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formURL()

forms a url to the fdsn registry based on the configured parameters.

formURL(): string

Returns

string: the url

RootType

Root type of fdsn datacenters json query.

RootType

Type: any

Repository

Type: {name: string, description: string?, website: string?, services: Array<Service>, datasets: Array<Dataset>?}

Properties

name (string)

description (string?)

website (string?)

services (Array<Service>)

datasets (Array<Dataset>?)

Dataset

Type: {network: string?, station: string?, location: string?, channel: string?, starttime: string?, endtime: string?, priority: number?, description: string?, url: string?, services: Array<Service>?}

Properties

network (string?)

station (string?)

location (string?)

channel (string?)

starttime (string?)

endtime (string?)

priority (number?)

description (string?)

url (string?)

services (Array<Service>?)

Service

Type: {name: string, description: string?, url: string?, compatibleWith: string?}

Properties

name (string)

description (string?)

url (string?)

compatibleWith (string?)

isValidRootType

isValidRootType(jsonValue: any): any

Parameters

jsonValue (any)

Returns

any