Interface ShapedLayoutOptions

interface ShapedLayoutOptions {
    animate?: boolean;
    animationDuration?: number;
    animationEasing?: TransitionTimingFunction;
    avoidOverlap?: boolean;
    boundingBox?: BoundingBox12 | BoundingBoxWH;
    fit?: boolean;
    name: string;
    nodeDimensionsIncludeLabels?: boolean;
    padding?: number;
    ready?: LayoutHandler;
    sort?: SortingFunction;
    spacingFactor?: number;
    stop?: LayoutHandler;
    animateFilter?(node: NodeSingular, index: number): boolean;
    transform?(node: NodeSingular, position: Position): Position;
}

Hierarchy (view full)

BaseLayoutOptions
AnimatedLayoutOptions
- ShapedLayoutOptions

Index

Properties

animate? animationDuration? animationEasing? avoidOverlap? boundingBox? fit? name nodeDimensionsIncludeLabels? padding? ready? sort? spacingFactor? stop?

Methods

animateFilter? transform?

Properties

`Optional`animate

animate?: boolean

`Optional`animationDuration

animationDuration?: number

`Optional`animationEasing

animationEasing?: TransitionTimingFunction

`Optional`avoidOverlap

avoidOverlap?: boolean

`Optional`boundingBox

boundingBox?: BoundingBox12 | BoundingBoxWH

`Optional`fit

fit?: boolean

name

name: string

`Optional`nodeDimensionsIncludeLabels

nodeDimensionsIncludeLabels?: boolean

`Optional`padding

padding?: number

`Optional`ready

ready?: LayoutHandler

`Optional`sort

sort?: SortingFunction

`Optional`spacingFactor

spacingFactor?: number

`Optional`stop

stop?: LayoutHandler

Methods

`Optional`animateFilter

animateFilter(node, index): boolean
a function that determines whether the node should be animated. All nodes animated by default on animate enabled. Non-animated nodes are positioned immediately when the layout starts
Parameters
- node: NodeSingular
- index: number
Returns boolean
Inherited from AnimatedLayoutOptions.animateFilter
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:5221

`Optional`transform

transform(node, position): Position
transform a given node position. Useful for changing flow direction in discrete layouts
Parameters
- node: NodeSingular
  The node.
- position: Position
  The node position.
Returns Position
Inherited from BaseLayoutOptions.transform
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:5189