SDK JS
    Preparing search index...

    Interface PointCloudOptions

    Render options for PointCloudRenderer and StreamingPointCloudRenderer. Pass a partial set to the constructor or PointCloudRenderer.setOptions / StreamingPointCloudRenderer.setOptions; omitted fields keep their defaults.

    interface PointCloudOptions {
        attenuation?: boolean;
        classColors?: Readonly<Record<number, Rgb>>;
        colorMode: PointColorMode;
        colorRamp?: ColorRamp;
        edlRadius?: number;
        edlStrength?: number;
        eyeDomeLighting?: boolean;
        fixedPx: number;
        geometricErrorScale?: number;
        heightMax?: number;
        heightMin?: number;
        hiddenClasses: readonly number[];
        intensityBias: number;
        intensityScale: number;
        maximumAttenuation?: number;
        maxPx: number;
        minPx: number;
        pointRadiusM: number;
        roundPoints: boolean;
    }
    Index

    Properties

    attenuation? classColors? colorMode colorRamp? edlRadius? edlStrength? eyeDomeLighting? fixedPx geometricErrorScale? heightMax? heightMin? hiddenClasses intensityBias intensityScale maximumAttenuation? maxPx minPx pointRadiusM roundPoints

    Properties

    attenuation?: boolean

    Geometric-error point attenuation (Cesium PointCloudShading): size each point by its node's geometric error (≈ point spacing) so coarse/far points draw bigger and the cloud stays dense at distance instead of going sparse. Default false. (Streaming renderer only.)

    classColors?: Readonly<Record<number, Rgb>>

    Per-code colour overrides for classification mode, replacing the ASPRS default for those codes. Live GPU LUT update — no re-decode. Replaces the previous set wholesale (like hiddenClasses); pass {} to go back to the stock palette. Default none.

    colorMode: PointColorMode

    How points are colored. Default 'rgb' (single-shot) / 'intensity' (streaming).

    colorRamp?: ColorRamp

    Colour ramp for intensity and height mode. Live GPU LUT update — no re-decode. Omit, or pass undefined through setOptions, for the built-in Turbo ramp. Default Turbo.

    edlRadius?: number

    EDL neighbour ring radius (px). Default 1.4.

    edlStrength?: number

    EDL darkening strength. Default 80.

    eyeDomeLighting?: boolean

    Eye-dome lighting: a screen-space pass that shades depth gaps so a sparse cloud reads as a solid surface (Cesium/Potree EDL). Default false. (Streaming renderer only.)

    fixedPx: number

    Constant point diameter in CSS px; when > 0 it overrides perspective sizing.

    geometricErrorScale?: number

    Scale on the geometric error before projection (Cesium geometricErrorScale). Default 1.

    heightMax?: number

    height mode ramp ceiling, in world-space meters. Omit to auto-fit to the loaded cloud; explicitly undefined through setOptions goes BACK to auto-fitting.

    heightMin?: number

    height mode ramp floor, in world-space meters. Omit to auto-fit to the loaded cloud; explicitly undefined through setOptions goes BACK to auto-fitting.

    hiddenClasses: readonly number[]

    LAS classification codes to hide (live GPU mask update — no re-decode). Default [].

    intensityBias: number

    Additive offset for the intensity ramp (see intensityScale). Default 0.

    intensityScale: number

    Maps intensity u16 -> ramp t: t = i * intensityScale + intensityBias. Default 1/65535.

    maximumAttenuation?: number

    Attenuation point-size ceiling, CSS px (Cesium maximumAttenuation). Default 16.

    maxPx: number

    Upper clamp on the perspective point diameter, in CSS px. Default 64.

    minPx: number

    Lower clamp on the perspective point diameter, in CSS px. Default 1.

    pointRadiusM: number

    Physical point radius in meters, for perspective (1/z) sizing. Default 0.05.

    roundPoints: boolean

    Draw round (vs square) points. Default false.

    Settings

    Member Visibility

    On This Page

    Properties