Hierarchy

Constructors

  • Parameters

    Returns Tree

  • Parameters

    Returns Tree

Properties

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>
gInstanceRef: string = ...
handleOnLinkClickCb: TreeLinkEventCallback = ...

Handles the user-defined onLinkClick function.

handleOnLinkMouseOutCb: TreeLinkEventCallback = ...

Handles the user-defined onLinkMouseOut function.

handleOnLinkMouseOverCb: TreeLinkEventCallback = ...

Handles the user-defined onLinkMouseOver function.

handleOnNodeClickCb: TreeNodeEventCallback = ...

Handles the user-defined onNodeClick function.

handleOnNodeMouseOutCb: TreeNodeEventCallback = ...

Handles the user-defined onNodeMouseOut function.

handleOnNodeMouseOverCb: TreeNodeEventCallback = ...

Handles the user-defined onNodeMouseOver function.

props: Readonly<TreeProps> & Readonly<{ children?: ReactNode }>
refs: { [key: string]: ReactInstance }
state: TreeState = ...
svgInstanceRef: string = ...
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}</>;
}
}
defaultProps: Partial<TreeProps> = ...

Methods

  • bindZoomListener - If props.zoomable, binds a listener for "zoom" events to the SVG and sets scaleExtent to min/max specified in props.scaleExtent.

    Parameters

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

  • 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

    Returns 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

  • Parameters

    • Optionalcallback: () => void

    Returns void

  • Generates tree elements (nodes and links) by grabbing the rootNode from this.state.data[0]. Restricts tree depth to props.initialDepth if defined and if this is the initial render of the tree.

    Returns {
        links: HierarchyPointLink<TreeNodeDatum>[];
        nodes: HierarchyPointNode<TreeNodeDatum>[];
    }

  • 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

    • prevProps: Readonly<TreeProps>
    • prevState: Readonly<TreeState>

    Returns any

  • Finds the node matching nodeId and expands/collapses it, depending on the current state of its internal collapsed property. setState callback receives targetNode and handles props.onClick if defined.

    Parameters

    • nodeId: string

    Returns void

  • Collapses all tree nodes with a depth larger than initialDepth.

    Parameters

    • nodeSet: HierarchyPointNode<TreeNodeDatum>[]

      Array of nodes generated by generateTree

    • initialDepth: number

      Maximum initial depth the tree should render

    Returns void

  • Type Parameters

    • K extends keyof TreeState

    Parameters

    • state:
          | TreeState
          | (
              prevState: Readonly<TreeState>,
              props: Readonly<TreeProps>,
          ) => TreeState | Pick<TreeState, K>
          | Pick<TreeState, K>
    • Optionalcallback: () => void

    Returns void

  • 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

    • nextProps: Readonly<TreeProps>
    • nextState: Readonly<TreeState>
    • nextContext: any

    Returns boolean

  • Set initial zoom and position. Also limit zoom level according to scaleExtent on initial display. This is necessary, because the first time we are setting it as an SVG property, instead of going through D3's scaling mechanism, which would have picked up both properties.

    Parameters

    Returns { scale: any; translate: Point }

  • Parameters

    Returns Partial<TreeState>