@graph-viz

@graph-viz

  • Guide
  • API
  • Help

›Modules

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

react

@graph-viz › Globals › react

Index

References

  • GraphVizComponent
  • GraphVizGroup
  • GraphVizLink
  • GraphVizNode
  • lockNode
  • magnifyNode
  • resetNodeScale
  • toggleNodeLock
  • unlockNode

Classes

  • GraphVizComponent

Interfaces

  • GraphVizComponentProps
  • NodeTooltipsProps
  • State
  • TooltipFields
  • TooltipNode
  • Vec2

Type aliases

  • GraphVizGroup
  • GraphVizLink
  • GraphVizNode

Variables

  • DRAFT_NODE_ID
  • HOVERED_NODE_SCALE
  • LOCKED_NODE_STROKE_OPACITY
  • LOCKED_NODE_STROKE_WIDTH

Functions

  • NodeTooltips
  • getTooltipStyle
  • lockNode
  • magnifyNode
  • resetNodeScale
  • toggleNodeLock
  • unlockNode

Object literals

  • styles
  • styles

References

GraphVizComponent

• GraphVizComponent:


GraphVizGroup

• GraphVizGroup:


GraphVizLink

• GraphVizLink:


GraphVizNode

• GraphVizNode:


lockNode

• lockNode:


magnifyNode

• magnifyNode:


resetNodeScale

• resetNodeScale:


toggleNodeLock

• toggleNodeLock:


unlockNode

• unlockNode:

Type aliases

GraphVizGroup

Ƭ GraphVizGroup: DisplayGroup & SimulationGroup

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


GraphVizLink

Ƭ GraphVizLink: DisplayLink & SimulationLink

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


GraphVizNode

Ƭ GraphVizNode: Partial‹DisplayNode & SimulationNode› & Pick‹DisplayNode, "id"›

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

Primary GraphVizData type definitions

Variables

Const DRAFT_NODE_ID

• DRAFT_NODE_ID: "draft-node" = "draft-node"

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


Const HOVERED_NODE_SCALE

• HOVERED_NODE_SCALE: 1.5 = 1.5

Defined in packages/react/src/vizUtils.ts:6


Const LOCKED_NODE_STROKE_OPACITY

• LOCKED_NODE_STROKE_OPACITY: 0.4 = 0.4

Defined in packages/react/src/vizUtils.ts:5


Const LOCKED_NODE_STROKE_WIDTH

• LOCKED_NODE_STROKE_WIDTH: 0.3 = 0.3

Defined in packages/react/src/vizUtils.ts:4

Functions

NodeTooltips

▸ NodeTooltips(props: NodeTooltipsProps): null | Element‹›

Defined in packages/react/src/NodeTooltips.tsx:43

Parameters:

NameType
propsNodeTooltipsProps

Returns: null | Element‹›


Const getTooltipStyle

▸ getTooltipStyle(node: TooltipNode): CSSProperties

Defined in packages/react/src/NodeTooltips.tsx:14

Parameters:

NameType
nodeTooltipNode

Returns: CSSProperties


Const lockNode

▸ lockNode(node: GraphVizNode, newPos?: Vec2): void

Defined in packages/react/src/vizUtils.ts:21

Parameters:

NameType
nodeGraphVizNode
newPos?Vec2

Returns: void


Const magnifyNode

▸ magnifyNode(node: GraphVizNode): void

Defined in packages/react/src/vizUtils.ts:42

Parameters:

NameType
nodeGraphVizNode

Returns: void


Const resetNodeScale

▸ resetNodeScale(node: GraphVizNode): void

Defined in packages/react/src/vizUtils.ts:46

Parameters:

NameType
nodeGraphVizNode

Returns: void


Const toggleNodeLock

▸ toggleNodeLock(node: GraphVizNode, newPos?: Vec2): void

Defined in packages/react/src/vizUtils.ts:13

Parameters:

NameType
nodeGraphVizNode
newPos?Vec2

Returns: void


Const unlockNode

▸ unlockNode(node: GraphVizNode): void

Defined in packages/react/src/vizUtils.ts:34

Parameters:

NameType
nodeGraphVizNode

Returns: void

Object literals

Const styles

▪ styles: object

Defined in packages/react/src/NodeTooltips.tsx:24

▪ root: object

Defined in packages/react/src/NodeTooltips.tsx:25

  • backgroundColor: string = "rgb(200,207,214, 0.7)"

  • borderRadius: number = 3

  • fontSize: number = 12

  • maxWidth: number = 250

  • overflow: "hidden" = 'hidden' as const

  • padding: number = 6

  • pointerEvents: "none" = 'none' as const

  • position: "absolute" = 'absolute' as const

  • textTransform: "capitalize" = 'capitalize' as const


Const styles

▪ styles: object

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

▪ actionButtons: object

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

  • position: "absolute" = 'absolute' as const

  • right: number = 0

  • top: number = 0

▪ root: object

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

  • display: string = "flex"

  • height: string = "100%"

  • position: "relative" = 'relative' as const

  • width: string = "100%"

← SimulationNodeGraphVizComponent →
  • Index
    • References
    • Classes
    • Interfaces
    • Type aliases
    • Variables
    • Functions
    • Object literals
  • References
    • GraphVizComponent
    • GraphVizGroup
    • GraphVizLink
    • GraphVizNode
    • lockNode
    • magnifyNode
    • resetNodeScale
    • toggleNodeLock
    • unlockNode
  • Type aliases
    • GraphVizGroup
    • GraphVizLink
    • GraphVizNode
  • Variables
    • Const DRAFT_NODE_ID
    • Const HOVERED_NODE_SCALE
    • Const LOCKED_NODE_STROKE_OPACITY
    • Const LOCKED_NODE_STROKE_WIDTH
  • Functions
    • NodeTooltips
    • Const getTooltipStyle
    • Const lockNode
    • Const magnifyNode
    • Const resetNodeScale
    • Const toggleNodeLock
    • Const unlockNode
  • Object literals
    • Const styles
    • ▪ styles: object
    • Const styles
    • ▪ styles: object
@graph-viz
Guides
InstallationCreating your first graph vizAPI Reference
More
GitHubStar
Copyright © 2020, Uplevel Technology