Implementing a Funnel Chart

prototypes/funnel-chart/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "json.schemas": [
+        {
+            "fileMatch": ["/mod-manifest.json"],
+            "url": "./spotfire/mod-schema.json"
+        }
+    ]
+}

prototypes/funnel-chart/.vscode/tasks.json

@@ -0,0 +1,17 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Start ",
+            "type": "shell",
+            "command": "npm start",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "problemMatcher": ["$tsc"]
+        }
+    ]
+}

prototypes/funnel-chart/README.md

@@ -0,0 +1,27 @@
+# Funnel Chart
+
+![Funnel chart example](rose-chart.png)
+
+This is a mod example demonstrating a funnel chart written in `TypeScript`, rendered with `d3` and bundled with `Webpack`.
+
+All source code for the mod example can be found in the `src` folder. Other necessary files reside in the `static` folder. Read below for further explanation.
+
+## Prerequisites
+
+These instructions assume that you have [Node.js](https://nodejs.org/en/) (which includes npm) installed.
+
+## How to get started (with development server)
+
+- Open a terminal at the location of this example.
+- Run `npm install`. This will install necessary tools. Run this command only the first time you are building the mod and skip this step for any subsequent builds.
+- Run `npm start`. This will compile TypeScript to JavaScript and place the bundle in the `dist` folder. This task will watch for changes in code and will continue running until it is stopped. Whenever you save a file, the changes will be reflected in the visualization mod.
+- Run `npm run server` in a separate terminal. This will start a development server.
+- Start editing, for example `src/main.ts`.
+- In Spotfire, follow the steps of creating a new mod and connecting to the development server.
+
+## Working without a development server
+
+- Open a terminal at the location of this example.
+- Run `npm install`. This will install necessary tools. Run this command only the first time you are building the mod and skip this step for any subsequent builds.
+- Run `npm run build`. This will bundle the JavaScript and place it in the `dist` folder. It also copies the contents of `static` into `dist`. This task will not watch for changes in code.
+- In Spotfire, follow the steps of creating a new mod and then browse for, and point to, the _manifest_ in the `dist` folder.