Class Dataset

Internal Dataset class

import Dataset from './dataset.js'

const dataset = new Dataset(config)

Hierarchy

Constructors

constructor

Properties

_favorite _olLayer? _opacity _visible availability category? created dataLiabilityAgreement? description? error hasApiListener hasIncludedAttributes id metadata? owners? previewImages? related? supportContact? tags? thumbnail? title type updated wfsSource? wmsSource? wmtsSource?

Accessors

favorite legends opacity queryable renderable visible

Methods

fireEvent getOlLayer off on parseFeatureAttributes parseFeatureTitle query serialize setFrom

Constructors

constructor

Properties

Private _favorite

_favorite: boolean = false

Private Optional _olLayer

_olLayer?: BaseLayer

Private _opacity

_opacity: number = 1

Private _visible

_visible: boolean = true

availability

availability: IAvailability

Optional category

category?: Category

created

created: Date

Optional dataLiabilityAgreement

dataLiabilityAgreement?: DataLiabilityAgreement

Optional description

description?: string

Protected error

error: boolean = false

hasApiListener

hasApiListener: boolean = false

hasIncludedAttributes

hasIncludedAttributes: boolean = false

id

id: string

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

Optional wfsSource

wfsSource?: WfsSource

Optional wmsSource

wmsSource?: WmsSource

Optional wmtsSource

wmtsSource?: WmtsSource

Accessors

favorite

  • get favorite(): boolean

  • Returns boolean

  • set favorite(favorite: boolean): void

  • Parameters

    • favorite: 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

Protected fireEvent

  • Parameters

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

    Returns void

getOlLayer

  • Get an OpenLayers layer to add to a map

    Parameters

    • copy: boolean = false

      Create a new OpenLayers layer without relation to the dataset

    Returns BaseLayer

off

on

  • Listen to an event

    Returns

    A listener that can be used for removing the listener

    Parameters

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

parseFeatureAttributes

  • Parameters

    • feature: Feature<Geometry>

    Returns AttributeValue[]

parseFeatureTitle

  • Parameters

    • feature: Feature<Geometry>

    Returns any

query

  • Parameters

    • filter: Filter

    Returns Promise<Feature<Geometry>[]>

serialize

  • Serialize the Dataset to JSON

    Returns

    a JSON representation of the Datasets

    Returns DatasetState

setFrom

Settings

Member Visibility

Theme

Generated using TypeDoc