Class ObliqueCollection

dataSets

• get dataSets(): ObliqueDataSet[]

  Returns ObliqueDataSet[]

destroyed

• get destroyed(): VcsEvent<void>

  Returns VcsEvent<void>

imageFeatureSource

• get imageFeatureSource(): VectorSource

  A vector source of all image currently loaded for this collection in mercator. The id is the image name. The feature has a "viewDirection" property.

  Returns VectorSource

images

• get images(): ObliqueImage[]

  All currently loaded images

  Returns ObliqueImage[]

loaded

• get loaded(): boolean

  Indicates, that this collection has been loaded

  Returns boolean

tileFeatureSource

• get tileFeatureSource(): VectorSource

  A vector source of all tiles available to this collection in mercator. The feature have a "state" property, the id is the string tile coordinate "z/x/y" of the tile

  Returns VectorSource

StaticclassName

• get className(): string

  Returns string

constructor

• new ObliqueCollection(options: ObliqueCollectionOptions): ObliqueCollection

  Parameters

  • options: ObliqueCollectionOptions

  Returns ObliqueCollection

addDataSet

• addDataSet(dataSet: ObliqueDataSet): Promise<void>

  Adds an oblique data set to this collection.

  Parameters

  • dataSet: ObliqueDataSet

  Returns Promise<void>

destroy

• destroy(): void

  Destroys all data sets and all images and any image/tile features for this collection

  Returns void

getAvailableViewDirections

• getAvailableViewDirections(): ObliqueViewDirection[]

  Returns a list of viewDirections which a currently available in this collection

  Returns ObliqueViewDirection[]

getDataStateForCoordinate

• getDataStateForCoordinate(mercatorCoordinate: Coordinate): DataState

  Returns the state of the data for a given location an all underlying data sources

  Parameters

  • mercatorCoordinate: Coordinate

    coordinate in web mercator

  Returns DataState

getDataStateForExtent

• getDataStateForExtent(extent: Coordinate): DataState

  Returns the state of the data for a given location an all underlying data sources

  Parameters

  • extent: Coordinate

    coordinate in web mercator

  Returns DataState

getImageByName

• getImageByName(name: string): ObliqueImage | undefined

  Returns an image by its name, if it has been loaded

  Parameters

  • name: string

  Returns ObliqueImage | undefined

getImageForCoordinate

• getImageForCoordinate(
      mercatorCoordinate: Coordinate,
      direction: ObliqueViewDirection,
  ): ObliqueImage | undefined

  Returns the closest image for the given location and direction (location and image extent must not overlap). Returns undefined, if there are no images for the given direction

  Parameters

  • mercatorCoordinate: Coordinate

    coordinate in web mercator

  • direction: ObliqueViewDirection

    the preferred direction if no image in that direction can be found, other direction will be queried

  Returns ObliqueImage | undefined

getTiles

• getTiles(): Record<string, DataState>

  Gets all available tile coordinates across all data sets, including their loaded state. Return value is an object, where the key is the tile coordinate in z/x/y and the value is the data state

  Returns Record<string, DataState>

hasImageAtCoordinate

• hasImageAtCoordinate(
      mercatorCoordinate: Coordinate,
      direction: ObliqueViewDirection,
  ): Promise<boolean>

  Checks, if an image exists for a given coordinated

  Parameters

  • mercatorCoordinate: Coordinate

    coordinate in web mercator

  • direction: ObliqueViewDirection

  Returns Promise<boolean>

load

• load(): Promise<void>

  Loads all meta data associated with this collection

  Returns Promise<void>

loadAdjacentImage

• loadAdjacentImage(
      image: ObliqueImage,
      heading: number,
      deviation?: number,
  ): Promise<ObliqueImage | undefined>

  Loads the image adjacent to a given image in a certain direction from the provided image. Returns undefined if there are no images in that direction or there are no images for the direction of the provided image.

  Parameters

  • image: ObliqueImage
  • heading: number

    0 = east, PI / 2 = north, PI = west and PI * 1.5 = south

  • Optionaldeviation: number = ...

  Returns Promise<ObliqueImage | undefined>

loadDataForCoordinate

• loadDataForCoordinate(mercatorCoordinate: Coordinate): Promise<void>

  Loads data for a given mercator Coordinate

  Parameters

  • mercatorCoordinate: Coordinate

    coordinate in web mercator

  Returns Promise<void>

loadDataForExtent

• loadDataForExtent(extent: Extent): Promise<void>

  Loads all data tiles in the given extent

  Parameters

  • extent: Extent

  Returns Promise<void>

loadImageForCoordinate

• loadImageForCoordinate(
      mercatorCoordinate: Coordinate,
      direction: ObliqueViewDirection,
  ): Promise<ObliqueImage | undefined>

  Loads all data for a location and then returns the closest image for the given location and direction (location and image extent must not overlap). Returns undefined, if there are no images for the given direction

  Parameters

  • mercatorCoordinate: Coordinate

    coordinate in web mercator

  • direction: ObliqueViewDirection

  Returns Promise<ObliqueImage | undefined>

toJSON

• toJSON(defaultOptions?: ObliqueCollectionOptions): ObliqueCollectionOptions

  Parameters

  • defaultOptions: ObliqueCollectionOptions = ...

  Returns ObliqueCollectionOptions

StaticgetDefaultOptions

• getDefaultOptions(): ObliqueCollectionOptions

  Returns ObliqueCollectionOptions

OptionaldatasourceId

imagesLoaded

viewOptions