BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    Type Alias GisLayer

    A GIS layer definition for Viewer3d.addGisLayer

    type GisLayer = {
        concurrency?: number;
        contentRevision?: string | number;
        coordinateMode?: "GEOGRAPHIC" | "LOCAL";
        description?: string;
        faceColor?: string | number[];
        fetchContent?: (viewRegion: unknown) => Promise<unknown>;
        heightDatum?: "orthometric" | "ellipsoid";
        heightOffsetMeters?: number;
        humanUrl?: string;
        icon?: string;
        id?: string;
        layerJsonUrl?: string;
        lod?: string | number;
        maxTiles?: number;
        maxZoomLevel?: number;
        name: string;
        opacity?: number;
        regions?: string[];
        regionZoom?: number;
        renderTileBorder?: boolean;
        snapToZero?: boolean;
        source?: string;
        terrain?: string;
        tileSizePixels?: number;
        translationMm?: vec3;
        type: "3DTILES" | "WMS" | "TMS" | "TERRAIN" | "WMTS" | "UPLOADED_GIS";
        url?: URL | string;
        urlBuilder?: (
            settings: unknown,
            zoom: number,
            x: number,
            y: number,
        ) => string;
        version?: string;
        visible?: boolean;
        visibleInMenu?: boolean;
        zoomOffset?: number;
    }
    Index

    Properties

    concurrency? contentRevision? coordinateMode? description? faceColor? fetchContent? heightDatum? heightOffsetMeters? humanUrl? icon? id? layerJsonUrl? lod? maxTiles? maxZoomLevel? name opacity? regions? regionZoom? renderTileBorder? snapToZero? source? terrain? tileSizePixels? translationMm? type url? urlBuilder? version? visible? visibleInMenu? zoomOffset?

    Properties

    concurrency?: number

    TERRAIN: parallel tile requests (default 8)

    contentRevision?: string | number

    UPLOADED_GIS: changes when the content changes, so cached content is refetched

    coordinateMode?: "GEOGRAPHIC" | "LOCAL"

    UPLOADED_GIS: "GEOGRAPHIC" (WGS84 content placed by the georeference) or "LOCAL" (model coordinates)

    description?: string
    faceColor?: string | number[]

    TERRAIN loaded on its own: face colour as "#RRGGBB" or [r, g, b] in 0..1 (default light blue, #ADD8E6)

    fetchContent?: (viewRegion: unknown) => Promise<unknown>

    UPLOADED_GIS: fetches the content for a view region

    heightDatum?: "orthometric" | "ellipsoid"

    TERRAIN and 3DTILES: what the service's heights are measured from. "ellipsoid" (the Cesium convention, e.g. 3D BAG) makes the viewer subtract the geoid height of its embedded tables (the Netherlands today) before the placement; outside the tables a terrain snaps to the model instead and a tile set keeps its heights (with a warning), unless heightOffsetMeters is given. Default "orthometric": national-datum heights, no shift (EHR)

    heightOffsetMeters?: number

    TERRAIN and 3DTILES: constant added to the service's heights before the placement (e.g. minus the geoid undulation of an ellipsoidal service); a terrain's snap placement ignores it, a tile set applies it under both policies

    humanUrl?: string
    icon?: string
    id?: string

    Default the id addGisLayer is given

    layerJsonUrl?: string

    TERRAIN: explicit URL of the layer metadata; default url + "layer.json", then url?f=json (OGC API services)

    lod?: string | number

    UPLOADED_GIS (CityJSON): the level of detail to show

    maxTiles?: number

    TERRAIN: cap on tiles fetched per load (default 400)

    maxZoomLevel?: number

    Imagery: the Web Mercator zoom of the tiles. TERRAIN: the preferred quantized-mesh level (default 17); it is lowered until maxTiles fits

    name: string
    opacity?: number

    0..1, default 1 (opaque); applied to every (re)build of the layer, change it with Viewer3d.setGisLayerOpacity

    regions?: string[]

    Region codes shown as flags in the GIS panel, e.g. "NL", "EE", "WORLD"

    regionZoom?: number

    TERRAIN loaded on its own: Web Mercator zoom whose 23x23-tile footprint the mesh covers (default 18, the same area as the national orthophotos)

    renderTileBorder?: boolean
    snapToZero?: boolean

    Flat layers: put the plane at the model's lowest point (default true without terrain). With terrain: lift the terrain under the origin to the model's lowest point instead of using the georeference elevation. 3DTILES: put the set's height 0 at the model's lowest point (default true) instead of placing the tiles by the georeference elevation

    source?: string
    terrain?: string

    Imagery (TMS, WMS, WMTS): id of a TERRAIN layer to drape over. Switching the imagery on switches that terrain on; while the terrain is on the imagery drapes over it, switching the terrain off flattens the imagery. Without a reference the layer drapes over whichever TERRAIN layer is visible. A terrain that imagery drapes over is not drawn on its own (terrain fusion)

    tileSizePixels?: number
    translationMm?: vec3
    type: "3DTILES" | "WMS" | "TMS" | "TERRAIN" | "WMTS" | "UPLOADED_GIS"

    TERRAIN layers carry no imagery: on their own they are drawn flat-shaded in faceColor; as the terrain companion of a TMS layer they drape that layer's tiles. UPLOADED_GIS: vector content the server prepared (GeoJSON, CityJSON, KLIC files, OGC API features), fetched with fetchContent

    url?: URL | string
    urlBuilder?: (settings: unknown, zoom: number, x: number, y: number) => string
    version?: string
    visible?: boolean
    visibleInMenu?: boolean

    false hides the layer from the legacy GIS window

    zoomOffset?: number

    Settings

    Member Visibility

    On This Page

    Properties