Class Dataset

Internal Dataset class

import Dataset from './dataset.js'

const dataset = new Dataset(config)

Hierarchy (View Summary)

Constructors

constructor

Properties

availability category? created dataLiabilityAgreement? description? hasApiListener hasIncludedAttributes id license? livePreviews? metadata? owners? previewImages? related? supportContact? tags? thumbnail? title type updated wfsSource? wmsSource? wmtsSource?

Accessors

error favorite legends opacity queryable renderable visible

Methods

fireEvent getOlLayer off on parseFeatureAttributes parseFeatureTitle query queryByCoordinate queryByExtent queryByGeometry queryById serialize setFrom

Constructors

constructor

Properties

availability

availability: IAvailability

Optionalcategory

category?: Category

created

created: Date

OptionaldataLiabilityAgreement

dataLiabilityAgreement?: DataLiabilityAgreement

Optionaldescription

description?: string

hasApiListener

hasApiListener: boolean

hasIncludedAttributes

hasIncludedAttributes: boolean

id

id: string

Optionallicense

license?: License

OptionallivePreviews

livePreviews?: LivePreview[]

Optionalmetadata

metadata?: string

Optionalowners

owners?: Organization[]

OptionalpreviewImages

previewImages?: PreviewImage[]

Optionalrelated

related?: Dataset[]

OptionalsupportContact

supportContact?: string

Optionaltags

tags?: Tag[]

Optionalthumbnail

thumbnail?: Image

title

title: string

type

type: string

updated

updated: Date

OptionalwfsSource

wfsSource?: WfsSource

OptionalwmsSource

wmsSource?: WmsSource

OptionalwmtsSource

wmtsSource?: WmtsSource

Accessors

error

  • get error(): boolean

  • Returns boolean

favorite

  • get favorite(): boolean

  • Returns boolean

  • set favorite(isFavorite: boolean): void

  • Parameters

    • isFavorite: boolean

    Returns void

legends

  • get legends(): Legend[]

  • Returns Legend[]

opacity

  • get opacity(): number

  • Returns number

  • set opacity(opacity: number): void

  • Parameters

    • opacity: number

    Returns void

queryable

  • get queryable(): boolean

  • Determines if this dataset supports querying

    Returns boolean

renderable

  • get renderable(): boolean

  • Determines if this dataset supports rendering

    Returns boolean

visible

  • get visible(): boolean

  • Returns boolean

  • set visible(visible: boolean): void

  • Parameters

    • visible: boolean

    Returns void

Methods

fireEvent

  • fireEvent(event: string, ...args: unknown[]): void

  • Parameters

    • event: string
    • ...args: unknown[]

    Returns void

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

off

  • off(listener: EventListener_2): void

  • Remove a listen from an event

    Parameters

    • listener: EventListener_2

      returned by the on method

    Returns void

on

  • on(
        event:
            | "change:favorite"
            | "change:visible"
            | "change"
            | "change:opacity"
            | "rendererror",
        callback: EventListenerCallback,
    ): EventListener_2

  • Listen to an event

    Parameters

    • event:
          | "change:favorite"
          | "change:visible"
          | "change"
          | "change:opacity"
          | "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: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

parseFeatureAttributes

parseFeatureTitle

  • parseFeatureTitle(feature: Feature): any

  • Parameters

    • feature: Feature

    Returns any

query

  • query(filter: Filter, limit?: number, timeout?: number): Promise<Feature[]>

  • Parameters

    • filter: Filter
    • Optionallimit: number
    • Optionaltimeout: number

    Returns Promise<Feature[]>

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

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

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

queryById

  • queryById(id: string | number): Promise<Feature>

  • Query the Dataset for a specific feature using id

    Parameters

    • id: string | number

      An id of a Feature from the Dataset

    Returns Promise<Feature>

    a list of queried dataset with the related hit

serialize

setFrom

  • setFrom(dataset: Dataset): void

  • Parameters

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods