DeckglLayerOptions

DeckglLayer构造函数options参数。

除下列字段外，其余键会原样传给 deck.Deck 作为 props，所以 deck 支持的 prop（getTooltip、parameters、effects …）都可以直接写在这里。但以下几个由图层接管，传了会被覆盖： gl、width、height、controller、useDevicePixels、_customRender、viewState。

interface DeckglLayerOptions {
    animation?: boolean;
    layers?: any[];
    maxZoom?: number;
    minZoom?: number;
    onDestroy?: (deck: any, layer: DeckglLayer) => void;
    onError?: (error: DeckglLayerError) => void;
    onInit?: (deck: any, layer: DeckglLayer) => void;
    opacity?: number;
    referCenter?: Point;
    renderStage?: "building" | "poi";
    visible?: boolean;
    zIndex?: number;
    [prop: string]: any;
}

Indexable

[prop: string]: any
其余 deck props 原样透传

属性

#animation?: boolean

是否每帧自动重绘。deck 自身的数据/动画就绪会通过内部机制唤起重绘，只有需要持续动画时才开，默认值：false

#layers?: any[]

deck.gl 图层数组

#maxZoom?: number

最大显示缩放等级，默认值：21

#minZoom?: number

最小显示缩放等级，默认值：3

#onDestroy?: (deck: any, layer: DeckglLayer) => void

图层销毁时回调，此时 Deck 还没 finalize

#onError?: (error: DeckglLayerError) => void

Deck 创建失败、deck.gl 自身报错或渲染抛错时回调。

deck.gl 自己的 onError 不会被透传给 deck.Deck —— 它抛出的原生 Error 会被归一化成 DeckglLayerError 再交给这里，避免同一个回调收到两种参数形状。

单帧渲染抛错是可恢复的：只累计次数、连续失败 30 帧才把图层置为 'error' 并停止绘制，控制台只报第一次

#onInit?: (deck: any, layer: DeckglLayer) => void

Deck 实例创建完成时回调

#opacity?: number

透明度。本图层不消费这个值 —— deck 的透明度请在各 deck 图层的 getFillColor / opacity 等 prop 上设，默认值：1

#referCenter?: Point

图层参考中心点。deck 用的是经纬度，本字段只影响与其他可视化图层一致的记账，对 deck 的绘制没有直接影响

#renderStage?: "building" | "poi"

绘制阶段，图层绘制在该阶段之后（即叠在其上）。不设表示默认落点：覆盖物之后、3D 楼块之前

#visible?: boolean

是否显示，默认值：true

#zIndex?: number

显示层级，小的先画，默认值：1