perfect-graph / Modules / components/ClusterNodeContainer / <internal>

Namespace: <internal>

components/ClusterNodeContainer.

Table of contents

Type aliases

• BoundingBox
• Cluster
• CytoscapeEvent
• EdgeData
• EdgeElement
• EdgeElementSettings
• ElementConfig
• ElementContext
• ElementFilterOption
• GraphRef
• NodeConfig
• NodeContext
• NodeData
• NodeElement
• NodeElementSettings
• RenderClusterNode
• RenderElementParams
• ViewportRef
• ViewportType

Variables

• CYTOSCAPE_EVENT

Type aliases

BoundingBox

Ƭ BoundingBox: Object

Type declaration

Name	Type
height	number
width	number
x	number
y	number

Defined in

type/index.ts:87

---

Cluster

Ƭ Cluster: Object

Type declaration

Name	Type	Description
childClusterIds	string[]	Member child cluster ids
id	string	-
ids	string[]	Member node ids
name	string	Cluster name or label
position?	Position	Cluster node position
visible?	boolean	-

Defined in

type/index.ts:450

---

CytoscapeEvent

Ƭ CytoscapeEvent: keyof typeof CYTOSCAPE_EVENT

Defined in

type/index.ts:382

---

EdgeData

Ƭ EdgeData: Object

Type declaration

Name	Type	Description
data?	any	Edge data
id	string	Edge id for cytoscape
source	string	Edge source id for cytoscape
target	string	Edge target id for cytoscape

Defined in

type/index.ts:195

---

EdgeElement

Ƭ EdgeElement: EdgeSingular

Defined in

type/index.ts:173

---

EdgeElementSettings

Ƭ EdgeElementSettings: Object

Type declaration

Name	Type	Description
filtered	boolean	Edge is filtered by given filter function
hovered	boolean	Hovered state
nodeFiltered	boolean	Edge's source or target node is filtered
visibility	Object	Visibility tracking object
visibility.nodeVisible	boolean	-

Defined in

type/index.ts:95

---

ElementConfig

Ƭ ElementConfig<T>: Object

Type parameters

Name	Type
T	NodeElement | EdgeElement

Type declaration

Name	Type	Description
filter	ElementFilterOption<T>	Filter config data
renderEvents	CytoscapeEvent[]	When events are triggered, the element will be rerendered.

Defined in

type/index.ts:398

---

ElementContext

Ƭ ElementContext<T>: Object

Cytoscape element context

Type parameters

Name	Type
T	NodeElementSettings | EdgeElementSettings

Type declaration

Name	Type
settings	T
onPositionChange	() => void
render	(callback?: () => void) => void

Defined in

type/index.ts:81

---

ElementFilterOption

Ƭ ElementFilterOption<E>: Object

Type parameters

Name
E

Type declaration

Name	Type	Description
settings	Object	Settings for filtered elements
settings.opacity	number	-
test?	(params: { element: E ; item: NodeData | EdgeData }) => boolean	-

Defined in

type/index.ts:384

---

GraphRef

Ƭ GraphRef: Object

Type declaration

Name	Type	Description
app	PIXI.Application	PIXI instance
cy	Core	Cytoscape instance
viewport	ViewportRef	PIXI Viewport instance

Defined in

type/index.ts:716

---

NodeConfig

Ƭ NodeConfig: { position?: Position ; view: { fill: { default: number ; edgeSelected: number ; hovered: number ; selected: number } ; height: number ; labelVisible: boolean ; radius: number ; width: number } } & ElementConfig<NodeElement>

Defined in

type/index.ts:408

---

NodeContext

Ƭ NodeContext: ElementContext<NodeElementSettings> & { boundingBox: BoundingBox ; element: NodeElement }

Defined in

type/index.ts:132

---

NodeData

Ƭ NodeData: Object

Type declaration

Name	Type	Description
data?	any	Node data
id	string	Node id for cytoscape
position?	Position	Node initial position

Defined in

type/index.ts:180

---

NodeElement

Ƭ NodeElement: NodeSingular

Defined in

type/index.ts:174

---

NodeElementSettings

Ƭ NodeElementSettings: Object

Type declaration

Name	Type	Description
filtered	boolean	Node is filtered by given filter function
hovered	boolean	Hovered state
visibility	Object	Visibility tracking object
visibility.cluster	boolean	-

Defined in

type/index.ts:115

---

RenderClusterNode

Ƭ RenderClusterNode<Additional>: (c: { config: NodeConfig ; context: NodeContext ; element: NodeElement ; item: Cluster } & RenderElementParams & Additional) => React.ReactElement

Type parameters

Name	Type
Additional	extends Record<string, any> = {}

Type declaration

▸ (c): React.ReactElement

Parameters

Name	Type
c	{ config: NodeConfig ; context: NodeContext ; element: NodeElement ; item: Cluster } & RenderElementParams & Additional

Returns

React.ReactElement

Defined in

type/index.ts:313

---

RenderElementParams

Ƭ RenderElementParams: Object

Edge or Node render element function

Type declaration

Name	Type	Description
cy	Core	Related cytoscape instance
graphRef	React.RefObject<GraphRef>	Related graph instance ref
theme	Theme	-

Defined in

type/index.ts:222

---

ViewportRef

Ƭ ViewportRef: ViewportType

Defined in

type/index.ts:714

---

ViewportType

Ƭ ViewportType: PIXI.DisplayObject & ViewportNative & { clickEvent: any ; hitArea: BoundingBox ; isClick: boolean ; oldQualityLevel: number ; qualityLevel: number }

Defined in

type/index.ts:692

Variables

CYTOSCAPE_EVENT

• CYTOSCAPE_EVENT: Object

Type declaration

Name	Type
data	"data"
mouseout	"mouseout"
mouseover	"mouseover"
position	"position"
select	"select"
selectEdge	"selectEdge"
selectNode	"selectNode"
unselect	"unselect"
unselectEdge	"unselectEdge"
unselectNode	"unselectNode"

Defined in

constants/index.tsx:170