@vcmap/ui 5.0.0-rc.8 → 5.0.0

package/README.md

@@ -1,4 +1,5 @@
 # VC Map
+
 VC Map is an Open-Source JavaScript framework and API for building dynamic and interactive maps on the web. It can display
 2D data, oblique imagery and massive 3D data including terrain data, vector data, mesh models, and point clouds making it
 easy for users to explore and interact with the data in an integrated and high-performance map application. VC Map apps can
@@ -13,123 +14,153 @@ to integrate VC Maps into any web page and to extend its functionalities with ow
 is structured into the following four main architectural layers:
 
 #### [VC Map Core](https://github.com/virtualcitySYSTEMS/map-core)
+
 The VC Map Core is a thin abstraction layer and wrapper around OpenLayers and Cesium. It provides a common data and feature
 management API and automatically synchronizes data and user actions between the 2D, oblique and 3D views. Map functions and
 tools can be developed against this Core API to make them available in 2D, 3D and the oblique view rather than having to
 develop them redundantly and based on different technologies.
 
 #### Configuration Management
+
 The VC Map framework offers a flexible and fully customizable map configuration management. All contents of a VC Map application
 such as available layers, views, tools, and plugins are managed in a JSON-based configuration file that is loaded when starting
 the application. Every VC Map application can thus be easily configured according to the end-user needs. Map configurations can
 be dynamically changed, extended, and serialized at runtime through a corresponding API.
 
 #### Modern User Interface
+
 VC Map comes with a modern UI interface for VC Map applications that provides UI components for all map tools and widgets
 implemented based on Vue.js and HTML5. In addition, the VC Map framework provides pre-built, low-level UI elements that can
 be used by developers to easily build more complex user dialogs from and include them in a map application.
 
 #### [Plugin API](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
+
 VC Map is easy to customize and extend through a well-defined Plugin API. Plugins allow for adding new functionalities,
 tools, and user dialogs to a VC Map application. Plugins can be added to a VC Map through the configuration file or loaded
 dynamically to an existing map application using the Plugin API. Plugin developers can use the entire VC Map stack
 (VC Map Core, configuration management, UI components) for building their own extensions.
 
 # Components
+
 ### [@vcmap/core](https://github.com/virtualcitySYSTEMS/map-core)
+
 Provides an abstraction layer around 2D, 3D and oblique Maps. Provides the following components:
+
 - map abstraction for Cesium, Openlayers and Oblique Images
 - layers
 - interactions
 - styles
