# depthmapx

> depthmapX for Node.js

Latest version **0.0.11** (published 2017-12-30) · 0 weekly downloads

## Install

```sh
npm install depthmapx
pnpm add depthmapx
yarn add depthmapx
bun add depthmapx
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.11 |
| Published | 2017-12-30 |
| First published | 2017-12-22 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | frederic-schwarz, tomas-polach |

## Links

- npm: https://www.npmjs.com/package/depthmapx
- Repository: https://github.com/archilogic-com/depthmapX-nodejs
- Homepage: https://github.com/archilogic-com/depthmapX-nodejs#readme
- Issues: https://github.com/archilogic-com/depthmapX-nodejs/issues
- npm.io page: https://npm.io/package/depthmapx

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^2.3.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.1

## Recent versions

- 0.0.11 (latest) — 2017-12-30
- 0.0.10 — 2017-12-30
- 0.0.9 — 2017-12-26
- 0.0.8 — 2017-12-23
- 0.0.7 — 2017-12-22
- 0.0.6 — 2017-12-22
- 0.0.5 — 2017-12-22
- 0.0.4 — 2017-12-22
- 0.0.3 — 2017-12-22
- 0.0.2 — 2017-12-22
- 0.0.1 — 2017-12-22

## README

# depthmapX for Node.js 

Command Line Interface bindings for [SpaceGroupUCL/depthmapX](https://github.com/SpaceGroupUCL/depthmapX/).

## Compatibility

- **OSX** and **Linux** are fully supported.
- **Windows** will be supported soon after the next release of depthmapX CLI.<br>https://github.com/archilogic-com/node-depthmapX/issues/1

## Methods

Every global option in depthmap CLI translates to a module method.

| CLI mode option | node module method |
| -------------------- | --------------------- |
| -m VGA | dmx.vga |
| -m LINK | dmx.link |
| -m VISPREP | dmx.visprep |
| -m AXIAL | dmx.axial | 
| -m AGENTS | dmx.agents |
| -m ISOVIST | dmx.isovist |
| -m EXPORT | dmx.exportData |
| -m IMPORT | dmx.importData |
  
## Method Options

depthmapX CLI options are translated directly into node method options. See [official depthmapX CLI docs](https://github.com/SpaceGroupUCL/depthmapX/blob/master/docs/commandline.md) for reference.

## Example
```javascript
const dmx = require('depthmapx')

// 1. import file

dmx.importData({
  f: 'example/archilogic-office.dxf',
  o: 'example/1_new.graph'
}).then(() => {

  // 2. calculate visibility
  
  return dmx.visprep({
    f:'example/1_new.graph',
    o:'example/2_visibility.graph',
    pg:'0.1',
    pp:'3.0,3.0'
  })
   
}).then(() => {

  // 3. export as CSV
  
  return dmx.exportData({
    f: 'example/2_visibility.graph',
    o: 'example/3_visibility.csv',
    em: 'pointmap-data-csv'
  })

})

```

---
_Source: https://npm.io/package/depthmapx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._