Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphCanvas<NodeDataType, VertexDataType, SS>

Type parameters

  • NodeDataType

  • VertexDataType

  • SS

Hierarchy

Index

Constructors

constructor

Properties

camera

camera: Camera = new Camera()

canvasSize

canvasSize: Vector2 = new Vector2()

componentId

componentId: string

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
see

https://reactjs.org/docs/context.html

controls

controls: TrackballControls | undefined

defaultActions

defaultActions: Map<string, IMenuAction> = new Map<string, IMenuAction>()

directionalLight

directionalLight: DirectionalLight

light

light: HemisphereLight

props

props: Readonly<IGraphCanvasProps<NodeDataType, VertexDataType>> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

renderer

renderer: WebGLRenderer

scene

scene: Scene = new Scene()

selectedElement

selectedElement: GraphElement | undefined = undefined

state

state: Readonly<IGraphCanvasState>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IGraphCanvasProps<NodeDataType, VertexDataType>>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

animate

  • animate(): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IGraphCanvasProps<NodeDataType, VertexDataType>>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

cursorIntersects

  • cursorIntersects(event: MouseEvent): Intersection[]

designScene

  • designScene(): void

draw

  • draw(): void

drawEdge

  • drawEdge(edge: Vertex<VertexDataType>): void

drawNode

  • drawNode(node: Node<NodeDataType>, id: string): void

forceUpdate

  • forceUpdate(callback?: function): void
  • Parameters

    • Optional callback: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

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

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

    Parameters

    Returns SS | null

onClick

  • onClick(event: MouseEvent): void

onClickDown

  • onClickDown(event: MouseEvent): void

onMouseMove

  • onMouseMove(event: MouseEvent): void

onRightClick

  • onRightClick(event: MouseEvent): void

render

  • render(): Element

selectElement

setCanvasRef

  • setCanvasRef(canvas: HTMLElement): void

setCanvasSize

  • setCanvasSize(): void

setMenuDefaults

  • setMenuDefaults(): void

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof IGraphCanvasState

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • 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.

    Parameters

    Returns boolean

undraw

  • undraw(): void

unselectElement

  • unselectElement(): void

Generated using TypeDoc