Class DatasetGroup

Internal Dataset class

import Dataset from './dataset.js'

const dataset = new Dataset(config)

Hierarchy (View Summary)

Dataset
- DatasetGroup

Constructors

constructor

new DatasetGroup(e: DatasetGroup): DatasetGroup
Parameters
- e: DatasetGroup
Returns DatasetGroup
Overrides Dataset.constructor
- Defined in dist/lib.es.d.ts:676

Properties

`Optional`_olLayer

_olLayer?: LayerGroup

availability

availability: IAvailability

`Optional`category

category?: Category

created

created: Date

`Optional`dataLiabilityAgreement

dataLiabilityAgreement?: DataLiabilityAgreement

`Optional`datasetGroupItems

datasetGroupItems?: DatasetGroupItem[]

`Optional`defaultDataset

defaultDataset?: Dataset

`Optional`description

description?: string

`Optional`groupType

groupType?: 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`shortTitle

shortTitle?: string

`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

error

get error(): boolean
Returns boolean
Inherited from Dataset.error
- Defined in dist/lib.es.d.ts:589

favorite

get favorite(): boolean
Returns boolean
Inherited from Dataset.favorite
- Defined in dist/lib.es.d.ts:595
set favorite(isFavorite: boolean): void
Parameters
- isFavorite: boolean
Returns void
Inherited from Dataset.favorite
- Defined in dist/lib.es.d.ts:596

legends

get legends(): any[]
Returns any[]
Overrides Dataset.legends
- Defined in dist/lib.es.d.ts:678

opacity

get opacity(): number
Returns number
Inherited from Dataset.opacity
- Defined in dist/lib.es.d.ts:591
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
Inherited from Dataset.opacity
- Defined in dist/lib.es.d.ts:592

queryable

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

Returns boolean
Overrides Dataset.queryable
- Defined in dist/lib.es.d.ts:687

renderable

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

Returns boolean
Overrides Dataset.renderable
- Defined in dist/lib.es.d.ts:691

visible

get visible(): boolean
Returns boolean
Inherited from Dataset.visible
- Defined in dist/lib.es.d.ts:593
set visible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Dataset.visible
- Defined in dist/lib.es.d.ts:594

Methods

fireEvent

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

getOlLayer

getOlLayer(copy?: boolean): LayerGroup
Get an OpenLayers layer to add to a map
Parameters
- Optionalcopy: boolean
  Create a new OpenLayers layer without relation to the dataset group
Returns LayerGroup
Overrides Dataset.getOlLayer
- Defined in dist/lib.es.d.ts:700

getQueryableDatasets

getQueryableDatasets(options?: QueryOptions): Dataset[]
Get a list of Dataset that is queryable
Parameters
- Optionaloptions: QueryOptions
Returns Dataset[]
- Defined in dist/lib.es.d.ts:695

getVisibleGroupItem

getVisibleGroupItem(): undefined | DatasetGroupItem
Get the active sublayer on range

Returns undefined | DatasetGroupItem
- Defined in dist/lib.es.d.ts:704

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 Dataset.off
- Defined in dist/lib.es.d.ts:1062

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
Inherited from Dataset.on
- Defined in dist/lib.es.d.ts:588

parseFeatureAttributes

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

parseFeatureTitle

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

query

query(): Promise<Feature[]>
Returns Promise<Feature[]>
Overrides Dataset.query
- Defined in dist/lib.es.d.ts:681

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
Inherited from Dataset.queryByCoordinate
- Defined in dist/lib.es.d.ts:609

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
Inherited from Dataset.queryByExtent
- Defined in dist/lib.es.d.ts:616

queryByGeometry

queryByGeometry(): Promise<QueryResult>
Query the Dataset with a Geometry

Returns Promise<QueryResult>
a query result
Overrides Dataset.queryByGeometry
- Defined in dist/lib.es.d.ts:680

queryById

queryById(): Promise<Feature>
Query the Dataset for a specific feature using id

Returns Promise<Feature>
a list of queried dataset with the related hit
Overrides Dataset.queryById
- Defined in dist/lib.es.d.ts:679

serialize

serialize(): DatasetState
Serialize the DatasetGroup to JSON

Returns DatasetState
a JSON representation of the Datasets
Overrides Dataset.serialize
- Defined in dist/lib.es.d.ts:713

setFrom

setFrom(datasetGroup: DatasetGroup): void
Parameters
- datasetGroup: DatasetGroup
Returns void
Overrides Dataset.setFrom
- Defined in dist/lib.es.d.ts:677

setVisibleGroupItem

setVisibleGroupItem(datasetGroupIten: DatasetGroupItem): void
Set the active sublayer on range
Parameters
- datasetGroupIten: DatasetGroupItem
Returns void
- Defined in dist/lib.es.d.ts:708

Class DatasetGroup

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DatasetGroup

Properties

Optional_olLayer

availability

Optionalcategory

created

OptionaldataLiabilityAgreement

OptionaldatasetGroupItems

OptionaldefaultDataset

Optionaldescription

OptionalgroupType

hasApiListener

hasIncludedAttributes

id

Optionallicense

OptionallivePreviews

Optionalmetadata

Optionalowners

OptionalpreviewImages

Optionalrelated

OptionalshortTitle

OptionalsupportContact

Optionaltags

Optionalthumbnail

title

type

updated

OptionalwfsSource

OptionalwmsSource

OptionalwmtsSource

Accessors

error

Returns boolean

favorite

Returns boolean

Parameters

Returns void

legends

Returns any[]

opacity

Returns number

Parameters

Returns void

queryable

Returns boolean

renderable

Returns boolean

visible

Returns boolean

Parameters

Returns void

Methods

fireEvent

Parameters

Returns void

getOlLayer

Parameters

Returns LayerGroup

getQueryableDatasets

Parameters

Returns Dataset[]

getVisibleGroupItem

Returns undefined | DatasetGroupItem

off

Parameters

Returns void

on

Parameters

Returns EventListener_2

parseFeatureAttributes

`Optional`_olLayer

`Optional`category

`Optional`dataLiabilityAgreement

`Optional`datasetGroupItems

`Optional`defaultDataset

`Optional`description

`Optional`groupType

`Optional`license

`Optional`livePreviews

`Optional`metadata

`Optional`owners

`Optional`previewImages

`Optional`related

`Optional`shortTitle

`Optional`supportContact

`Optional`tags

`Optional`thumbnail

`Optional`wfsSource

`Optional`wmsSource

`Optional`wmtsSource