Action

The action module is used to assign Specviz commands to various user actions. This module requires the use of an Input context. See the Interactive Spectrogram demo for guidance.

Components

function Provider(props: ProviderProps): JSX.Element

Functions

function useContext(): Context

Types

type Handler = {
  onClick: (useMouseEvent: {
    unit: Vector2.Vector2
    rel: Vector2.Vector2
    abs: Vector2.Vector2
    xaxis: Axis.Axis
    yaxis: Axis.Axis
    event: React.MouseEvent
  }) => void
  onContextMenu: (useMouseEvent: {
    unit: Vector2.Vector2
    rel: Vector2.Vector2
    abs: Vector2.Vector2
    xaxis: Axis.Axis
    yaxis: Axis.Axis
    event: React.MouseEvent
  }) => void
  onDrag: (useMouseEvent: {
    unit: Rect.Rect
    rel: Rect.Rect
    abs: Rect.Rect
    xaxis: Axis.Axis
    yaxis: Axis.Axis
    event: React.MouseEvent
  }) => void
  onRect: UseMouseRectHandler(useMouseEvent: {
    dx: number
    dy: number
    event: React.MouseEvent
  }) => void
  onWheel: (useMouseEvent: {
    dx: number
    dy: number
    event: React.MouseEvent
  }) => void
}

type Context = UseMouseProps

type ProviderProps = Context & {
  children: React.ReactNode
}