@diamondlightsource/davidia
    Preparing search index...

    Interface PlotCustomizationContextValue

    Value for a PlotCustomization context.

    interface PlotCustomizationContextValue {
        allLineParams: Map<string, LineParams>;
        aspect: Aspect;
        batonProps: BatonProps;
        canSelect: boolean;
        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";
        currentLineKey: null
        | string;
        dCustomDomain: CustomDomain;
        dDomain: Domain;
        dScaleType: ColorScaleType;
        histogram?: HistogramParams;
        invertColourMap: boolean;
        mode: InteractionModeType;
        plotType: PlotType;
        scatterPointSize: number;
        selections: SelectionBase[];
        selectionType: SelectionType;
        setAllLineParams: (params: Map<string, LineParams>) => void;
        setAspect: (a: Aspect) => void;
        setColourMap: (
            c:
                | "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",
        ) => void;
        setCurrentLineKey: (k: string) => void;
        setDCustomDomain: (d: CustomDomain) => void;
        setDScaleType: (s: ColorScaleType) => void;
        setHistogram: (histogram: HistogramParams) => void;
        setMode: (m: InteractionModeType) => void;
        setScatterPointSize: (p: number) => void;
        setSelections: (s: SelectionBase[]) => void;
        setSelectionType: (s: SelectionType) => void;
        setTitle: (t: string) => void;
        setXCustomDomain: (d: CustomDomain) => void;
        setXLabel: (l: string) => void;
        setXScaleType: (s: AxisScaleType) => void;
        setYCustomDomain: (d: CustomDomain) => void;
        setYLabel: (l: string) => void;
        setYScaleType: (s: AxisScaleType) => void;
        showGrid: boolean;
        showPoints: boolean;
        title: string;
        toggleInvertColourMap: () => void;
        toggleShowGrid: () => void;
        toggleShowPoints: () => void;
        updateLineParams: (key: string, params: LineParams) => void;
        updateSelection: SelectionHandler;
        xCustomDomain: CustomDomain;
        xDomain: Domain;
        xLabel: string;
        xScaleType: AxisScaleType;
        yCustomDomain: CustomDomain;
        yDomain: Domain;
        yLabel: string;
        yScaleType: AxisScaleType;
    }
    Index

    Properties

    allLineParams aspect batonProps canSelect colourMap currentLineKey dCustomDomain dDomain dScaleType histogram? invertColourMap mode plotType scatterPointSize selections selectionType setAllLineParams setAspect setColourMap setCurrentLineKey setDCustomDomain setDScaleType setHistogram setMode setScatterPointSize setSelections setSelectionType setTitle setXCustomDomain setXLabel setXScaleType setYCustomDomain setYLabel setYScaleType showGrid showPoints title toggleInvertColourMap toggleShowGrid toggleShowPoints updateLineParams updateSelection xCustomDomain xDomain xLabel xScaleType yCustomDomain yDomain yLabel yScaleType

    Properties

    allLineParams: Map<string, LineParams>

    Map of line parameters

    aspect: Aspect

    An aspect value

    batonProps: BatonProps

    The baton properties

    canSelect: boolean

    Can select

    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"

    A color map

    currentLineKey: null | string

    current line key

    dCustomDomain: CustomDomain

    A custom domain value for the d-axis

    dDomain: Domain

    A domain value for the d-axis

    dScaleType: ColorScaleType

    A color scale type for the d-axis

    histogram?: HistogramParams

    Histogram params

    invertColourMap: boolean

    Whether to invert the color map

    mode: InteractionModeType

    The mode

    plotType: PlotType

    Type of plot

    scatterPointSize: number

    The size of scatter data points.

    selections: SelectionBase[]

    Selections

    selectionType: SelectionType

    A selection type

    setAllLineParams: (params: Map<string, LineParams>) => void

    Set line parameters

    setAspect: (a: Aspect) => void

    A function that sets the aspect value

    setColourMap: (
        c:
            | "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",
    ) => void

    A function that sets the color map

    setCurrentLineKey: (k: string) => void

    A function that sets current line key

    setDCustomDomain: (d: CustomDomain) => void

    A function that sets the custom domain value for the d-axis

    setDScaleType: (s: ColorScaleType) => void

    A function that sets the color scale type for the d-axis

    setHistogram: (histogram: HistogramParams) => void

    Set heatmap histogram

    setMode: (m: InteractionModeType) => void

    An optional function that sets the mode

    setScatterPointSize: (p: number) => void

    A function that updates the selections

    setSelections: (s: SelectionBase[]) => void

    A function that sets the selections

    setSelectionType: (s: SelectionType) => void

    A function that sets the selection type

    setTitle: (t: string) => void

    A function that sets the title

    setXCustomDomain: (d: CustomDomain) => void

    A function that sets the custom domain value for the x-axis

    setXLabel: (l: string) => void

    A function that sets the label for the x-axis

    setXScaleType: (s: AxisScaleType) => void

    An optional function that sets the axis scale type for the x-axis

    setYCustomDomain: (d: CustomDomain) => void

    A function that sets the custom domain value for the y-axis

    setYLabel: (l: string) => void

    A function that sets the label for the y-axis

    setYScaleType: (s: AxisScaleType) => void

    A function that sets the axis scale type for the y-axis

    showGrid: boolean

    If the grid should be shown

    showPoints: boolean

    Whether to show points on surface

    title: string

    The title

    toggleInvertColourMap: () => void

    A function that toggles the color map inversion

    toggleShowGrid: () => void

    Toggles the grid

    toggleShowPoints: () => void

    A function that toggles the points

    updateLineParams: (key: string, params: LineParams) => void

    A function to update parameters in a line

    updateSelection: SelectionHandler

    A function that updates the selections

    xCustomDomain: CustomDomain

    A custom domain value for the x-axis

    xDomain: Domain

    A domain value for the x-axis

    xLabel: string

    The label for the x-axis

    xScaleType: AxisScaleType

    An axis scale type for the x-axis

    yCustomDomain: CustomDomain

    A custom domain value for the y-axis

    yDomain: Domain

    A domain value for the y-axis

    yLabel: string

    The label for the y-axis

    yScaleType: AxisScaleType

    An axis scale type for the y-axis

    Settings

    Member Visibility

    On This Page

    Properties