CityJSON Vue components

A collection of Vue components to work with CityJSON files.

Installation

You can install from npm with:

npm i cityjson-vue-components

or the development version from GitHub:

npm install git+https://[email protected]/tudelft3d/cityjson-vue-components.git

Usage

In your main JavaScript folder, import the library and register the components:

import CityJSONComponents from 'cityjson-vue-components'

Vue.use(CityJSONComponents)

Then you can simply use the components in your template.

Components

ThreeJsViewer

A 3D viewer for a citymodel which is based on threejs.

CityObjectInfo

A component that view details about a city object.

CityObjectCard

A card wrapper for CityObjectInfo.

CityObjectsTree

A tree view of city objects.

Development

The components are located in the lib-components folder and they are exported through src/lib-components/index.js.

Examples to ease the development are provided in the examples folder. You can work with them running: vue serve examples/{exampleName}.vue.

To build a new version run: npm run build. The output files are located in dist.

For more information you may read:

• the official cookbook recipe of Vue.js of how to bundle components for npm, or
• the vue-sfc-rollup template upon which this repository is based.