WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

dragEnd

dragEnd: function

Type declaration

    • (d: any): void
    • Parameters

      • d: any

      Returns void

dragStart

dragStart: function

Type declaration

    • (d: any): void
    • Parameters

      • d: any

      Returns void

dragend

dragend: function

Type declaration

    • (d: any): void
    • Parameters

      • d: any

      Returns void

dragstart

dragstart: function

Type declaration

    • (d: any): void
    • Parameters

      • d: any

      Returns void

event

event: any = null

Methods

alpha

  • alpha(): number
  • alpha(x: number): Layout

avoidOverlaps

  • avoidOverlaps(): boolean
  • avoidOverlaps(v: boolean): Layout

constraints

  • constraints(): Array<any>
  • constraints(c: Array<any>): Layout

convergenceThreshold

  • convergenceThreshold(): number
  • convergenceThreshold(x: number): Layout

defaultNodeSize

  • defaultNodeSize(): number
  • defaultNodeSize(x: number): Layout

distanceMatrix

  • distanceMatrix(): Array<Array<number>>
  • distanceMatrix(d: Array<Array<number>>): Layout

drag

  • drag(): void

flowLayout

  • flowLayout(axis: string, minSeparation: number | function): Layout
  • causes constraints to be generated such that directed graphs are laid out either from left-to-right or top-to-bottom. a separation constraint is generated in the selected axis for each edge that is not involved in a cycle (part of a strongly connected component)

    Parameters

    • axis: string

      'x' for left-to-right, 'y' for top-to-bottom

    • minSeparation: number | function

      either a number specifying a minimum spacing required across all links or a function to return the minimum spacing for each link

    Returns Layout

getLinkLength

  • getLinkLength(link: Link<Node | number>): number

getLinkType

  • getLinkType(link: Link<Node | number>): number

groupCompactness

  • groupCompactness(): number
  • groupCompactness(x: number): Layout

groups

handleDisconnected

  • handleDisconnected(): boolean
  • handleDisconnected(v: boolean): Layout
  • if true, the final step of the start method will be to nicely pack connected components of the graph. works best if start() is called with a reasonable number of iterations specified and each node has a bounding box (defined by the width and height properties on nodes).

    property

    handleDisconnected

    type

    bool

    default

    true

    Returns boolean

  • Parameters

    • v: boolean

    Returns Layout

jaccardLinkLengths

  • jaccardLinkLengths(idealLength: number, w?: number): Layout
  • compute an ideal length for each link based on the graph structure around that link. you can use this (for example) to create extra space around hub-nodes in dense graphs. In particular this calculation is based on the "symmetric difference" in the neighbour sets of the source and target: i.e. if neighbours of source is a and neighbours of target are b then calculation is: |a intersection b|/|a union b| Actual computation based on inspection of link structure occurs in start(), so links themselves don't have to have been assigned before invoking this function.

    Parameters

    • idealLength: number
    • Default value w: number = 1

    Returns Layout

kick

  • kick(): void

linkDistance

linkType

  • linkType(f: Function | number): Layout

links

nodes

on

powerGraphGroups

  • powerGraphGroups(f: Function): Layout

prepareEdgeRouting

  • prepareEdgeRouting(nodeMargin?: number): void

resume

routeEdge

  • routeEdge(edge: any, draw: any): Array<any>

size

  • size(): Array<number>
  • size(x: Array<number>): Layout
  • Size of the layout canvas dimensions [x,y]. Currently only used to determine the midpoint which is taken as the starting position for nodes with no preassigned x and y.

    property

    size

    type

    {Array of Number}

    Returns Array<number>

  • Parameters

    • x: Array<number>

    Returns Layout

start

  • start(initialUnconstrainedIterations?: number, initialUserConstraintIterations?: number, initialAllConstraintsIterations?: number, gridSnapIterations?: number, keepRunning?: boolean): Layout
  • start the layout process

    method

    start

    Parameters

    • Default value initialUnconstrainedIterations: number = 0
    • Default value initialUserConstraintIterations: number = 0
    • Default value initialAllConstraintsIterations: number = 0
    • Default value gridSnapIterations: number = 0
    • Default value keepRunning: boolean = true

    Returns Layout

stop

symmetricDiffLinkLengths

  • symmetricDiffLinkLengths(idealLength: number, w?: number): Layout
  • compute an ideal length for each link based on the graph structure around that link. you can use this (for example) to create extra space around hub-nodes in dense graphs. In particular this calculation is based on the "symmetric difference" in the neighbour sets of the source and target: i.e. if neighbours of source is a and neighbours of target are b then calculation is: sqrt(|a union b| - |a intersection b|) Actual computation based on inspection of link structure occurs in start(), so links themselves don't have to have been assigned before invoking this function.

    Parameters

    • idealLength: number
    • Default value w: number = 1

    Returns Layout

tick

  • tick(): boolean

trigger

  • trigger(e: Event): void

drag

  • drag(d: Node | Group, position: object): void

dragEnd

  • dragEnd(d: any): void

dragOrigin

dragStart

getSourceIndex

  • getSourceIndex(e: Link<Node | number>): number

getTargetIndex

  • getTargetIndex(e: Link<Node | number>): number

linkId

  • linkId(e: Link<Node | number>): string

mouseOut

  • mouseOut(d: any): void

mouseOver

  • mouseOver(d: any): void

setLinkLength

  • setLinkLength(link: Link<Node | number>, length: number): void

Object literals

linkAccessor

linkAccessor: object

getSourceIndex

getSourceIndex: getSourceIndex = Layout.getSourceIndex

getTargetIndex

getTargetIndex: getTargetIndex = Layout.getTargetIndex

setLength

setLength: setLinkLength = Layout.setLinkLength

getType

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc