@graph-viz

@graph-viz

  • Guide
  • API
  • Help

›Interfaces

Introduction

  • README
  • Globals

Modules

  • core
  • layouts
  • react

Classes

  • DisplayGroups
  • GraphVisualization
  • Labels
  • Links
  • MouseInteraction
  • Nodes
  • ForceSimulation
  • GraphVizComponent

Interfaces

  • ConfigurationOptions
  • DisplayGroup
  • DisplayLink
  • DisplayNode
  • GroupStyleAttributes
  • LabelStyleAttributes
  • LinkStyleAttributes
  • NodeStyleAttributes
  • Point
  • PopulatedDisplayLink
  • TextTexture
  • Uniforms
  • VisualizationInputData
  • ForceConfig
  • NodePosition
  • SimulationData
  • SimulationGroup
  • SimulationLink
  • SimulationNode
  • GraphVizComponentProps
  • NodeTooltipsProps
  • State
  • TooltipFields
  • TooltipNode
  • Vec2

GraphVizComponentProps

@graph-viz › Globals › react › GraphVizComponentProps

Hierarchy

  • GraphVizComponentProps

Index

Properties

  • config
  • editMode
  • forceConfig
  • groups
  • links
  • nodes
  • onClick
  • onLinkDrawn
  • onRefresh
  • onSecondaryClick
  • showControls
  • tooltips

Properties

Optional config

• config? : ConfigurationOptions

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


Optional editMode

• editMode? : undefined | false | true

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

enables graph editing i.e. for now only the drawing of links


Optional forceConfig

• forceConfig? : ForceConfig

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


groups

• groups: GraphVizGroup[]

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


links

• links: GraphVizLink[]

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


nodes

• nodes: GraphVizNode[]

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


onClick

• onClick: function

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

callback dispatched on primary click

Type declaration:

▸ (event: MouseEvent, clickedNodeIdx: number | null): any

Parameters:

NameType
eventMouseEvent
clickedNodeIdxnumber | null

onLinkDrawn

• onLinkDrawn: function

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

callback dispatched when a valid link is drawn. requires editMode to be true

Type declaration:

▸ (source: GraphVizNode, target: GraphVizNode): any

Parameters:

NameType
sourceGraphVizNode
targetGraphVizNode

Optional onRefresh

• onRefresh? : undefined | function

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


onSecondaryClick

• onSecondaryClick: function

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

callback dispatched on secondary click

Type declaration:

▸ (event: MouseEvent, clickedNodeIdx: number | null): any

Parameters:

NameType
eventMouseEvent
clickedNodeIdxnumber | null

Optional showControls

• showControls? : undefined | false | true

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


tooltips

• tooltips: Partial‹TooltipNode›[]

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

← SimulationNodeNodeTooltipsProps →
  • Hierarchy
  • Index
    • Properties
  • Properties
    • Optional config
    • Optional editMode
    • Optional forceConfig
    • groups
    • links
    • nodes
    • onClick
    • onLinkDrawn
    • Optional onRefresh
    • onSecondaryClick
    • Optional showControls
    • tooltips
@graph-viz
Guides
InstallationCreating your first graph vizAPI Reference
More
GitHubStar
Copyright © 2020, Uplevel Technology