ScatterPlotComponentProps

Index

Constructors

• constructor

Properties

• colorRangeEnd
• comments
• cursorHitRadius
• cursorIndicatorStyle
• cursorNearestPoint
• cursorNearestPointAt
• cursorXY
• customExportData
• customExportImage
• data
• dataBackgroundColor
• dataStat
• dragAction
• exportRightPadding
• exportTitle
• extraPluginOptions
• graphClicked
• graphCursorMoved
• graphRightClicked
• graphSelectionReset
• graphZoomedX
• graphZoomedXY
• graphZoomedY
• graphZoomReset
• height
• imageName
• indicatorInteractionChannel
• isDarkMode
• isGroupSubPlot
• isLogY
• isZIndex
• lineColor
• mouseEntered
• multiPlotPropsMap
• onBoxSelected
• onLassoSelected
• opacity
• plotName
• plotType
• pointRadius
• renderOverlay
• shouldAlignChartAreaRight
• shouldScrollZoom
• shouldShowLegend
• shouldShowTopAxis
• shouldShowXAxisLabel
• shouldShowXAxisTicks
• shouldShowZeroLine
• tickTypeX
• tickTypeY
• toolbarChildren
• topAxisTickFormatter
• updateChartArea
• width
• xLabel
• xMax
• xMin
• xTickMarkLength
• xZeroLineColor
• yLabel
• yMax
• yMin
• yZeroLineColor
• zeroLineWidth

Constructors

constructor

• ScatterPlotComponentProps(): ScatterPlotComponentProps

• Returns ScatterPlotComponentProps

Properties

optionalcolorRangeEnd

colorRangeEnd?: number

optionalcomments

comments?: string[]

optionalcursorHitRadius

cursorHitRadius?: number

optionalcursorIndicatorStyle

cursorIndicatorStyle?: ring | crosshair

optionalcursorNearestPoint

cursorNearestPoint?: { x: number; y: number }

Type declaration

• x: number

• y: number

optionalcursorNearestPointAt

cursorNearestPointAt?: (x: number, y: number) => { x: number; y: number } | undefined

Type declaration

• • (x: number, y: number): { x: number; y: number } | undefined

  • Parameters

    • x: number

    • y: number

    Returns { x: number; y: number } | undefined

optionalcursorXY

cursorXY?: { image: Point3D; profiler: Point3D; unit: string }

Type declaration

• image: Point3D

• profiler: Point3D

• unit: string

optionalcustomExportData

customExportData?: () => void

Type declaration

• • (): void

  • Returns void

optionalcustomExportImage

customExportImage?: () => void

Type declaration

• • (): void

  • Returns void

optionaldata

data?: { x: number; y: number; z?: number }[]

optionaldataBackgroundColor

dataBackgroundColor?: string[]

optionaldataStat

dataStat?: { mean: number; rms: number }

Type declaration

• mean: number

• rms: number

optionaldragAction

dragAction?: false | DragMode

optionalexportRightPadding

exportRightPadding?: number

optionalexportTitle

exportTitle?: string

optionalextraPluginOptions

extraPluginOptions?: any

optionalgraphClicked

graphClicked?: (x: number, y: number, data: { x: number; y: number; z?: number }[]) => void

Type declaration

• • (x: number, y: number, data: { x: number; y: number; z?: number }[]): void

  • Parameters

    • x: number

    • y: number

    • data: { x: number; y: number; z?: number }[]

    Returns void

optionalgraphCursorMoved

graphCursorMoved?: (x: number, y: number) => void

Type declaration

• • (x: number, y: number): void

  • Parameters

    • x: number

    • y: number

    Returns void

optionalgraphRightClicked

graphRightClicked?: (x: number) => void

Type declaration

• • (x: number): void

  • Parameters

    • x: number

    Returns void

optionalgraphSelectionReset

graphSelectionReset?: () => void

Type declaration

• • (): void

  • Returns void

optionalgraphZoomedX

graphZoomedX?: (xMin: number, xMax: number) => void

Type declaration

• • (xMin: number, xMax: number): void

  • Parameters

    • xMin: number

    • xMax: number

    Returns void

optionalgraphZoomedXY

