Options
All
  • Public
  • Public/Protected
  • All
Menu

Module flux-project

A project in flux is a the description of an application:

  • modules/plugins
  • connections
  • layers tree
  • builder views of the modules (mostly position)
  • HTML layout
  • css stylesheets
  • project requirements

This module includes:

  • The schemas: they declare the required interface of the different entities listed above. The top level schema is ProjectSchema.
  • The loaders: they map the schemas to actual instances. Some of the models are presented in core-concepts and others here in this module.

The bundles of the different flux-packs used in a project needs to be fetched during its instantiation. That's why some of the loading functions required an IEnvironment parameters. Two environments exists:

  • Environment: this is the environment corresponding to the YouWol ecosystem, the one used in Flux applications
  • MockEnvironment: a (minimal) mock environment for unit-testing

You can also create your own 'resource management' environment by inheriting a class from IEnvironment.

Index

References

BuilderRendering

Re-exports BuilderRendering

BuilderRenderingSchema

Re-exports BuilderRenderingSchema

ConnectionSchema

Re-exports ConnectionSchema

ConnectionViewSchema

Re-exports ConnectionViewSchema

Description

Re-exports Description

DescriptionBox

Re-exports DescriptionBox

DescriptionBoxProperties

Re-exports DescriptionBoxProperties

DescriptionBoxSchema

Re-exports DescriptionBoxSchema

LayerTree

Re-exports LayerTree

LayerTreeSchema

Re-exports LayerTreeSchema

LoadingGraphSchema

Re-exports LoadingGraphSchema

ModuleSchema

Re-exports ModuleSchema

ModuleView

Re-exports ModuleView

ModuleViewSchema

Re-exports ModuleViewSchema

Package

Re-exports Package

PackageId

Re-exports PackageId

PackageLink

Re-exports PackageLink

PluginSchema

Re-exports PluginSchema

Project

Re-exports Project

ProjectSchema

Re-exports ProjectSchema

Requirements

Re-exports Requirements

RequirementsSchema

Re-exports RequirementsSchema

RunnerRendering

Re-exports RunnerRendering

RunnerRenderingSchema

Re-exports RunnerRenderingSchema

Workflow

Re-exports Workflow

WorkflowSchema

Re-exports WorkflowSchema

createProject

Re-exports createProject

instantiateProjectBuilderRendering

Re-exports instantiateProjectBuilderRendering

instantiateProjectConnections

Re-exports instantiateProjectConnections

instantiateProjectLayerTree

Re-exports instantiateProjectLayerTree

instantiateProjectModules

Re-exports instantiateProjectModules

instantiateProjectPlugins

Re-exports instantiateProjectPlugins

loadProject$

Re-exports loadProject$

loadProjectDatabase$

Re-exports loadProjectDatabase$

loadProjectDependencies$

Re-exports loadProjectDependencies$

loadProjectURI$

Re-exports loadProjectURI$

Generated using TypeDoc