API (v2.0.0) - Giro3D
    Preparing search index...

    Interface UrlImageSourceOptions

    Constructor options for UrlImageSource.

    interface UrlImageSourceOptions {
        colorSpace?: ColorSpace;
        containsFn?: CustomContainsFn;
        crs?: CoordinateSystem;
        enableWorkers?: boolean;
        extent?: Extent;
        flipY?: boolean;
        format?: ImageFormat;
        httpTimeout?: number;
        is8bit?: boolean;
        noDataValue?: number;
        requestPriority?: RequestPriority;
        retries?: number;
        synchronous?: boolean;
        transparent?: boolean;
        urlTemplate: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    colorSpace? containsFn? crs? enableWorkers? extent? flipY? format? httpTimeout? is8bit? noDataValue? requestPriority? retries? synchronous? transparent? urlTemplate

    Properties

    colorSpace?: ColorSpace

    The custom color space of the generated textures. See https://threejs.org/docs/#manual/en/introduction/Color-management for more information. If unspecified, the source considers that 8-bit images are in the sRGB color space, otherwise NoColorSpace.

    containsFn?: CustomContainsFn

    The custom function to test if a given extent is contained in this source. Note: we assume this function accepts extents in this source's CRS.

    crs?: CoordinateSystem

    The Coordinate Reference System of the image. If unspecified, will assume that the desired coordinate system is the one of the entity that contains the layer.

    enableWorkers?: boolean

    Enable web workers.

    true
    extent?: Extent

    The optional extent to use.

    flipY?: boolean

    Should images be flipped vertically during composition ?

    format?: ImageFormat

    The image format decoder to use. Note: for jpeg, png and webp images, no format decoder is required.

    httpTimeout?: number

    The optional HTTP request timeout, in milliseconds.

    5000
    is8bit?: boolean

    The data type of images generated. For regular color images, this should be true. For images with a high dynamic range, or images that requires additional processing, this should be false.

    noDataValue?: number

    The optional no-data value.

    requestPriority?: RequestPriority

    The relative priority of HTTP requests emitted by this source.

    'auto'

    retries?: number

    How many retries to execute when an HTTP request ends up in error.

    3
    synchronous?: boolean

    Is this source able to generate images synchronously ?

    transparent?: boolean

    Should the generated images be considered transparent ?

    false
    urlTemplate: string

    The URL template to use for image requests. Parameters to substitute must be enclosed in braces, e.g {minx}. Supported parameters:

    • {minx}: The min X (leftmost side) value of the requested extent.
    • {maxx}: The max X (rightmost side) value of the requested extent.
    • {miny}: The min Y (bottom side) value of the requested extent.
    • {maxy}: The max Y (top side) value of the requested extent.
    • {width}: The width, in pixels, of the requested image.
    • {height}: The height, in pixels, of the requested image.
    • {epsgCode}: The numerical code of the request coordinate system. For example, if the instance coordinate system is EPSG:3857, {epsgCode} will be substituted with the 3857 value.
    // A typical GetMap WMS pattern
    const wmsTemplate: "http://example.com?SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&LAYERS=MyLayer&STYLES=&SRS=EPSG:{epsgCode}&BBOX={minx},{miny},{maxx},{maxy}&WIDTH={width}&HEIGHT={height}&FORMAT=image/png"

    Settings

    Member Visibility

    On This Page

    Properties