@diamondlightsource/davidia
    Preparing search index...

    Interface ScatterPlotProps

    Props for the ScatterPlotProps component.

    interface ScatterPlotProps {
        batonProps?: BatonProps;
        colourMap?:
            | "Blues"
            | "Greens"
            | "Greys"
            | "Oranges"
            | "Purples"
            | "Reds"
            | "Turbo"
            | "Viridis"
            | "Inferno"
            | "Magma"
            | "Plasma"
            | "Cividis"
            | "Warm"
            | "Cool"
            | "Cubehelix"
            | "BuGn"
            | "BuPu"
            | "GnBu"
            | "OrRd"
            | "PuBuGn"
            | "PuBu"
            | "PuRd"
            | "RdPu"
            | "YlGnBu"
            | "YlGn"
            | "YlOrBr"
            | "YlOrRd"
            | "Rainbow"
            | "Sinebow"
            | "HSL"
            | "BrBG"
            | "PRGn"
            | "PiYG"
            | "PuOr"
            | "RdBu"
            | "RdGy"
            | "RdYlBu"
            | "RdYlGn"
            | "Spectral";
        customToolbarChildren?: ReactNode;
        domain?: Domain;
        plotConfig: PlotConfig;
        pointSize?: number;
        pointValues: NDT;
        selectionOptions?: SelectionOptions;
        selections?: SelectionBase[];
        selectionsListener?: SelectionsEventListener;
        setPointSize?: (p: number) => void;
        updateSelection?: SelectionHandler | null;
        x: NDT;
        y: NDT;
    }

    Hierarchy (View Summary)

    Index

    Properties

    batonProps? colourMap? customToolbarChildren? domain? plotConfig pointSize? pointValues selectionOptions? selections? selectionsListener? setPointSize? updateSelection? x y

    Properties

    batonProps?: BatonProps

    The baton props

    colourMap?:
        | "Blues"
        | "Greens"
        | "Greys"
        | "Oranges"
        | "Purples"
        | "Reds"
        | "Turbo"
        | "Viridis"
        | "Inferno"
        | "Magma"
        | "Plasma"
        | "Cividis"
        | "Warm"
        | "Cool"
        | "Cubehelix"
        | "BuGn"
        | "BuPu"
        | "GnBu"
        | "OrRd"
        | "PuBuGn"
        | "PuBu"
        | "PuRd"
        | "RdPu"
        | "YlGnBu"
        | "YlGn"
        | "YlOrBr"
        | "YlOrRd"
        | "Rainbow"
        | "Sinebow"
        | "HSL"
        | "BrBG"
        | "PRGn"
        | "PiYG"
        | "PuOr"
        | "RdBu"
        | "RdGy"
        | "RdYlBu"
        | "RdYlGn"
        | "Spectral"

    The colour map (optional)

    customToolbarChildren?: ReactNode

    Children to customize the toolbar. If undefined then use default toolbar, if null, disable toolbar, otherwise use given children

    domain?: Domain

    The domain of the z axis

    plotConfig: PlotConfig

    The plot configuration

    pointSize?: number

    The size of the data points

    pointValues: NDT

    The values at each point in the scatter plot

    selectionOptions?: SelectionOptions

    Selection type options and limits (0 = limitless)

    selections?: SelectionBase[]

    The selections

    selectionsListener?: SelectionsEventListener

    Selections event listener

    setPointSize?: (p: number) => void

    Function to update data point size

    updateSelection?: SelectionHandler | null

    Handles adding selection (set null to disable editing)

    x: NDT

    The x values for the scatter plot

    y: NDT

    The y values for the scatter plot

    Settings

    Member Visibility

    On This Page

    Properties