Class Graph<T>

Type Parameters

T extends DataType = any

Hierarchy (View Summary)

Graph
- DedupedEdgesGraph

Index

Accessors

edgeIds edges nodeIds nodes numEdges numNodes

Methods

dedupeEdges degree forceAtlas2 fromEdgeList

Accessors

edgeIds

get edgeIds(): DataFrame<{ dst: Int32; id: Int32; src: Int32 }>
Returns DataFrame<{ dst: Int32; id: Int32; src: Int32 }>
- Defined in graph.ts:92

edges

get edges(): DataFrame<
    {
        dst: (T & DataType) & DataType;
        id: (Int32 & DataType) & DataType;
        src: (T & DataType) & DataType;
        weight: (Float32 & DataType) & DataType;
    },
>
Returns DataFrame<
    {
        dst: (T & DataType) & DataType;
        id: (Int32 & DataType) & DataType;
        src: (T & DataType) & DataType;
        weight: (Float32 & DataType) & DataType;
    },
>
- Defined in graph.ts:73

nodeIds

get nodeIds(): DataFrame<{ id: Int32 }>
Returns DataFrame<{ id: Int32 }>
- Defined in graph.ts:90

nodes

get nodes(): DataFrame<{ node: T }>
Returns DataFrame<{ node: T }>
- Defined in graph.ts:71

numEdges

get numEdges(): number
Returns number
- Defined in graph.ts:64

numNodes

get numNodes(): number
Returns number
- Defined in graph.ts:69

Methods

dedupeEdges

dedupeEdges(): DedupedEdgesGraph<Series<(T & DataType) & DataType>["type"]>
Returns DedupedEdgesGraph<Series<(T & DataType) & DataType>["type"]>
- Defined in graph.ts:94

degree

degree(): DataFrame<{ degree: Int32; vertex: Int32 }>
Returns DataFrame<{ degree: Int32; vertex: Int32 }>
- Defined in graph.ts:104

forceAtlas2

forceAtlas2(options?: ForceAtlas2Options<any>): Float32Buffer
Parameters
- options: ForceAtlas2Options<any> = ...
Returns Float32Buffer
The new positions.

Note
Peak memory allocation occurs at 30*V.
- Defined in graph.ts:117

`Static`fromEdgeList

fromEdgeList<T extends Series<DataType>>(
    src: T,
    dst: T,
    weights?: Float32Series,
    options?: GraphOptions,
): Graph<T["type"]>
Type Parameters
- T extends Series<DataType>
Parameters
- src: T
- dst: T
- weights: Float32Series = ...
- options: GraphOptions = ...
Returns Graph<T["type"]>
- Defined in graph.ts:28