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:744

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

Accessors

error

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

favorite

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

legends

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

opacity

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

queryable

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

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

renderable

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

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

visible

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

wfsSource

get wfsSource(): undefined | WfsSource
Returns undefined | WfsSource
Inherited from Dataset.wfsSource
- Defined in dist/lib.es.d.ts:648
set wfsSource(wfsSource: undefined | WfsSource): void
Parameters
- wfsSource: undefined | WfsSource
Returns void
Inherited from Dataset.wfsSource
- Defined in dist/lib.es.d.ts:649

wmsSource

get wmsSource(): undefined | WmsSource
Returns undefined | WmsSource
Inherited from Dataset.wmsSource
- Defined in dist/lib.es.d.ts:644
set wmsSource(wmsSource: undefined | WmsSource): void
Parameters
- wmsSource: undefined | WmsSource
Returns void
Inherited from Dataset.wmsSource
- Defined in dist/lib.es.d.ts:645

wmtsSource

get wmtsSource(): undefined | WmtsSource
Returns undefined | WmtsSource
Inherited from Dataset.wmtsSource
- Defined in dist/lib.es.d.ts:646
set wmtsSource(wmtsSource: undefined | WmtsSource): void
Parameters
- wmtsSource: undefined | WmtsSource
Returns void
Inherited from Dataset.wmtsSource
- Defined in dist/lib.es.d.ts:647

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:1179

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:777

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:772

getVisibleGroupItem

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

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

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:1178

on

on(
event: "change:range" | DatasetEventTypes,
callback: EventListenerCallback,
): EventListener_2
Parameters
- event: "change:range" | DatasetEventTypes
  Event type to listen for. In addition to Dataset events, supports 'change:range' which fires when the visible group item changes
- callback: EventListenerCallback
Returns EventListener_2
Inherit Doc: Extends
the parent Dataset's event handling with additional support for the DatasetGroup-specific event 'change:range'.
- For 'change:range' the callback function is called with the event name and the active DatasetGroupItem
Overrides Dataset.on
- Defined in dist/lib.es.d.ts:754

parseFeatureAttributes

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

parseFeatureTitle

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

query

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

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:667

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:674

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:757

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

queryById

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

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

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:790

setFrom

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

setVisibleGroupItem

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

updateOlLayer

updateOlLayer(): void
Returns void
Inherited from Dataset.updateOlLayer
- Defined in dist/lib.es.d.ts:706

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

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

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 LayerGroup

getQueryableDatasets

Parameters

Returns Dataset[]

`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