Class GeoArrowScatterplotLayer<ExtraProps>

Type Parameters

  • ExtraProps extends {} = {}

Hierarchy (view full)

Constructors

Properties

context: LayerContext
count: number
id: string
lifecycle: Lifecycle
parent: default<{}>

Type declaration

    props: StatefulComponentProps<Omit<ScatterplotLayerProps<Table<any>>, "data" | "getPosition" | "getFillColor" | "getLineColor" | "getRadius"> & _GeoArrowScatterplotLayerProps & LayerProps & {
        _subLayerProps?: {
            [subLayerId: string]: {
                type?: ConstructorOf<default>;
                [propName: string]: any;
            };
        };
    } & ExtraProps & Required<CompositeLayerProps> & Required<LayerProps>>
    layerName: string

    Accessors

    • get isComposite(): boolean
    • true if this layer renders other layers

      Returns boolean

    • get isLoaded(): boolean
    • Returns true if all async resources are loaded

      Returns boolean

    • get root(): default<{}>
    • Returns default<{}>

    • get wrapLongitude(): boolean
    • Returns true if using shader-based WGS84 longitude wrapping

      Returns boolean

    • get componentName(): string
    • Returns string

    Methods

    • Parameters

      • __namedParameters: {
            moduleParameters: any;
            parameters: any;
            renderPass: RenderPass;
            uniforms: any;
        }
        • moduleParameters: any
        • parameters: any
        • renderPass: RenderPass
        • uniforms: any

      Returns void

    • (Internal) Called by manager when layer is about to be disposed Note: not guaranteed to be called on application shutdown

      Returns void

    • Returns void

    • (Internal) Called by layer manager when a new layer is added or an existing layer is matched with a new instance

      Returns void

    • Called when this layer is rendered into the given viewport

      Parameters

      Returns void

    • Parameters

      • color: any

      Returns number

    • (Internal) Sets the picking color at the specified index to null picking color. Used for multi-depth picking. This method may be overriden by layer implementations

      Parameters

      • objectIndex: number

      Returns void

    • Parameters

      • opts: any

      Returns void

    • Parameters

      • i: any
      • Optional target: number[]

      Returns number[]

    • Filters sub layers at draw time. Return true if the sub layer should be drawn.

      Parameters

      Returns boolean

    • Called once when layer is no longer matched and state will be discarded. Layers can destroy WebGL resources here.

      Parameters

      Returns void

    • Returns [number[], number[]]

    • Returns the default parse options for async props

      Returns any

    • Returns an array of models used by this layer, can be overriden by layer subclass

      Returns Model[]

    • (Internal) Checks if this layer needs redraw

      Parameters

      • Optional opts: {
            clearRedrawFlags: boolean;
        }
        • clearRedrawFlags: boolean

          Reset redraw flags to false after the check

      Returns string | false

    • Deduces number of instances. Intention is to support:

      • Explicit setting of numInstances
      • Auto-deduction for ES6 containers that define a size member
      • Auto-deduction for Classic Arrays via the built-in length attribute
      • Auto-deduction via arrays

      Returns number

    • Parameters

      • shaders: any

      Returns any

    • Buffer layout describes how many attribute values are packed for each data object The default (null) is one value each object. Some data formats (e.g. paths, polygons) have various length. Their buffer layout is in the form of [L0, L1, L2, ...]

      Returns NumericArray

    • Return last rendered sub layers

      Returns default<{}>[]

    • Checks if this layer has ongoing uniform transition

      Returns boolean

    • Called once to set up the initial state. Layers can create WebGL resources here.

      Parameters

      Returns void

    • Returns boolean

      Deprecated

      Returns true if the layer is visible in the picking pass

    • (Internal) Checks if this layer needs a deep update

      Returns boolean

    • Returns number[]

    • Parameters

      • info: {
            color: Uint8Array;
            coordinate?: number[];
            devicePixel?: [number, number];
            index: number;
            layer: default<{}>;
            object?: any;
            picked: boolean;
            pixel?: [number, number];
            pixelRatio: number;
            sourceLayer?: default<{}>;
            viewport?: default;
            x: number;
            y: number;
        }
        • color: Uint8Array
        • Optional coordinate?: number[]
        • Optional devicePixel?: [number, number]
        • index: number
        • layer: default<{}>
        • Optional object?: any
        • picked: boolean
        • Optional pixel?: [number, number]
        • pixelRatio: number
        • Optional sourceLayer?: default<{}>
        • Optional viewport?: default
        • x: number
        • y: number
      • pickingEvent: any

      Returns boolean

    • Parameters

      • info: {
            color: Uint8Array;
            coordinate?: number[];
            devicePixel?: [number, number];
            index: number;
            layer: default<{}>;
            object?: any;
            picked: boolean;
            pixel?: [number, number];
            pixelRatio: number;
            sourceLayer?: default<{}>;
            viewport?: default;
            x: number;
            y: number;
        }
        • color: Uint8Array
        • Optional coordinate?: number[]
        • Optional devicePixel?: [number, number]
        • index: number
        • layer: default<{}>
        • Optional object?: any
        • picked: boolean
        • Optional pixel?: [number, number]
        • pixelRatio: number
        • Optional sourceLayer?: default<{}>
        • Optional viewport?: default
        • x: number
        • y: number
      • pickingEvent: any

      Returns boolean

    • Projects a point with current view state from the current layer's coordinate system to screen

      Parameters

      • xyz: number[]

      Returns number[]

    • Projects a point with current view state from the current layer's coordinate system to the world space

      Parameters

      • xyz: number[]
      • Optional params: {
            autoOffset?: boolean;
            fromCoordinateOrigin?: [number, number, number];
            fromCoordinateSystem?: CoordinateSystem;
            viewport?: default;
        }
        • Optional autoOffset?: boolean

          Whether to apply offset mode automatically as does the project shader module. Offset mode places the origin of the common space at the given viewport's center. It is used in some use cases to improve precision in the vertex shader due to the fp32 float limitation. Use autoOffset:false if the returned position should not be dependent on the current viewport. Default true

        • Optional fromCoordinateOrigin?: [number, number, number]

          The coordinate origin that the supplied position is in. Default to the same as coordinateOrigin.

        • Optional fromCoordinateSystem?: CoordinateSystem

          The coordinate system that the supplied position is in. Default to the same as coordinateSystem.

        • Optional viewport?: default

          The viewport to use

      Returns [number, number, number]

    • (Internal) Propagate an error event through the system

      Parameters

      • error: Error
      • message: string

      Returns void

    • (Internal) Re-enable all picking indices after multi-depth picking

      Returns void

    • Dirty some change flags, will be handled by updateLayer

      Parameters

      Returns void

    • Update shader module parameters

      Parameters

      • moduleParameters: any

      Returns void

    • Sets the redraw flag for this layer, will trigger a redraw next animation frame

      Returns void

    • Mark this layer as needs a deep update

      Returns void

    • Update shader input parameters

      Parameters

      • Rest ...props: [props: Partial<{}>]

      Returns void

    • Updates selected state members and marks the composite layer to need rerender

      Parameters

      • updateObject: any

      Returns void

    • Returns string

    • Unprojects a screen pixel to the current view's default coordinate system Note: this does not reverse project.

      Parameters

      • xy: number[]

      Returns number[]

    • (Internal) Called by deck picker when the hovered object changes to update the auto highlight

      Parameters

      • info: {
            color: Uint8Array;
            coordinate?: number[];
            devicePixel?: [number, number];
            index: number;
            layer: default<{}>;
            object?: any;
            picked: boolean;
            pixel?: [number, number];
            pixelRatio: number;
            sourceLayer?: default<{}>;
            viewport?: default;
            x: number;
            y: number;
        }
        • color: Uint8Array
        • Optional coordinate?: number[]
        • Optional devicePixel?: [number, number]
        • index: number
        • layer: default<{}>
        • Optional object?: any
        • picked: boolean
        • Optional pixel?: [number, number]
        • pixelRatio: number
        • Optional sourceLayer?: default<{}>
        • Optional viewport?: default
        • x: number
        • y: number

      Returns void

    • Returns boolean

    • (Internal) called by layer manager to perform extra props validation (in development only)

      Returns void