@three-tile/plugin
    Preparing search index...

    Class MapBoxSource

    MapBox datasource

    Hierarchy

    • TileSource
      • MapBoxSource

    Indexable

    • [key: string]: unknown

      Any data

    Index

    Constructors

    constructor

    Properties

    _projectionBounds attribution bounds? dataType format isTMS maxLevel minLevel opacity projectionID style subdomains token transparent url

    Methods

    getUrl create

    Constructors

    Properties

    _projectionBounds

    _projectionBounds: [number, number, number, number]

    Projected data bounds

    attribution: string = "MapBox"

    Copyright attribution information for the data source, used for displaying map copyright notices

    bounds?: [number, number, number, number]

    Data bounds in format [minLon, minLat, maxLon, maxLat]. Default is undefined

    dataType: string

    Data type that determines which loader to use for loading and processing data. Default is "image" type

    format: string = "webp"
    isTMS: boolean

    Whether to use TMS tile coordinate system. Default false uses XYZ system, true uses TMS system

    maxLevel: number = 19

    Maximum zoom level supported by the data source. Default is 18

    minLevel: number

    Minimum zoom level supported by the data source. Default is 0

    opacity: number

    material opacity. Range 0-1, default is 1.0 (completely opaque)

    projectionID: ProjectionType

    Data projection type. Default is "3857" Mercator projection

    style: string = "mapbox.satellite"
    subdomains: string | string[]

    List of URL subdomains for load balancing. Can be an array of strings or a single string

    token: string = ""
    transparent: boolean

    Whether the material is transparent. Default is true (transparent)

    url: string = "https://api.mapbox.com/v4/{style}/{z}/{x}/{y}.{format}?access_token={token}"

    URL template for tile data. Uses variables like {x},{y},{z} to construct tile request URLs

    Methods

    • Get url from tile coordinate, public, overwrite to custom generation tile url from xyz

      Parameters

      • x: number

        tile x coordinate

      • y: number

        tile y coordinate

      • z: number

        tile z coordinate

      • Optionalobj: { [name: string]: any }

      Returns string | undefined

      url tile url

    • Create source directly through factoy functions.

      Parameters

      • options: SourceOptions

        source options

      Returns TileSource

      ISource data source instance

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods