Reincharts
    Preparing search index...

    Class ChartCanvas<TXAxis>

    Type Parameters

    • TXAxis extends number | Date

    Hierarchy

    • Component<ChartCanvasProps<TXAxis>, ChartCanvasState<TXAxis>>
      • ChartCanvas
    Index

    Constructors

    constructor

    Properties

    canvasContainerRef eventCaptureRef finalPinch? hackyWayToStopPanBeyondBounds__domain? hackyWayToStopPanBeyondBounds__plotData? lastSubscriptionId mutableState panInProgress prevMouseXY? subscriptions waitingForMouseMoveAnimationFrame? waitingForPanAnimationFrame? waitingForPinchZoomAnimationFrame? defaultProps displayName

    Methods

    amIOnTop calculateStateForDomain cancelDrag clearBothCanvas clearMouseCanvas clearThreeCanvas componentDidUpdate draw generateSubscriptionId getAllPanConditions getCanvasContexts getContextValues getMutableState getSnapshotBeforeUpdate handleClick handleContextMenu handleDoubleClick handleDrag handleDragEnd handleDragStart handleKeyDown handleMouseDown handleMouseEnter handleMouseLeave handleMouseMove handleMouseUp handlePan handlePanEnd handlePinchZoom handlePinchZoomEnd handleZoom panHelper pinchZoomHelper redraw render resetYDomain setCursorClass shouldComponentUpdate subscribe triggerEvent unsubscribe xAxisZoom yAxisZoom getDerivedStateFromProps

    Constructors

    Properties

    canvasContainerRef: RefObject<null | CanvasContainer> = ...
    eventCaptureRef: RefObject<null | EventCapture> = ...
    finalPinch?: boolean

    Private OptionalhackyWayToStopPanBeyondBounds__domain

    hackyWayToStopPanBeyondBounds__domain?: null | any[]

    Private OptionalhackyWayToStopPanBeyondBounds__plotData

    hackyWayToStopPanBeyondBounds__plotData?: null | any[]
    lastSubscriptionId: number = 0
    mutableState: MutableState = ...
    panInProgress: boolean = false
    prevMouseXY?: number[]
    subscriptions: Subscription[] = []
    waitingForMouseMoveAnimationFrame?: boolean
    waitingForPanAnimationFrame?: boolean
    waitingForPinchZoomAnimationFrame?: boolean
    defaultProps: {
        clamp: boolean;
        className: string;
        defaultFocus: boolean;
        disableInteraction: boolean;
        disablePan: boolean;
        disableZoom: boolean;
        flipXScale: boolean;
        maintainPointsPerPixelOnResize: boolean;
        margin: { bottom: number; left: number; right: number; top: number };
        minPointsPerPxThreshold: number;
        mouseMoveEvent: boolean;
        padding: number;
        pointsPerPxThreshold: number;
        postCalculator: (d: any) => any;
        useCrossHairStyleCursor: boolean;
        xAccessor: (data: any) => any;
        xExtents: any[];
        zIndex: number;
        zoomAnchor: <TData, TXAxis extends number | Date>(
            options: IZoomAnchorOptions<TData, TXAxis>,
        ) => TXAxis;
        zoomMultiplier: number;
    } = ...
    displayName: string = "ChartCanvas"

    Methods

    • Parameters

      • newDomain: any

      Returns {
          chartConfigs: ChartConfig[];
          plotData: any;
          xScale:
              | ScaleContinuousNumeric<number, number, never>
              | ScaleTime<number, number, never>;
      }

    • Called immediately after updating occurs. Not called for the initial render.

      The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

      Parameters

      • prevProps: ChartCanvasProps<TXAxis>

      Returns void

    • Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it.

      Note: the presence of this method prevents any of the deprecated lifecycle events from running.

      Parameters

      • prevProps: Readonly<ChartCanvasProps<TXAxis>>
      • prevState: Readonly<ChartCanvasState<TXAxis>>

      Returns null

    • Parameters

      • __namedParameters: { mouseXY: [number, number]; startPos: [number, number] }
      • e: MouseEvent

      Returns void

    • Parameters

      • __namedParameters: { mouseXY: number[] }
      • e: MouseEvent

      Returns void

    • Parameters

      • mousePosition: [number, number]
      • panStartXScale: ScaleContinuousNumeric<number, number, never> | ScaleTime<number, number, never>
      • dxdy: { dx: number; dy: number }
      • chartsToPan: string[]
      • e: MouseEvent

      Returns void

    • Parameters

      • mousePosition: [number, number]
      • panStartXScale: ScaleContinuousNumeric<number, number, never> | ScaleTime<number, number, never>
      • dxdy: { dx: number; dy: number }
      • chartsToPan: string[]
      • e: MouseEvent<Element, MouseEvent> | TouchEvent<Element>

      Returns void

    • Parameters

      • mouseXY: [number, number]
      • initialXScale: ScaleContinuousNumeric<number, number, never> | ScaleTime<number, number, never>
      • __namedParameters: { dx: number; dy: number }
      • chartsToPan: string[]

      Returns {
          chartConfigs: ChartConfig[];
          currentCharts: any[];
          currentItem: any;
          mouseXY: [number, number];
          plotData: any;
          xScale:
              | ScaleContinuousNumeric<number, number, never>
              | ScaleTime<number, number, never>;
      }

    • Parameters

      • initialPinch: any
      • finalPinch: any

      Returns {
          chartConfigs: ChartConfig[];
          currentItem: any;
          fullData: any[];
          mouseXY: any;
          plotData: any;
          xAccessor: (data: any) => TXAxis;
          xScale:
              | ScaleContinuousNumeric<number, number, never>
              | ScaleTime<number, number, never>;
      }

    • Called to determine whether the change in props and state should trigger a re-render.

      Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

      If false is returned, Component.render, componentWillUpdate and componentDidUpdate will not be called.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods