Class Dataset

constructor

• new Dataset(e: Dataset | Partial<Dataset>): Dataset

• Parameters

  • e: Dataset | Partial<Dataset>

  Returns Dataset

availability

Optionalcategory

created

OptionaldataLiabilityAgreement

Optionaldescription

hasApiListener

hasIncludedAttributes

Optionallicense

OptionallivePreviews

Optionalmetadata

Optionalowners

OptionalpreviewImages

Optionalrelated

OptionalsupportContact

Optionaltags

Optionalthumbnail

title

updated

OptionalwfsSource

OptionalwmsSource

OptionalwmtsSource

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

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

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

• parseFeatureAttributes(feature: Feature): AttributeValue[]

• Parameters

  • feature: Feature

  Returns AttributeValue[]

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[]>

queryByGeometry

• queryByGeometry(
      geometry: Geometry,
      queryOptions?: QueryOptions,
  ): Promise<QueryResult>

• Parameters

  • geometry: Geometry
  • OptionalqueryOptions: QueryOptions

  Returns Promise<QueryResult>

queryById

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

• Parameters

  • id: string | number

  Returns Promise<Feature>

serialize

• serialize(): DatasetState

• Serialize the Dataset to JSON

  Returns DatasetState

  a JSON representation of the Datasets

setFrom

• setFrom(dataset: Dataset): void

• Parameters

  • dataset: Dataset

  Returns void