Class Dataset

Internal Dataset class

import Dataset from './dataset.js'

const dataset = new Dataset(config)

Hierarchy (View Summary)

ObservableEntity
- Dataset
  - DatasetGroup

Constructors

constructor

new Dataset(e: Dataset | Partial<Dataset>): Dataset
Parameters
- e: Dataset | Partial<Dataset>
Returns Dataset
Overrides ObservableEntity.constructor
- Defined in dist/lib.es.d.ts:625

Properties

availability

availability: IAvailability

`Optional`category

category?: Category

created

created: Date

`Optional`dataLiabilityAgreement

dataLiabilityAgreement?: DataLiabilityAgreement

`Optional`description

description?: string

hasApiListener

hasApiListener: boolean

hasIncludedAttributes

hasIncludedAttributes: boolean

id

id: string

`Optional`license

license?: License

`Optional`livePreviews

livePreviews?: LivePreview[]

`Optional`metadata

metadata?: string

`Optional`owners

owners?: Organization[]

`Optional`previewImages

previewImages?: PreviewImage[]

`Optional`related

related?: Dataset[]

`Optional`supportContact

supportContact?: string

`Optional`tags

tags?: Tag[]

`Optional`thumbnail

thumbnail?: Image

title

title: string

type

type: string

updated

updated: Date

Accessors

error

get error(): boolean
Returns boolean
- Defined in dist/lib.es.d.ts:639

favorite

get favorite(): boolean
Returns boolean
- Defined in dist/lib.es.d.ts:651
set favorite(isFavorite: boolean): void
Parameters
- isFavorite: boolean
Returns void
- Defined in dist/lib.es.d.ts:652

legends

get legends(): Legend[]
Returns Legend[]
- Defined in dist/lib.es.d.ts:640

opacity

get opacity(): number
Returns number
- Defined in dist/lib.es.d.ts:641
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in dist/lib.es.d.ts:648

queryable

get queryable(): boolean
Determines if this dataset supports querying

Returns boolean
- Defined in dist/lib.es.d.ts:693

renderable

get renderable(): boolean
Determines if this dataset supports rendering

Returns boolean
- Defined in dist/lib.es.d.ts:697

visible

get visible(): boolean
Returns boolean
- Defined in dist/lib.es.d.ts:649
set visible(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in dist/lib.es.d.ts:650

wfsSource

get wfsSource(): undefined | WfsSource
Returns undefined | WfsSource
- Defined in dist/lib.es.d.ts:646
set wfsSource(wfsSource: undefined | WfsSource): void
Parameters
- wfsSource: undefined | WfsSource
Returns void
- Defined in dist/lib.es.d.ts:647

wmsSource

get wmsSource(): undefined | WmsSource
Returns undefined | WmsSource
- Defined in dist/lib.es.d.ts:642
set wmsSource(wmsSource: undefined | WmsSource): void
Parameters
- wmsSource: undefined | WmsSource
Returns void
- Defined in dist/lib.es.d.ts:643

wmtsSource

get wmtsSource(): undefined | WmtsSource
Returns undefined | WmtsSource
- Defined in dist/lib.es.d.ts:644
set wmtsSource(wmtsSource: undefined | WmtsSource): void
Parameters
- wmtsSource: undefined | WmtsSource
Returns void
- Defined in dist/lib.es.d.ts:645

Methods

fireEvent

fireEvent(event: string, ...args: unknown[]): void
Parameters
- event: string
- ...args: unknown[]
Returns void
Inherited from ObservableEntity.fireEvent
- Defined in dist/lib.es.d.ts:1166

getOlLayer

getOlLayer(copy?: boolean, sourceType?: "WMS" | "WMTS"): BaseLayer
Get an OpenLayers layer to add to a map
Parameters
- Optionalcopy: boolean
  Create a new OpenLayers layer without relation to the dataset
- OptionalsourceType: "WMS" | "WMTS"
  Force to use a specific source type
Returns BaseLayer
- Defined in dist/lib.es.d.ts:703

off

off(listener: EventListener_2): void
Remove a listen from an event
Parameters
- listener: EventListener_2
  returned by the on method
Returns void
Inherited from ObservableEntity.off
- Defined in dist/lib.es.d.ts:1165

on

on(
    event:
        | "change:favorite"
        | "change:visible"
        | "change:opacity"
        | "change"
        | "rendererror",
    callback: EventListenerCallback,
): EventListener_2
Listen to an event
Parameters
- event:
      | "change:favorite"
      | "change:visible"
      | "change:opacity"
      | "change"
      | "rendererror"
  Name of the event
- callback: EventListenerCallback
  When the event is triggered
  
  For 'change:opacity' the callback function is called with the event name and the new opacity
  
  For 'change:visible' the callback function is called with the event name and the visible state
  
  For 'change:opacity' the callback function is called with the event name and the opacity state
  
  For 'change:favorite' the callback function is called with the event name and the favorite state
  
  For 'rendererror' the callback function is called with the event name and the requested URL
Returns EventListener_2
A listener that can be used for removing the listener
Overrides ObservableEntity.on
- Defined in dist/lib.es.d.ts:638

parseFeatureAttributes

parseFeatureAttributes(feature: Feature): AttributeValue[]
Parameters
- feature: Feature
Returns AttributeValue[]
- Defined in dist/lib.es.d.ts:688

parseFeatureTitle

parseFeatureTitle(feature: Feature): any
Parameters
- feature: Feature
Returns any
- Defined in dist/lib.es.d.ts:689

query

query(
    filter: Filter,
    limit?: number,
    timeout?: number,
): Promise<Feature<Geometry>[]>
Parameters
- filter: Filter
- Optionallimit: number
- Optionaltimeout: number
Returns Promise<Feature<Geometry>[]>
- Defined in dist/lib.es.d.ts:687

queryByCoordinate

queryByCoordinate(
coordinate: Coordinate,
options?: QueryOptions,
): Promise<QueryResult>
Query a Dataset with a coordinate
Parameters
- coordinate: Coordinate
  The coordinate to query with
- Optionaloptions: QueryOptions
  Options for the query
Returns Promise<QueryResult>
a query result
- Defined in dist/lib.es.d.ts:665

queryByExtent

queryByExtent(extent: Extent, options?: QueryOptions): Promise<QueryResult>
Query a Dataset with an extent
Parameters
- extent: Extent
  The bounding box to query with
- Optionaloptions: QueryOptions
  Options for the query
Returns Promise<QueryResult>
a query result
- Defined in dist/lib.es.d.ts:672

queryByGeometry

queryByGeometry(
geometry: Geometry,
options?: QueryOptions,
): Promise<QueryResult>
Query the Dataset with a Geometry
Parameters
- geometry: Geometry
  The Geometry to query with
- Optionaloptions: QueryOptions
  Options for the query
Returns Promise<QueryResult>
a query result
- Defined in dist/lib.es.d.ts:679

queryByGeometryInternal

queryByGeometryInternal(
geometry: Geometry,
options?: QueryOptions,
): Promise<QueryResult>
Query the Dataset with a Geometry
Parameters
- geometry: Geometry
  The Geometry to query with
- Optionaloptions: QueryOptions
  Options for the query
Returns Promise<QueryResult>
a query result
- Defined in dist/lib.es.d.ts:686

queryById

queryById(id: string | number): Promise<Feature<Geometry>>
Query the Dataset for a specific feature using id
Parameters
- id: string | number
  An id of a Feature from the Dataset
Returns Promise<Feature<Geometry>>
a list of queried dataset with the related hit
- Defined in dist/lib.es.d.ts:658

serialize

serialize(): DatasetState
Serialize the Dataset to JSON

Returns DatasetState
a JSON representation of the Datasets
- Defined in dist/lib.es.d.ts:709

setFrom

setFrom(dataset: Dataset): void
Parameters
- dataset: Dataset
Returns void
Overrides ObservableEntity.setFrom
- Defined in dist/lib.es.d.ts:626

updateOlLayer

updateOlLayer(): void
Returns void
- Defined in dist/lib.es.d.ts:704

Class Dataset

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Dataset

Properties

availability

Optionalcategory

created

OptionaldataLiabilityAgreement

Optionaldescription

hasApiListener

hasIncludedAttributes

id

Optionallicense

OptionallivePreviews

Optionalmetadata

Optionalowners

OptionalpreviewImages

Optionalrelated

OptionalsupportContact

Optionaltags

Optionalthumbnail

title

type

updated

Accessors

error

Returns boolean

favorite

Returns boolean

Parameters

Returns void

legends

Returns Legend[]

opacity

Returns number

Parameters

Returns void

queryable

Returns boolean

renderable

Returns boolean

visible

Returns boolean

Parameters

Returns void

wfsSource

Returns undefined | WfsSource

Parameters

Returns void

wmsSource

Returns undefined | WmsSource

Parameters

Returns void

wmtsSource

Returns undefined | WmtsSource

Parameters

Returns void

Methods

fireEvent

Parameters

Returns void

getOlLayer

Parameters

Returns BaseLayer

off

Parameters

Returns void

on

Parameters

Returns EventListener_2

parseFeatureAttributes

Parameters

`Optional`category

`Optional`dataLiabilityAgreement

`Optional`description

`Optional`license

`Optional`livePreviews

`Optional`metadata

`Optional`owners

`Optional`previewImages

`Optional`related

`Optional`supportContact

`Optional`tags

`Optional`thumbnail