cesium-spatial
    Preparing search index...

    Interface S2ViewLayerOptions

    Options for S2ViewLayer.

    interface S2ViewLayerOptions {
        allowPicking?: boolean;
        asynchronous?: boolean;
        cameraChangeThreshold?: number;
        clampToGround?: boolean;
        classificationType?: ClassificationType;
        color?: Color;
        debounceMs?: number;
        extrudedHeight?: number;
        height?: number;
        level?: number;
        maxCells?: number;
        maxLevel?: number;
        minLevel?: number;
        onUpdate?: (result: CellsInViewResult) => void;
        outlineColor?: Color;
        outlineMaxEdgeMeters?: number;
        outlines?: boolean;
        outlineWidth?: number;
        selector?: LevelSelector;
        show?: boolean;
        style?: CellStyleFunction;
        targetEdgePixels?: number;
        translucent?: boolean;
    }

    Hierarchy (View Summary)

    Index
    allowPicking? asynchronous? cameraChangeThreshold? clampToGround? classificationType? color? debounceMs? extrudedHeight? height? level? maxCells? maxLevel? minLevel? onUpdate? outlineColor? outlineMaxEdgeMeters? outlines? outlineWidth? selector? show? style? targetEdgePixels? translucent?
    allowPicking?: boolean

    Whether cells respond to picking. Defaults to true.

    asynchronous?: boolean

    Build geometry off the main thread over several frames. Defaults to true.

    cameraChangeThreshold?: number

    How much the camera must move before Cesium reports a change, as a fraction of the viewport. Defaults to 0.1.

    clampToGround?: boolean

    Drape cells over terrain instead of drawing them on the ellipsoid.

    classificationType?: ClassificationType

    What clamped cells classify. Defaults to ClassificationType.BOTH.

    color?: Color

    Fill color for cells the style function does not cover.

    debounceMs?: number

    Quiet period after camera movement before recomputing, in milliseconds. Defaults to 120.

    extrudedHeight?: number

    Default top height in meters, producing prisms. Ignored when clamped.

    height?: number

    Default base height in meters. Ignored when clampToGround is set.

    level?: number

    Use this level instead of deriving one from the camera.

    maxCells?: number

    Upper bound on returned cells. Defaults to 20000.

    maxLevel?: number

    Clamp to at most this level.

    minLevel?: number

    Clamp to at least this level.

    onUpdate?: (result: CellsInViewResult) => void

    Called after every recompute, with the cells and level chosen.

    outlineColor?: Color

    Outline color for cells the style function does not cover.

    outlineMaxEdgeMeters?: number

    Longest outline segment before extra vertices are inserted, in meters.

    outlines?: boolean

    Draw cell outlines in a companion polyline primitive. Off by default.

    outlineWidth?: number

    Outline width in pixels.

    selector?: LevelSelector

    A LevelSelector to derive the level through, so repeated calls get hysteresis. Ignored when level is given.

    show?: boolean

    Initial visibility.

    style?: CellStyleFunction

    Per-cell style resolver, consulted on every build and restyle.

    targetEdgePixels?: number

    Target on-screen size of one cell edge, in pixels. Larger values mean fewer, bigger cells. Defaults to 64.

    translucent?: boolean

    Allow translucent fills. Costs a depth-sorted pass, so it is opt-in.

    Settings
    Member Visibility

    On This Page
    Properties