--- layout: typedoc title: 'DeckProps | @msrvida/sanddance-react' ---

Type parameters

  • T = ContextProviderValue

Hierarchy

  • DeckProps

Index

Properties

Optional ContextProvider

ContextProvider: Provider<T>

_animate

_animate: boolean

_framebuffer

_framebuffer: any

_pickable

_pickable: boolean

_typedArrayManagerProps

_typedArrayManagerProps: { overAlloc?: number; poolSize?: number }

Type declaration

  • Optional overAlloc?: number
  • Optional poolSize?: number

Optional canvas

canvas: string | HTMLCanvasElement

controller

controller: boolean | default | ControllerOptions

debug

debug: boolean

effects

effects: default[]

gl

gl: WebGLRenderingContext

glOptions

glOptions: WebGLContextAttributes

height

height: string | number

id

id: string

initialViewState

initialViewState: InitialViewStateProps

layers

layers: (false | default<any, LayerProps<any>>)[]

parameters

parameters: object

parent

parent: HTMLElement

pickingRadius

pickingRadius: number

style

style: {}

Type declaration

touchAction

touchAction: string

useDevicePixels

useDevicePixels: number | boolean

userData

userData: any

viewState

viewState: ViewStateProps

views

views: default[]

width

width: string | number

Methods

_onMetrics

  • _onMetrics(metrics: MetricsPayload): void
  • Parameters

    • metrics: MetricsPayload

    Returns void

getCursor

  • getCursor(interactiveState: InteractiveState): string
  • Parameters

    • interactiveState: InteractiveState

    Returns string

getTooltip

  • getTooltip<D>(info: PickInfo<D>): string | { className?: string; html?: string; style?: {}; text?: string }
  • Type parameters

    • D

    Parameters

    Returns string | { className?: string; html?: string; style?: {}; text?: string }

layerFilter

  • layerFilter(args: { isPicking: boolean; layer: default<any, LayerProps<any>>; renderPass: string; viewport: default }): boolean
  • Parameters

    • args: { isPicking: boolean; layer: default<any, LayerProps<any>>; renderPass: string; viewport: default }
      • isPicking: boolean
      • layer: default<any, LayerProps<any>>
      • renderPass: string
      • viewport: default

    Returns boolean

onAfterRender

  • onAfterRender(args: { gl: WebGLRenderingContext }): void
  • Parameters

    • args: { gl: WebGLRenderingContext }
      • gl: WebGLRenderingContext

    Returns void

onBeforeRender

  • onBeforeRender(args: { gl: WebGLRenderingContext }): void
  • Parameters

    • args: { gl: WebGLRenderingContext }
      • gl: WebGLRenderingContext

    Returns void

onClick

  • onClick<D>(info: PickInfo<D>, e: MouseEvent): any
  • Type parameters

    • D

    Parameters

    Returns any

onDrag

  • onDrag<D>(info: PickInfo<D>, e: MouseEvent): any
  • Type parameters

    • D

    Parameters

    Returns any

onDragEnd

  • onDragEnd<D>(info: PickInfo<D>, e: MouseEvent): any
  • Type parameters

    • D

    Parameters

    Returns any

onDragStart

  • onDragStart<D>(info: PickInfo<D>, e: MouseEvent): any
  • Type parameters

    • D

    Parameters

    Returns any

onError

  • onError(error: Error, source: any): void
  • Parameters

    • error: Error
    • source: any

    Returns void

onHover

  • onHover<D>(info: PickInfo<D>, e: MouseEvent): any
  • Type parameters

    • D

    Parameters

    Returns any

onInteractionStateChange

  • onInteractionStateChange(interactionState: InteractionState): void
  • Parameters

    • interactionState: InteractionState

    Returns void

onLoad

  • onLoad(): void
  • Returns void

onResize

  • onResize(size: { height: number; width: number }): void
  • Parameters

    • size: { height: number; width: number }
      • height: number
      • width: number

    Returns void

onViewStateChange

  • onViewStateChange(args: { interactionState: InteractionState; oldViewState: any; viewState: any }): any
  • Parameters

    • args: { interactionState: InteractionState; oldViewState: any; viewState: any }
      • interactionState: InteractionState
      • oldViewState: any
      • viewState: any

    Returns any

onWebGLInitialized

  • onWebGLInitialized(gl: WebGLRenderingContext): any
  • Parameters

    • gl: WebGLRenderingContext

    Returns any