# coggle > Library for accessing the Coggle API Latest version **0.1.8** (published 2015-01-27) · MIT license · 0 weekly downloads ## Install ```sh npm install coggle pnpm add coggle yarn add coggle bun add coggle ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.8 | | Published | 2015-01-27 | | First published | 2014-05-05 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 42 | | Author | James Crosby | | Maintainers | autopulated | | Keywords | coggle, api | ## Links - npm: https://www.npmjs.com/package/coggle - Repository: http://github.com/Coggle/coggle-js - Homepage: https://github.com/Coggle/coggle-js - Issues: https://github.com/Coggle/coggle-js/issues - npm.io page: https://npm.io/package/coggle ## Dependencies (1) - [unirest](https://npm.io/package/unirest.md) ~0.4.0 ## Recent versions - 0.1.8 (latest) — 2015-01-27 - 0.1.7 — 2015-01-27 - 0.1.6 — 2014-07-29 - 0.1.5 — 2014-07-26 - 0.1.4 — 2014-07-26 - 0.1.2 — 2014-05-05 - 0.1.1 — 2014-05-05 - 0.1.0 — 2014-05-05 ## README # Coggle API Javascript Client [![NPM version](https://badge.fury.io/js/coggle.svg)](http://badge.fury.io/js/coggle) ## Basic Use See [coggle-issue-importer](http://github.com/coggle/coggle-issue-importer) or [coggle-opml-importer](http://github.com/coggle/coggle-opml-importer) for complete example applications, including authentication. ```bash npm install coggle ``` ```js var CoggleApi = require('coggle'); var coggle = new CoggleApi({ token:user_access_token }); coggle.createDiagram( "My New Coggle" function(err, diagram){ if(err) throw err; console.log("created diagram!", diagram); } ); ``` # API Documentation ##Class `CoggleApi` The Coggle API client. ###Constructor Create a new instance of the Coggle API client. Example: ```js new CoggleApi({token:user_auth_token}) ``` Parameters: * **`options`** type: `Object` Possible Options: * **`token`**, **required**: API user authentication token ###Method `listDiagrams()` Lists diagrams accessible to the authorised user. Parameters: * **`options`** type: `Object` Possible Options: * **`organisation`**: The organisation to fetch diagrams for. (If undefined, the authenticated user's personal Coggles will be retrieved) * **`callback`** type: `Function` Callback accepting (Error, [Array of CoggleApiDiagram]) ###Method `createDiagram()` Create a new Coggle diagram. Parameters: * **`title`** type: `String` Title for the created diagram. * **`callback`** type: `Function` Callback accepting (Error, CoggleApiDiagram) ##Class `CoggleApiDiagram` Coggle API Diagram object. ###Constructor Create a new instance of a Coggle API Diagram object. Parameters: * **`coggle_api`** type: `CoggleApi` The API client used for accessing this diagram. * **`diagram_resource`** type: `Object` Diagram Resource object, with at least `_id` and `title` fields ###Method `webUrl()` Return the web URL for accessing this diagram. ###Method `getNodes()` Get all of the nodes (branch elements) in a Diagram. Parameters: * **`callback`** type: `Function` Callback accepting (Error, [Array of CoggleApiNode]) ###Method `arrange()` Rearrange the nodes in this diagram. Use with care! This function performs a server-side re-arrangement of all of the items in the diagram. It will attempt to make sure no items overlap, and to space things out evenly, it is **not** guaranteed to produce the same result when called with the same parameters. Use of this function is generally discouraged, for the same reason that an auto-arrange function isn't provided in the web interface to Coggle: the placement of items can convey meaning, and if your program understands relationships in the data (such as a natural ordering, or that some sibling branches are more closely associated than others), then you should make use of that information to perform a custom layout. Parameters: * **`callback`** type: `Function` Callback accepting (Error, [Array of CoggleApiNode]) ##Class `CoggleApiNode` Coggle API Node object, which represents individual parts("nodes") of the branches in a Coggle diagarm ###Constructor Create a new instance of a Coggle API Node object. Parameters: * **`coggle_api_diagram`** type: `CoggleApiDiagram` The Diagram in which this node belongs. * **`node_resource`** type: `Object` Node Resource object, with at least `_id` (`String`), `text` (`String`), and `offset` (`{x:Number, y:Number}`) fields. ###Method `addChild()` Add a child to this item. The child is positioned relative to this item, and will move when you move this item. Parameters: * **`text`** Text to add for the item. * **`offset`** type: `Object: {x:Number, y:Number}` Offset of the new item from this one. The `x` coordinate is along the branch direction, the `y` coordinate is vertically down from the top of the document. * **`callback`** type: `Function` Callback accepting (Error, CoggleApiNode) ###Method `update()` Update the properties of this node Parameters: * **`properties`** type: `Object: {text:String, offset:{x:Number, y:Number}, parent:String}` Omitted properties are unmodified. * **`callback`** type: `Function` Callback accepting (Error, CoggleApiNode) ###Method `setText()` Set the text of this node. Parameters: * **`text`** type: `String` New text to set * **`callback`** type: `Function` Callback accepting (Error, CoggleApiNode) ###Method `move()` Move this node to a new offset relative to its parent. Parameters: * **`offset`** type: `Object {x:Number, y:Number}` New position to set * **`callback`** type: `Function` Callback accepting (Error, CoggleApiNode) ###Method `remove()` Remove this node, and all nodes descended from it. Parameters: * **`callback`** type: `Function` Callback accepting (Error) --- _Source: https://npm.io/package/coggle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._