LinePlotComponentProps

Index

Constructors

• constructor

Properties

• borderWidth
• comments
• data
• exportCommentsGenerator
• fullResolutionData
• graphClicked
• graphCursorMoved
• graphRightClicked
• graphZoomedX
• graphZoomedXY
• graphZoomedY
• graphZoomReset
• height
• imageName
• insideBoxes
• insideTexts
• isDarkMode
• isGroupSubPlot
• isLogY
• isSelectingInsideBox
• isZIndex
• lineColor
• markers
• mouseEntered
• multiColorMultiLinesColors
• multiColorSingleLineColors
• multiPlotPropsMap
• opacity
• order
• plotName
• plotType
• pointRadius
• selectingMode
• setSelectedInsideBox
• setSelectedLine
• setSelectedRange
• shouldScrollZoom
• shouldShowLegend
• shouldShowTopAxis
• shouldShowXAxisLabel
• shouldShowXAxisTicks
• shouldShowYAxisLabel
• shouldShowYAxisTicks
• testId
• tickTypeX
• tickTypeY
• topAxisTickFormatter
• width
• xLabel
• xMax
• xMin
• xTickMarkLength
• yLabel
• yMax
• yMin
• yZeroLineColor
• zeroLineWidth

Constructors

constructor

• LinePlotComponentProps(): LinePlotComponentProps

• Returns LinePlotComponentProps

Properties

optionalborderWidth

borderWidth?: number

optionalcomments

comments?: string[]

optionaldata

data?: Point2D[]

optionalexportCommentsGenerator

exportCommentsGenerator?: (plotKey: string, plot: MultiPlotProps) => string[] | undefined

Type declaration

• • (plotKey: string, plot: MultiPlotProps): string[] | undefined

  • Parameters

    • plotKey: string

    • plot: MultiPlotProps

    Returns string[] | undefined

optionalfullResolutionData

fullResolutionData?: Point2D[]

optionalgraphClicked

graphClicked?: (x: number) => void

Type declaration

• • (x: number): void

  • Parameters

    • x: number

    Returns void

optionalgraphCursorMoved

graphCursorMoved?: (x: number) => void

Type declaration

• • (x: number): void

  • Parameters

    • x: number

    Returns void

optionalgraphRightClicked

graphRightClicked?: (x: number) => void

Type declaration

• • (x: number): void

  • Parameters

    • x: number

    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

optionalinsideBoxes

insideBoxes?: LinePlotInsideBoxMarker[]

optionalinsideTexts

insideTexts?: LinePlotInsideTextMarker[]

optionalisDarkMode

isDarkMode?: boolean

optionalisGroupSubPlot

isGroupSubPlot?: boolean

optionalisLogY

isLogY?: boolean

optionalisSelectingInsideBox

isSelectingInsideBox?: boolean

optionalisZIndex

isZIndex?: boolean

optionallineColor

lineColor?: string

optionalmarkers

markers?: LineMarker[]

optionalmouseEntered

mouseEntered?: (value: boolean) => void

Type declaration

• • (value: boolean): void

  • Parameters

    • value: boolean

    Returns void

optionalmultiColorMultiLinesColors

multiColorMultiLinesColors?: Map<string, string[]>

optionalmultiColorSingleLineColors

multiColorSingleLineColors?: string[]

optionalmultiPlotPropsMap

multiPlotPropsMap?: Map<string, MultiPlotProps>

optionalopacity

opacity?: number

optionalorder

order?: number

optionalplotName

plotName?: string

optionalplotType

plotType?: PlotType

optionalpointRadius

pointRadius?: number

optionalselectingMode

selectingMode?: LinePlotSelectingMode

optionalsetSelectedInsideBox

setSelectedInsideBox?: (minX: number, maxX: number, minY: number, maxY: number) => void

Type declaration

• • (minX: number, maxX: number, minY: number, maxY: number): void

  • Parameters

    • minX: number

    • maxX: number

    • minY: number

    • maxY: number

    Returns void

optionalsetSelectedLine

setSelectedLine?: (startX: number, endX: number, startY: number, endY: number) => void

Type declaration

• • (startX: number, endX: number, startY: number, endY: number): void

  • Parameters

    • startX: number

    • endX: number

    • startY: number

    • endY: number

    Returns void

optionalsetSelectedRange

setSelectedRange?: (min: number, max: number) => void

Type declaration

• • (min: number, max: number): void

  • Parameters

    • min: number

    • max: number

    Returns void

optionalshouldScrollZoom

shouldScrollZoom?: boolean

optionalshouldShowLegend

shouldShowLegend?: boolean

optionalshouldShowTopAxis

shouldShowTopAxis?: boolean

optionalshouldShowXAxisLabel

shouldShowXAxisLabel?: boolean

optionalshouldShowXAxisTicks

shouldShowXAxisTicks?: boolean

optionalshouldShowYAxisLabel

shouldShowYAxisLabel?: boolean

optionalshouldShowYAxisTicks

shouldShowYAxisTicks?: boolean

optionaltestId

testId?: string

optionaltickTypeX

tickTypeX?: TickType

optionaltickTypeY

tickTypeY?: TickType

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

optionalwidth

width?: number

optionalxLabel

xLabel?: string

optionalxMax

xMax?: number

optionalxMin

xMin?: number

optionalxTickMarkLength

xTickMarkLength?: number

optionalyLabel

yLabel?: string

optionalyMax

yMax?: number

optionalyMin

yMin?: number

optionalyZeroLineColor

yZeroLineColor?: string

optionalzeroLineWidth

zeroLineWidth?: number