Class FlowChart

Options Methods Interfaces

Hierarchy

FlowChart

Constructors

constructor

new FlowChart(element: string | HTMLElement, options?: Options): FlowChart

Parameters
- element: string | HTMLElement
- Optional options: Options
Returns FlowChart

Properties

Readonly VERSION

VERSION: string

Optional active

active?: boolean

colorBar

colorBar: ColorBar

defs

defs: string

editor

editor: Editor

element

element: HTMLElement

Readonly labels

labels: LabelCollection

Readonly links

links: LinkCollection

menuBar

menuBar: MenuBar

mode

mode: string

Readonly nodes

nodes: NodeCollection

options

options: Options

Readonly ports

ports: PortCollection

scale

scale: number

selectedPort

selectedPort: Port

selectedPortShape

selectedPortShape: Shape

selectedShapes

selectedShapes: SelectedShapeCollection

shapeBar

shapeBar: ShapeBar

statusBar

statusBar: StatusBar

svgElement

svgElement: SVGElement

useChangeListener

useChangeListener: boolean

viewBox

viewBox: number[]

Static CHANGED_TIMEOUT

CHANGED_TIMEOUT: number

Static DEFAULT_LABEL_SHAPE_ID

DEFAULT_LABEL_SHAPE_ID: string

Static DEFAULT_LINK_SHAPE_ID

DEFAULT_LINK_SHAPE_ID: string

Static LINK_DITSNANCE

LINK_DITSNANCE: number

Static LINK_ROUNDED_CORENERS

LINK_ROUNDED_CORENERS: number

Static MAGNET_MOVE_PIXELS

MAGNET_MOVE_PIXELS: number

Static MAGNET_PORT

MAGNET_PORT: number

Static MAGNET_RESIZE_PIXELS

MAGNET_RESIZE_PIXELS: number

Static MAGNET_WIN_PIXELS

MAGNET_WIN_PIXELS: number

Static MOVE_NODE_STEP

MOVE_NODE_STEP: number

Static PADDING

PADDING: number

Static SCALE_FACTOR

SCALE_FACTOR: number

Static SEPARATOR

SEPARATOR: string

Static linkTemplates

linkTemplates: { rounded: LinkTemplate }

Type declaration

[name: string]: LinkTemplate
rounded: LinkTemplate

Static shapeTemplates

shapeTemplates: { base: ShapeTemplate; connector: ShapeTemplate; data: ShapeTemplate; decision: ShapeTemplate; delay: ShapeTemplate; display: ShapeTemplate; document: ShapeTemplate; inOut: ShapeTemplate; label: ShapeTemplate; loopLimit: ShapeTemplate; manualInput: ShapeTemplate; manualLoop: ShapeTemplate; or: ShapeTemplate; preparation: ShapeTemplate; process: ShapeTemplate; startEnd: ShapeTemplate }

Type declaration

[name: string]: ShapeTemplate
base: ShapeTemplate
connector: ShapeTemplate
data: ShapeTemplate
decision: ShapeTemplate
delay: ShapeTemplate
display: ShapeTemplate
document: ShapeTemplate
inOut: ShapeTemplate
label: ShapeTemplate
loopLimit: ShapeTemplate
manualInput: ShapeTemplate
manualLoop: ShapeTemplate
or: ShapeTemplate
preparation: ShapeTemplate
process: ShapeTemplate
startEnd: ShapeTemplate

Static shortcuts

shortcuts: {}

Type declaration

[key: string]: shortcut

Methods

addNodeWithLink

addNodeWithLink(fromPort: Port, templateId: string, callback?: (node: Node, link: Link) => void): Node

Parameters
- fromPort: Port
- templateId: string
- Optional callback: (node: Node, link: Link) => void
  - - (node: Node, link: Link): void
    - Parameters
      - node: Node
      - link: Link
      Returns void
Returns Node

alignShapes

alignShapes(shapes: Shape[], alignPosition: position, alignToTheFirstNode?: boolean): void

Parameters
- shapes: Shape[]
- alignPosition: position
- Optional alignToTheFirstNode: boolean
Returns void

clearRedo

clearRedo(): void

Returns void

clearUndo

clearUndo(): void

Returns void

destroy

destroy(): void

Returns void

exportSVG

exportSVG(): void

Returns void

generateId

