@vcmap/core
    Preparing search index...

    Class PanoramaDatasetLayer

    VectorTileLayer Layer for tiled vector Data. Can be connected to data with a TileProvider

    Hierarchy (View Summary)

    Index

    Accessors

    active allowPicking attributeProvider className defaultStyle exclusive exclusiveGroups globalHider headers hiddenObjectIds hideInPanorama ignoreMapLayerTypes initialized loading locale mapNames renderer splitDirection state style url zIndex className

    Constructors

    constructor

    Methods

    activate clearStyle createImplementationsForMap createPanoramaImage deactivate destroy forceRedraw getClosestImage getExtent getImplementationOptions getImplementations getImplementationsForMap getLogger getStyleOrDefaultStyle getZoomToExtent initialize isSupported mapActivated mapDeactivated reload removedFromMap setGlobalHider setStyle toJSON updateTiles getDefaultOptions

    Properties

    _defaultStyle _headers? _supportedMaps _url [moduleIdSymbol]? activeOnStartup baseLevel baseUrl cameraOffset copyright datasourceId? exclusiveGroupsChanged extent featureProvider featureVisibility highlightStyle isDestroyed mapNamesChanged name properties splitDirectionChanged stateChanged styleChanged tileProvider vectorProperties zIndexChanged

    Accessors

    • get className(): string

      Returns string

    • get exclusive(): boolean

      Indicates, that this layer is part of an exclusiveGroup

      Returns boolean

    • get exclusiveGroups(): (string | symbol)[]

      An array of arbitrary exclusive groups

      Returns (string | symbol)[]

    • set exclusiveGroups(groups: (string | symbol)[]): void

      Parameters

      • groups: (string | symbol)[]

      Returns void

    • get headers(): Record<string, string> | undefined

      directly manipulating the headers Object will not trigger a reload. Reload the data via layer.reload() manually.

      Returns Record<string, string> | undefined

    • set headers(headers: Record<string, string> | undefined): void

      Parameters

      • headers: Record<string, string> | undefined

      Returns void

    • get hiddenObjectIds(): string[]

      Returns string[]

    • set hiddenObjectIds(hiddenObjectIds: string[]): void

      Parameters

      • hiddenObjectIds: string[]

      Returns void

    • get ignoreMapLayerTypes(): boolean

      Returns boolean

    • set ignoreMapLayerTypes(value: boolean): void

      if set to true, the layer types of the map will be ignored when checking if the layer is supported. Changes will call reload on the layer.

      Parameters

      • value: boolean

      Returns void

    • get initialized(): boolean

      True if this layer has been initialized, typically after its first activation.

      Returns boolean

    • get locale(): string

      returns the currently set locale. Can be used to provide locale specific URLs.

      Returns string

    • set locale(value: string): void

      returns the currently set locale. Can be used to provide locale specific URLs.

      Parameters

      • value: string

      Returns void

    • get mapNames(): string[]

      Returns string[]

    • set mapNames(mapNames: string[]): void

      if provided, the layer will only be shown in the given MapNames. An empty array will show the layer in all configured maps. Changes will call reload on the layer.

      Parameters

      • mapNames: string[]

      Returns void

    • get splitDirection(): SplitDirection

      The splitDirection to be applied - for 3D vector features currently only working on points with a Model

      Returns SplitDirection

    • set splitDirection(direction: SplitDirection): void

      Parameters

      • direction: SplitDirection

      Returns void

    • get url(): string

      A layers url, should on be configured, else an empty string

      Returns string

    • set url(url: string | Record<string, string>): void

      Parameters

      • url: string | Record<string, string>

      Returns void

    • get zIndex(): number

      Returns number

    • set zIndex(index: number): void

      Parameters

      • index: number

      Returns void

    Constructors

    Methods

    • Activates this layer object, i.e. changes its internal view state and updates the map. The returned promise resolves, once the layer & any _implementations are initialized and all data is loaded. Once the promise resolves, the layer can still be inactive, if deactivate was called while initializing the layer.

      Returns Promise<void>

    • Creates a panorama image with the given name, if it belongs to this dataset. Will cache the image for later use.

      Parameters

      • name: string
      • Optionaltime: Date

        optional time for the image.

      Returns Promise<PanoramaImage>

    • destroys all current implementations and recreates the ones which have an active map. called for instance when the URL for a layer changes

      Returns Promise<void>

    • Returns the closes image name to the coordinate within the given distance & the distance squared to the coordinate.

      Parameters

      • coordinate: Coordinate

        in web mercator

      • maxDistance: number = 200

        in meters

      Returns Promise<{ distanceSqrd: number; imageName: string; time?: Date } | undefined>

      • the closest image name and the distance squared to the coordinate

    • is called from the map when the map is activated, and this layer is in the layerCollection of the map. Will create an implementation if it does not exits and will forward the activation call to the implementation.

      Parameters

      Returns Promise<void>

    • is called from the map when the map is deactivated, and this layer is in the layerCollection of the map. will forward deactivation call to the map specific implementation

      Parameters

      Returns void

    Properties

    Protected_defaultStyle

    _defaultStyle: StyleItem

    Protected Optional_headers

    _headers?: Record<string, string>

    Protected_supportedMaps

    _supportedMaps: string[]

    The class names of the supported maps.

    Protected_url

    _url: string | Record<string, string> | undefined
    "[moduleIdSymbol]"?: string
    activeOnStartup: boolean
    baseLevel: number
    baseUrl: string
    cameraOffset: number
    copyright: CopyrightOptions | undefined
    datasourceId?: string

    Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.

    exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>

    event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument

    extent: Extent | null
    featureProvider: AbstractFeatureProvider | AbstractAttributeProvider | undefined

    An optional feature or attribute provider to provide or augment features on click events.

    featureVisibility: FeatureVisibility

    FeatureVisibility tracks the highlighting and hiding of features on this layer

    highlightStyle: VectorStyleItem | undefined
    isDestroyed: boolean
    mapNamesChanged: VcsEvent<string[]> = ...
    name: string

    unique Name

    properties: Record<string, unknown>
    splitDirectionChanged: VcsEvent<SplitDirection> = ...

    raised if the split direction changes, is passed the split direction as its only argument

    stateChanged: VcsEvent<LayerState>

    Event raised, if the layers state changes. Is passed the LayerState as its only parameter

    styleChanged: VcsEvent<StyleItem> = ...

    An event, called when the style of the layer changes. Is passed the new style item as its value.

    tileProvider: FlatGeobufTileProvider
    vectorProperties: VectorProperties

    at the moment only used for allowPicking, triggers a reload on change

    zIndexChanged: VcsEvent<number>

    Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods
    Properties