Skip to content
On this page

Class: VueFlowApp ​

Global Vue Flow App

Stores all store instances and provides access to them

Holds global config that is passed to all store instances

Provides hooks for plugins to access the store

Table of contents ​

Constructors ​

Properties ​

Methods ​

Constructors ​

constructor ​

• new VueFlowApp()

Properties ​

config ​

• config: ConfigFactory

Used by each store instance that is created as default values for store


currentId ​

• currentId: number = 0


flows ​

• flows: Map<string, VueFlowStore>


hooks ​

• Private hooks: PluginHooks


instance ​

â–ª Static instance: VueFlowApp

Methods ​

create ​

â–¸ create(id, initialOptions?): VueFlowStore

Parameters ​

NameType
idstring
initialOptions?FlowProps

Returns ​

VueFlowStore


get ​

â–¸ get(id): undefined | VueFlowStore

Parameters ​

NameType
idstring

Returns ​

undefined | VueFlowStore


getId ​

â–¸ getId(): string

Returns ​

string


remove ​

â–¸ remove(id): boolean

Parameters ​

NameType
idstring

Returns ​

boolean


set ​

â–¸ set(id, flow): Map<string, VueFlowStore>

Parameters ​

NameType
idstring
flowVueFlowStore

Returns ​

Map<string, VueFlowStore>


setConfig ​

â–¸ setConfig(options): VueFlowApp

Set global config factory function

Parameters ​

NameType
optionsConfigFactory

Returns ​

VueFlowApp


use ​

â–¸ use(plugin): VueFlowApp

Helper to install plugin

Parameters ​

NameType
pluginPlugin

Returns ​

VueFlowApp


getInstance ​

â–¸ Static getInstance(): VueFlowApp

Returns ​

VueFlowApp

Released under the MIT License.