Class VectorTileSource

A Vector Tile source. Uses OpenLayers styles.

Example

const apiKey = 'my api key';
const vectorTileSource = new VectorTileSource({
    url: `${'https://{a-d}.tiles.mapbox.com/v4/mapbox.mapbox-streets-v6/{z}/{x}/{y}.vector.pbf?access_token='}${apiKey}`,
    style: new Style(...), // Pass an OpenLayers style here
    backgroundColor: 'hsl(47, 26%, 88%)',
});

Hierarchy (view full)

Constructors

constructor

Properties

backgroundColor containsFn datatype flipY isImageSource isVectorTileSource source style type version

Accessors

colorSpace

Methods

adjustExtentAndPixelSize contains dispose getCrs getExtent getImages getMemoryUsage initialize intersects update

Constructors

constructor

Properties

Readonly backgroundColor

backgroundColor: string

Readonly containsFn

containsFn: CustomContainsFn

datatype

datatype: TextureDataType

Gets the datatype of images generated by this source.

Readonly flipY

flipY: boolean

Gets whether images generated from this source should be flipped vertically.

Readonly isImageSource

isImageSource: boolean = true

Readonly isVectorTileSource

isVectorTileSource: boolean = true

Readonly source

source: VectorTile

Readonly style

style: Style | StyleFunction

type

type: string

version

version: number

Accessors

colorSpace

  • get colorSpace(): ColorSpace

  • Gets the color space of the textures generated by this source.

    Returns ColorSpace

Methods

adjustExtentAndPixelSize

  • adjustExtentAndPixelSize(requestExtent, requestWidth, requestHeight, margin?): {
        extent: Extent;
        height: number;
        width: number;
    }

  • Returns an adjusted extent, width and height so that request pixels are aligned with source pixels, and requests do not oversample the source.

    Parameters

    • requestExtent: Extent

      The request extent.

    • requestWidth: number

      The width, in pixels, of the request extent.

    • requestHeight: number

      The height, in pixels, of the request extent.

    • margin: number = 0

      The margin, in pixels, around the initial extent.

    Returns {
        extent: Extent;
        height: number;
        width: number;
    }

    The adjusted parameters.

    • extent: Extent
    • height: number
    • width: number

contains

  • contains(extent): boolean

  • Gets whether this source contains the specified extent. If a custom contains function is provided, it will be used. Otherwise, intersects is used.

    This method is mainly used to discard non-relevant requests (i.e don't process regions that are not relevant to this source).

    Parameters

    • extent: Extent

      The extent to test.

    Returns boolean

dispose

getCrs

getExtent

getImages

getMemoryUsage

initialize

  • initialize(options): Promise<void>

  • Initializes the source.

    Parameters

    • options: {
          targetProjection: string;
      }

      Options.

      • targetProjection: string

        The target projection. Only useful for sources that are able to reproject their data on the fly (typically vector sources).

    Returns Promise<void>

    A promise that resolves when the source is initialized.

intersects

  • intersects(extent): boolean

  • Test the intersection between the specified extent and this source's extent. This method may be overriden to perform special logic.

    Parameters

    • extent: Extent

      The extent to test.

    Returns boolean

    true if the extent and this source extent intersects, false otherwise.

update

Settings

Member Visibility

On This Page

constructorbackgroundColorcontainsFndatatypeflipYisImageSourceisVectorTileSourcesourcestyletypeversioncolorSpaceadjustExtentAndPixelSizecontainsdisposegetCrsgetExtentgetImagesgetMemoryUsageinitializeintersectsupdate