generateId(): string

Returns string

getShape

getShape(id: string | number): Shape

Parameters
- id: string | number
Returns Shape

json

json(options?: string[]): JSON

Parameters
- Optional options: string[]
Returns JSON

load

load(data: { labels?: Shape[]; links?: Link[]; nodes?: Shape[] }): void

Parameters
- data: { labels?: Shape[]; links?: Link[]; nodes?: Shape[] }
  - Optional labels?: Shape[]
  - Optional links?: Link[]
  - Optional nodes?: Shape[]
Returns void

makeShapesVisible

makeShapesVisible(shape: Shape[], callback?: () => void): void

Parameters
- shape: Shape[]
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

onChanged

onChanged(listener: (args: { properties?: string[] }) => void): FlowChart

Parameters
- listener: (args: { properties?: string[] }) => void
  - - (args: { properties?: string[] }): void
    - Parameters
      - args: { properties?: string[] }
        Optional properties?: string[]
      Returns void
Returns FlowChart

onFieldChange

onFieldChange(listener: (args: { fieldName: string; newValue: string; oldValue: string; shape: Shape }) => void): FlowChart

Parameters
- listener: (args: { fieldName: string; newValue: string; oldValue: string; shape: Shape }) => void
  - - (args: { fieldName: string; newValue: string; oldValue: string; shape: Shape }): void
    - Parameters
      - args: { fieldName: string; newValue: string; oldValue: string; shape: Shape }
        fieldName: string
        newValue: string
        oldValue: string
        shape: Shape
      Returns void
Returns FlowChart

onInit

onInit(listener: (args: {}) => void): FlowChart

Parameters
- listener: (args: {}) => void
  - - (args: {}): void
    - Parameters
      - args: {}
      Returns void
Returns FlowChart

onLinkClick

onLinkClick(listener: (args: { event: Event; linkId: string | number }) => void): FlowChart

Parameters
- listener: (args: { event: Event; linkId: string | number }) => void
  - - (args: { event: Event; linkId: string | number }): void
    - Parameters
      - args: { event: Event; linkId: string | number }
        event: Event
        linkId: string | number
      Returns void
Returns FlowChart

onLinkPoints

onLinkPoints(listener: (args: { fromPort: Port; fromShape: Shape; points: Point[]; toShape: Shape; tpPort: Port }) => void): FlowChart

Parameters
- listener: (args: { fromPort: Port; fromShape: Shape; points: Point[]; toShape: Shape; tpPort: Port }) => void
  - - (args: { fromPort: Port; fromShape: Shape; points: Point[]; toShape: Shape; tpPort: Port }): void
    - Parameters
      - args: { fromPort: Port; fromShape: Shape; points: Point[]; toShape: Shape; tpPort: Port }
        fromPort: Port
        fromShape: Shape
        points: Point[]
        toShape: Shape
        tpPort: Port
      Returns void
Returns FlowChart

onMenuItemClick

onMenuItemClick(listener: (args: { event: Event; name: string }) => void): FlowChart

Parameters
- listener: (args: { event: Event; name: string }) => void
  - - (args: { event: Event; name: string }): void
    - Parameters
      - args: { event: Event; name: string }
        event: Event
        name: string
      Returns void
Returns FlowChart

onSelectedPortChange

onSelectedPortChange(listener: (args: { newPort: Port; oldPort: Port }) => void): FlowChart

Parameters
- listener: (args: { newPort: Port; oldPort: Port }) => void
  - - (args: { newPort: Port; oldPort: Port }): void
    - Parameters
      - args: { newPort: Port; oldPort: Port }
        newPort: Port
        oldPort: Port
      Returns void
Returns FlowChart

onSelectedShapesChanged

onSelectedShapesChanged(listener: (args: {}) => void): FlowChart

Parameters
- listener: (args: {}) => void
  - - (args: {}): void
    - Parameters
      - args: {}
      Returns void
Returns FlowChart

onShapeClick

onShapeClick(listener: (args: { event: Event; shapeId: string | number }) => void): FlowChart

Parameters
- listener: (args: { event: Event; shapeId: string | number }) => void
  - - (args: { event: Event; shapeId: string | number }): void
    - Parameters
      - args: { event: Event; shapeId: string | number }
        event: Event
        shapeId: string | number
      Returns void
Returns FlowChart

onShapeDoubleClick

onShapeDoubleClick(listener: (args: { event: Event; shapeId: string | number }) => void): FlowChart

Parameters
- listener: (args: { event: Event; shapeId: string | number }) => void
  - - (args: { event: Event; shapeId: string | number }): void
    - Parameters
      - args: { event: Event; shapeId: string | number }
        event: Event
        shapeId: string | number
      Returns void
Returns FlowChart

onShortcut

onShortcut(listener: (args: { event: Event; name: string }) => void): FlowChart

Parameters
- listener: (args: { event: Event; name: string }) => void
  - - (args: { event: Event; name: string }): void
    - Parameters
      - args: { event: Event; name: string }
        event: Event
        name: string
      Returns void
Returns FlowChart

onSvgClick

onSvgClick(listener: (args: { event: Event }) => void): FlowChart

Parameters
- listener: (args: { event: Event }) => void
  - - (args: { event: Event }): void
    - Parameters
      - args: { event: Event }
        event: Event
      Returns void
Returns FlowChart

onUndoRedoChanged

onUndoRedoChanged(listener: (args: {}) => void): FlowChart

Parameters
- listener: (args: {}) => void
  - - (args: {}): void
    - Parameters
      - args: {}
      Returns void
Returns FlowChart

redo

redo(): void

Returns void

redoStepsCount

redoStepsCount(): number

Returns number

reposition

reposition(position?: startPosition, shapes?: Shape[], shouldAnimate?: boolean, callback?: () => void): void

Parameters
- Optional position: startPosition
- Optional shapes: Shape[]
- Optional shouldAnimate: boolean
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

rippleShape

rippleShape(shape: Shape, color: string, callback?: () => void): void

Parameters
- shape: Shape
- color: string
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

svg

svg(): string

Returns string

text

text(options?: string[]): string

Parameters
- Optional options: string[]
Returns string

undo

undo(): void

Returns void

undoStepsCount

undoStepsCount(): number

Returns number

Static animate

animate(elements: (HTMLElement | SVGElement)[], attrStart: Object, attrEnd: Object, duration: number, func: anim, callback?: Function, tick?: boolean): void

Parameters
- elements: (HTMLElement | SVGElement)[]
- attrStart: Object
- attrEnd: Object
- duration: number
- func: anim
- Optional callback: Function
- Optional tick: boolean
Returns void

Static isMobile

isMobile(): boolean

Returns boolean

Static isNEU

isNEU(val: any): boolean

Parameters
- val: any
Returns boolean

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

element: string | HTMLElement

Optional options: Options

Returns FlowChart

Properties

Readonly VERSION

Optional active

colorBar

defs

editor

element

Readonly labels

Readonly links

menuBar

mode

Readonly nodes

options

Readonly ports

scale

selectedPort

selectedPortShape

selectedShapes

shapeBar

statusBar

svgElement

useChangeListener

viewBox

Static CHANGED_TIMEOUT

Static DEFAULT_LABEL_SHAPE_ID

Static DEFAULT_LINK_SHAPE_ID

Static LINK_DITSNANCE

Static LINK_ROUNDED_CORENERS

Static MAGNET_MOVE_PIXELS

Static MAGNET_PORT

Static MAGNET_RESIZE_PIXELS

Static MAGNET_WIN_PIXELS

Static MOVE_NODE_STEP

Static PADDING

Static SCALE_FACTOR

Static SEPARATOR

Static linkTemplates

Type declaration

[name: string]: LinkTemplate

rounded: LinkTemplate

Static shapeTemplates

Type declaration

[name: string]: ShapeTemplate

base: ShapeTemplate

connector: ShapeTemplate

data: ShapeTemplate

decision: ShapeTemplate

delay: ShapeTemplate

display: ShapeTemplate

document: ShapeTemplate

inOut: ShapeTemplate

label: ShapeTemplate

loopLimit: ShapeTemplate

manualInput: ShapeTemplate

manualLoop: ShapeTemplate

or: ShapeTemplate

preparation: ShapeTemplate

process: ShapeTemplate

startEnd: ShapeTemplate

Static shortcuts

Type declaration

[key: string]: shortcut

Methods

addNodeWithLink

Parameters

fromPort: Port

templateId: string

Optional callback: (node: Node, link: Link) => void

Parameters