-- application and context/config handling
-
-### [@vcsuite/ui-components](https://github.com/virtualcitySYSTEMS/suite-ui-components)
-Collection of reusable dumb ui components. For example textfield, checkbox, lists, icons. The components are build on top of [vuetify](https://github.com/vuetifyjs/vuetify)
+- application and module/config handling
 
 ### [@vcmap/ui](https://github.com/virtualcitySYSTEMS/map-ui)
+
 This Project, provides
+
 - a configurable and extendable ui
 - extends the @vcmap/core application handling with a plugin Concept, see [@vcmap/plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
-- extends the @vcmap/core application with a windowManager 
+- extends the @vcmap/core application with a windowManager
 
 ### [@vcmap/plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
+
 Provides a tool to create, develop and build Plugins for the @vcmap/ui.
-Plugin Concept documentation can also be found there. 
+Plugin Concept documentation can also be found there.
 
 ### [@vcmap/ui webpack5 integration template](https://github.com/virtualcitySYSTEMS/map-ui-webpack5-example)
+
 Example Template to show how to integrate the @vcmap/ui in a webpack5 project.
 
 ### [@vcmap/core demo](https://github.com/virtualcitySYSTEMS/map-core-demo)
+
 Example demo Application based on the @vcmap/core, shows how to implement a different UI on top of the @vcmap/core
 
 ## Component Diagram
-![A schema on component interactions](./documentation/componentsSchema.png)
-
-# Project and Component Status
-The Project is currently in Alpha status. Different components have different states. For development check here 
-how safe it is to start developing with these components.
-
-#### States:
-- TODO: not yet usable
-- ALPHA: 1. version, style and API will probably change
-- BETA: Style and API may change, we will provide a changelog from here on.
-- RC: Styles and API are most likely stable for the release / Featurecomplete.
-- STABLE: conforms to SemVer concept. 
-
-### @vcsuite/ui-components
-- VcsTextField BETA
-- VcsCheckbox BETA
-- VcsSelect BETA
-- VcsButton ALPHA
-- VcsFormattedNumber BETA
-- VcsLabel BETA
-- VcsTooltip ALPHA 
-- VcsActionButtonList ALPHA 
-- VcsActionList ALPHA 
-- VcsFormSection ALPHA 
-- VcsTreeView ALPHA 
-- VcsTreeViewItem ALPHA 
-- VcsList TODO 
-- VcsListItem TODO
-- VcsBadge ALPHA 
-- VcsColorPicker TODO 
-- VcsDatePicker TODO
-
-### @vcmap/core
-- Context Concept RC
-- Categories Concept BETA
-- Layers/Maps RC
-- Styles: BETA
-- Interactions: BETA
-- oblique RC
-- FeatureProvider BETA
-- ClassRegistry BETA
-- Editor TODO
-
-### @vcmap/ui
-- contentTree API BETA
-- windowManager API BETA
-- Navbar/ButtonManager/ToolboxManager ALPHA
-- OrientationTools BETA
-- ActionConcept BETA
-- PluginConcept RC
-- SEARCH API TODO
 
+![A schema on component interactions](./documentation/VC_Map_Diagram.png)
 
-# Getting started
-For a first start, clone the repo and call `npm i` `npm run start` This will start a development server. The 
-app can be opened with http://localhost:8080.
+# Project and Components
 
-Further Information see [Development](documentation/DEVELOPMENT.md) and [Plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli).
+- contentTree API [CONTENT_TREE](documentation/CONTENT_TREE.md)
+- windowManager API [WINDOWS](documentation/WINDOWS.md)
+- Navbar/ButtonManager/ToolboxManager [BUTTONS](documentation/BUTTONS.md)/[TOOLBOX](documentation/TOOLBOX.md)
+- OrientationTools
+- ActionConcept [ACTIONS](documentation/ACTIONS.md)
+- PluginConcept [Plugin API](https://github.com/virtualcitySYSTEMS/map-plugin-cli)
+- SEARCH API [SEARCH](documentation/SEARCH.md)
+- I18n API [INTERNATIONALIZATION](documentation/INTERNATIONALIZATION.md).
+- CATEGORIES API [CATEGORIES](documentation/CATEGORIES.md).
+- Context Menu API [CONTEXT_MENU](documentation/CONTEXT_MENU.md)
+- FeatureInfo [FEATURE_INFO](documentation/FEATURE_INFO.md)
+- [State & Application Link](documentation/STATE.md)
+- [Help Concept](documentation/HELP.md)
+- Copyright [ATTRIBUTIONS](documentation/ATTRIBUTIONS.md)
 
-## Included Dataset
-The included datasets for Berlin and Osnabrück in the app configurations in the project can only be used for Development.
-For further usage of the datasets please contact [Virtual City Systems](https://vc.systems).
+# Project Release Cycle and Version Management
 
+### Major Version Releases:
 
+We plan to release new major versions on an annual basis, and these releases may include breaking changes.
+Additionally, each major release will incorporate the latest versions of Cesium and Openlayers.
 
+### Patches and Minor Releases:
 
+Patches and minor releases will be issued approximately every two months. This may involve releasing minor versions of
+OpenLayers and introducing new Cesium versions, provided there are no breaking changes in the Cesium version.
+Plugins designed for a major version should seamlessly function with any new minor or patch version of VC Map.
 
+### Bugfix Support:
 
+We will offer bugfix support for the current major version and the one preceding it.
 
+# Roadmap / Future Development
+
+### Core
+
+- Clustering Prio 4
+- Style Refactoring Prio 4
+
+### Ui
+
+- Overlay API Support
+
+# Plugins
+
+[Drawing](https://github.com/virtualcitySYSTEMS/map-draw)
+[Print](https://github.com/virtualcitySYSTEMS/map-print)
+[Export](https://github.com/virtualcitySYSTEMS/map-export)
+[Swipe Tool](https://github.com/virtualcitySYSTEMS/map-swipe-tool)
+[Shadow](https://github.com/virtualcitySYSTEMS/map-shadow)
+[Create Link](https://github.com/virtualcitySYSTEMS/map-createLink)
+[Search Nominatim](https://github.com/virtualcitySYSTEMS/map-search-nominatim)
+
+### Plugins in Development
+
+|       Plugin       | Dev Prio | Proj Prio |
+| :----------------: | :------: | :-------: |
+|    Measurement     |    1     |     1     |
+|      Planning      |    1     |     1     |
+|     MultiView      |    4     |     1     |
+|   HeightProfile    |    4     |     2     |
+|       Flight       |    4     |     2     |
+|      ViewShed      |    4     |     2     |
+| TransparentTerrain |    4     |     3     |
+|      Walkmode      |    4     |     3     |
+|    ClippingTool    |    4     |     3     |
+|  AttributeEditor   |    4     |     3     |
+|       Query        |    4     |     3     |
+|  Positiondisplay   |    2     |     4     |
+|      Locator       |    4     |     4     |
+|   DisplayQuality   |    4     |     4     |
+|    Search esri     |    4     |     4     |
+|     Search WFS     |    4     |     4     |
+
+# Getting started
+
+For a first start, clone the repo and call `npm i` `npm run start` This will start a development server. The
+app can be opened with http://localhost:8080.
+
+Further Information see [GET_STARTED](documentation/GET_STARTED.md) and [Plugin-cli](https://github.com/virtualcitySYSTEMS/map-plugin-cli).
+
+## Included Dataset
+
+The included datasets for Berlin and Osnabrück in the app configurations in the project can only be used for Development.
+For further usage of the datasets please contact [Virtual City Systems](https://vc.systems).

package/app.config.json

@@ -0,0 +1,3 @@
+{
+  "modules": ["config/projects.config.json"]
+}

package/build/.eslintrc

@@ -1,5 +1,8 @@
 {
   "extends": ["@vcsuite/eslint-config/node"],
+  "env": {
+    "node": true
+  },
   "rules": {
     "import/no-extraneous-dependencies": "off"
   }