Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

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

Private nodeRef

nodeRef: SVGGElement = null

Readonly props

props: Readonly<NodeProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

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<NodeProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<NodeProps>, nextState: Readonly<NodeState>, nextContext: any): void

applyTransform

  • applyTransform(transform: string, transitionDuration: NodeProps["transitionDuration"], opacity?: number, done?: (Anonymous function)): void
  • Parameters

    • transform: string
    • transitionDuration: NodeProps["transitionDuration"]
    • Default value opacity: number = 1
    • Default value done: (Anonymous function) = () => {}

    Returns void

commitTransform

  • commitTransform(): 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

componentWillLeave

  • componentWillLeave(done: any): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<NodeProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<NodeProps>, nextState: Readonly<NodeState>, nextContext: any): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<NodeProps>, prevState: Readonly<NodeState>): any | null
  • 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 any | null

handleAddChildren

handleNodeToggle

  • handleNodeToggle(): void

handleOnClick

  • handleOnClick(evt: any): void

handleOnMouseOut

  • handleOnMouseOut(evt: any): void

handleOnMouseOver

  • handleOnMouseOver(evt: any): void

render

  • render(): Element

renderNodeElement

  • renderNodeElement(): Element

setState

setTransform

  • setTransform(position: NodeProps["position"], parent: NodeProps["parent"], orientation: NodeProps["orientation"], shouldTranslateToOrigin?: boolean): string
  • Parameters

    • position: NodeProps["position"]
    • parent: NodeProps["parent"]
    • orientation: NodeProps["orientation"]
    • Default value shouldTranslateToOrigin: boolean = false

    Returns string

shouldComponentUpdate

shouldNodeTransform

Object literals

state

state: object

transform

transform: string = this.setTransform(this.props.position,this.props.parent,this.props.orientation,true)

wasClicked

wasClicked: boolean = false

initialStyle

initialStyle: object

opacity

opacity: number = 0

Generated using TypeDoc