GraphVizComponent

@graph-viz › Globals › react › GraphVizComponent

Type parameters

▪ SS

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

+ new GraphVizComponent(props: Readonly‹GraphVizComponentProps›): GraphVizComponent

Inherited from GraphVizComponent.constructor

Defined in node_modules/@types/react/index.d.ts:486

deprecated

see https://reactjs.org/docs/legacy-context.html

Parameters:

NameType
propsReadonly‹GraphVizComponentProps›

Returns: GraphVizComponent

+ new GraphVizComponent(props: GraphVizComponentProps, context?: any): GraphVizComponent

Inherited from GraphVizComponent.constructor

Defined in node_modules/@types/react/index.d.ts:488

deprecated

see https://reactjs.org/docs/legacy-context.html

Parameters:

NameType
propsGraphVizComponentProps
context?any

Returns: GraphVizComponent

Properties

canvasRef

• canvasRef: RefObject‹HTMLCanvasElement› = React.createRef()

Defined in packages/react/src/GraphVizComponent.tsx:104

context

• context: any

Inherited from GraphVizComponent.context

Defined in node_modules/@types/react/index.d.ts:486

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 React.ContextType<typeof MyContext>

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

onWindowResize

• onWindowResize: function = debounce(() => { const root = this.rootRef.current! const {width, height} = root.getBoundingClientRect()

this.visualization.resize(width, height)

}, 500)

Defined in packages/react/src/GraphVizComponent.tsx:119

Type declaration:

▸ (): void

Readonly props

• props: Readonly‹GraphVizComponentProps› & Readonly‹object›

Inherited from GraphVizComponent.props

Defined in node_modules/@types/react/index.d.ts:511

refs

• refs: object

Inherited from GraphVizComponent.refs

Defined in node_modules/@types/react/index.d.ts:517

deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration:

  • [ key: string]: ReactInstance

rootRef

• rootRef: RefObject‹HTMLDivElement› = React.createRef()

Defined in packages/react/src/GraphVizComponent.tsx:103

simulation

• simulation: ForceSimulation

Defined in packages/react/src/GraphVizComponent.tsx:101

tooltipNodes

• tooltipNodes: TooltipNode[]

Defined in packages/react/src/GraphVizComponent.tsx:100

visualization

• visualization: GraphVisualization

Defined in packages/react/src/GraphVizComponent.tsx:90

Static Optional contextType

▪ contextType? : Context‹any›

Inherited from GraphVizComponent.contextType

Defined in node_modules/@types/react/index.d.ts:468

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

Inherited from GraphVizComponent.UNSAFE_componentWillMount

Defined in node_modules/@types/react/index.d.ts:712

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

Optional UNSAFE_componentWillReceiveProps

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹GraphVizComponentProps›, nextContext: any): void

Inherited from GraphVizComponent.UNSAFE_componentWillReceiveProps

Defined in node_modules/@types/react/index.d.ts:744

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

NameType
nextPropsReadonly‹GraphVizComponentProps›
nextContextany

Returns: void

Optional UNSAFE_componentWillUpdate

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹GraphVizComponentProps›, nextState: Readonly‹State›, nextContext: any): void

Inherited from GraphVizComponent.UNSAFE_componentWillUpdate

Defined in node_modules/@types/react/index.d.ts:772

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

This method will not stop working in React 17.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

NameType
nextPropsReadonly‹GraphVizComponentProps›
nextStateReadonly‹State›
nextContextany

Returns: void

Optional componentDidCatch

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

Inherited from GraphVizComponent.componentDidCatch

Defined in node_modules/@types/react/index.d.ts:641

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

Parameters:

NameType
errorError
errorInfoErrorInfo

Returns: void

componentDidMount

▸ componentDidMount(): void

Overrides void

Defined in packages/react/src/GraphVizComponent.tsx:126

Returns: void

componentDidUpdate

▸ componentDidUpdate(prevProps: GraphVizComponentProps): void

Overrides void

Defined in packages/react/src/GraphVizComponent.tsx:307

Parameters:

NameType
prevPropsGraphVizComponentProps

Returns: void

Optional componentWillMount

▸ componentWillMount(): void

Inherited from GraphVizComponent.componentWillMount

Defined in node_modules/@types/react/index.d.ts:698

Called immediately before mounting occurs, and before Component#render. Avoid introducing any side-effects or subscriptions in this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Returns: void

Optional componentWillReceiveProps

▸ componentWillReceiveProps(nextProps: Readonly‹GraphVizComponentProps›, nextContext: any): void

Inherited from GraphVizComponent.componentWillReceiveProps

Defined in node_modules/@types/react/index.d.ts:727

Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

Calling Component#setState generally does not trigger this method.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

NameType
nextPropsReadonly‹GraphVizComponentProps›
nextContextany

Returns: void

componentWillUnmount

▸ componentWillUnmount(): void

Overrides void

Defined in packages/react/src/GraphVizComponent.tsx:329

Returns: void

Optional componentWillUpdate

▸ componentWillUpdate(nextProps: Readonly‹GraphVizComponentProps›, nextState: Readonly‹State›, nextContext: any): void

Inherited from GraphVizComponent.componentWillUpdate

Defined in node_modules/@types/react/index.d.ts:757

Called immediately before rendering when new props or state is received. Not called for the initial render.

Note: You cannot call Component#setState here.

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

Parameters:

NameType
nextPropsReadonly‹GraphVizComponentProps›
nextStateReadonly‹State›
nextContextany

Returns: void

forceUpdate

▸ forceUpdate(callback?: undefined | function): void

Inherited from GraphVizComponent.forceUpdate

Defined in node_modules/@types/react/index.d.ts:503

Parameters:

NameType
callback?undefined | function

Returns: void

Optional getSnapshotBeforeUpdate

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹GraphVizComponentProps›, prevState: Readonly‹State›): SS | null

Inherited from GraphVizComponent.getSnapshotBeforeUpdate

Defined in node_modules/@types/react/index.d.ts:677

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:

NameType
prevPropsReadonly‹GraphVizComponentProps›
prevStateReadonly‹State›

Returns: SS | null

initData

▸ initData(): void

Defined in packages/react/src/GraphVizComponent.tsx:335

Returns: void

render

▸ render(): Element‹›

Overrides void

Defined in packages/react/src/GraphVizComponent.tsx:369

Returns: Element‹›

setState

▸ setState<K>(state: function | null | S | object, callback?: undefined | function): void

Inherited from GraphVizComponent.setState

Defined in node_modules/@types/react/index.d.ts:498

Type parameters:

▪ K: keyof State

Parameters:

NameType
statefunction | null | S | object
callback?undefined | function

Returns: void

Optional shouldComponentUpdate

▸ shouldComponentUpdate(nextProps: Readonly‹GraphVizComponentProps›, nextState: Readonly‹State›, nextContext: any): boolean

Inherited from GraphVizComponent.shouldComponentUpdate

Defined in node_modules/@types/react/index.d.ts:631

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:

NameType
nextPropsReadonly‹GraphVizComponentProps›
nextStateReadonly‹State›
nextContextany

Returns: boolean

zoomIn

▸ zoomIn(): void

Defined in packages/react/src/GraphVizComponent.tsx:361

Returns: void

zoomOut

▸ zoomOut(): void

Defined in packages/react/src/GraphVizComponent.tsx:365

Returns: void

Object literals

Readonly state

▪ state: object

Overrides void

Defined in packages/react/src/GraphVizComponent.tsx:106

currentTooltipNode

• currentTooltipNode: null = null

Defined in packages/react/src/GraphVizComponent.tsx:107

currentlyHoveredIdx

• currentlyHoveredIdx: null = null

Defined in packages/react/src/GraphVizComponent.tsx:108

vizData

▪ vizData: object

Defined in packages/react/src/GraphVizComponent.tsx:94

groups

• groups: never[] = []

Defined in packages/react/src/GraphVizComponent.tsx:97

links

• links: never[] = []

Defined in packages/react/src/GraphVizComponent.tsx:96

nodes

• nodes: never[] = []

Defined in packages/react/src/GraphVizComponent.tsx:95

Static defaultProps

▪ defaultProps: object

Defined in packages/react/src/GraphVizComponent.tsx:111

groups

• groups: never[] = []

Defined in packages/react/src/GraphVizComponent.tsx:113

onClick

• onClick: noop = noop

Defined in packages/react/src/GraphVizComponent.tsx:115

onLinkDrawn

• onLinkDrawn: noop = noop

Defined in packages/react/src/GraphVizComponent.tsx:114

onSecondaryClick

• onSecondaryClick: noop = noop

Defined in packages/react/src/GraphVizComponent.tsx:116

tooltips

• tooltips: never[] = []

Defined in packages/react/src/GraphVizComponent.tsx:112

← ForceSimulationConfigurationOptions →