graphZoomedXY?: (xMin: number, xMax: number, yMin: number, yMax: number) => void

Type declaration

• • (xMin: number, xMax: number, yMin: number, yMax: number): void

  • Parameters

    • xMin: number

    • xMax: number

    • yMin: number

    • yMax: number

    Returns void

optionalgraphZoomedY

graphZoomedY?: (yMin: number, yMax: number) => void

Type declaration

• • (yMin: number, yMax: number): void

  • Parameters

    • yMin: number

    • yMax: number

    Returns void

optionalgraphZoomReset

graphZoomReset?: () => void

Type declaration

• • (): void

  • Returns void

optionalheight

height?: number

optionalimageName

imageName?: string

optionalindicatorInteractionChannel

indicatorInteractionChannel?: { currentChannel: Point3D; hoveredChannel: Point3D; start: boolean }

Type declaration

• currentChannel: Point3D

• hoveredChannel: Point3D

• start: boolean

optionalisDarkMode

isDarkMode?: boolean

optionalisGroupSubPlot

isGroupSubPlot?: boolean

optionalisLogY

isLogY?: boolean

optionalisZIndex

isZIndex?: boolean

optionallineColor

lineColor?: string

optionalmouseEntered

mouseEntered?: (value: boolean) => void

Type declaration

• • (value: boolean): void

  • Parameters

    • value: boolean

    Returns void

optionalmultiPlotPropsMap

multiPlotPropsMap?: Map<string, MultiPlotProps>

optionalonBoxSelected

onBoxSelected?: (xMin: number, xMax: number, yMin: number, yMax: number) => void

Type declaration

• • (xMin: number, xMax: number, yMin: number, yMax: number): void

  • Parameters

    • xMin: number

    • xMax: number

    • yMin: number

    • yMax: number

    Returns void

optionalonLassoSelected

onLassoSelected?: (polygonGraphCoords: Point2D[]) => void

Type declaration

• • (polygonGraphCoords: Point2D[]): void

  • Parameters

    • polygonGraphCoords: Point2D[]

    Returns void

optionalopacity

opacity?: number

optionalplotName

plotName?: string

optionalplotType

plotType?: PlotType

optionalpointRadius

pointRadius?: number

optionalrenderOverlay

renderOverlay?: (width: number, height: number, chartArea: any) => ReactNode

Type declaration

• • (width: number, height: number, chartArea: any): ReactNode

  • Parameters

    • width: number

    • height: number

    • chartArea: any

    Returns ReactNode

optionalshouldAlignChartAreaRight

shouldAlignChartAreaRight?: boolean

optionalshouldScrollZoom

shouldScrollZoom?: boolean

optionalshouldShowLegend

shouldShowLegend?: boolean

optionalshouldShowTopAxis

shouldShowTopAxis?: boolean

optionalshouldShowXAxisLabel

shouldShowXAxisLabel?: boolean

optionalshouldShowXAxisTicks

shouldShowXAxisTicks?: boolean

optionalshouldShowZeroLine

shouldShowZeroLine?: boolean

optionaltickTypeX

tickTypeX?: TickType

optionaltickTypeY

tickTypeY?: TickType

optionaltoolbarChildren

toolbarChildren?: any

optionaltopAxisTickFormatter

topAxisTickFormatter?: (value: number, index: number, values: Tick[]) => string | number

Type declaration

• • (value: number, index: number, values: Tick[]): string | number

  • Parameters

    • value: number

    • index: number

    • values: Tick[]

    Returns string | number

optionalupdateChartArea

updateChartArea?: (chartArea: ChartArea) => void

Type declaration

• • (chartArea: ChartArea): void

  • Parameters

    • chartArea: ChartArea

    Returns void

optionalwidth

width?: number

optionalxLabel

xLabel?: string

optionalxMax

xMax?: number

optionalxMin

xMin?: number

optionalxTickMarkLength

xTickMarkLength?: number

optionalxZeroLineColor

xZeroLineColor?: string

optionalyLabel

yLabel?: string

optionalyMax

yMax?: number

optionalyMin

yMin?: number

optionalyZeroLineColor

yZeroLineColor?: string

optionalzeroLineWidth

zeroLineWidth?: number