manifest.json

{
  "name": "Orbital Transaction Flow",
  "frameworkVersion": "v1",
  "icon": "icon.svg",
  "thumbnail": "thumbnail.png",
  "tags": [
    "custom",
    "transaction",
    "flow",
    "circle",
    "gooey",
    "orbit"
  ],
  "sandbox": false,
  "autoPane": true,
  "autoQuery": true,
  "dataLimit": 1000,
  "supportsSelection": true,
  "options": {
    "items": {
      "animationDuration": {
        "displayName": "Duration",
        "detail": "In seconds, tells for how long the whole animation should run. N.B. for high number of transactions the total animation duration may increase to avoid browser performance issues.",
        "type": "NUMBER",
        "mandatory": true,
        "isDecimal": false,
        "minValue": 1,
        "maxValue": 100
      },
      "animationRestartOnData": {
        "displayName": "Restart on data change",
        "detail": "If true restarts the whole animation when data changes, e.g. when filters are applied or new records are added to the dataset. Default false.",
        "type": "TOGGLE"
      },
      "txLabels": {
        "displayName": "Show transactions labels",
        "detail": "If true show transations information information as the animation goes.",
        "type": "TOGGLE"
      },
      "centreNodeId": {
        "displayName": "Centre Node ID",
        "detail": "ID of the node shown at the centre of the view",
        "type": "TEXT",
        "mandatory": true
      },
      "date": {
        "displayName": "Date",
        "detail": "Date of the transaction. Can be used to group transactions per date interval, so transactions with the same source and target that happen in the same interval will be shown as one with a cumulative size.",
        "type": "GROUPING",
        "mandatory": true,
        "validFieldTypes": [
          "DATE"
        ]
      },
      "link": {
        "displayName": "ID",
        "detail": "Unique Identifier of the transaction",
        "type": "FIELD",
        "mandatory": true,
        "validFieldTypes": [
          "TEXT"
        ]
      },
      "paneX": {
        "displayName": "Pane X",
        "type": "GROUPING",
        "list": true
      },
      "paneY": {
        "displayName": "Pane Y",
        "type": "GROUPING",
        "list": true
      },
      "size": {
        "displayName": "Value",
        "iconName": "visokio-option-icon:size-measure",
        "type": "MEASURE",
        "mandatory": true
      },
      "source": {
        "displayName": "Source",
        "detail": "Identifier of the source sending the transaction",
        "type": "MEASURE",
        "mandatory": true
      },
      "target": {
        "displayName": "Target",
        "detail": "Identifier of the target where the transaction is sent to",
        "type": "MEASURE",
        "mandatory": true
      }
    },
    "structure": {
      "toolbar": [
        "link",
        "date",
        "size"
      ],
      "x": [
        "paneX"
      ],
      "y": [
        "paneY"
      ]
    },
    "optionGroups": [{
      "displayName": "Chart",
      "rows": [{
        "cells": [{
          "option": "centreNodeId",
          "usePrefixTitle": false
        }]
      }]
    }, {
      "displayName": "Transaction",
      "rows": [{
        "cells": [{
          "option": "link",
          "usePrefixTitle": false
        }, {
          "option": "date",
          "usePrefixTitle": false
        }, {
          "option": "source",
          "usePrefixTitle": false
        }, {
          "option": "target",
          "usePrefixTitle": false
        }, {
          "option": "size",
          "usePrefixTitle": false
        }]
      }]
    }, {
      "displayName": "Animation",
      "rows": [{
        "cells": [{
          "option": "animationDuration",
          "usePrefixTitle": false
        }, {
          "option": "animationRestartOnData",
          "usePrefixTitle": false
        }, {
          "option": "txLabels",
          "usePrefixTitle": false
        }]
      }]
    }, {
      "displayName": "Pane/tile",
      "rows": [{
        "cells": [{
          "option": "paneX",
          "usePrefixTitle": false
        }]
      }, {
        "cells": [{
          "option": "paneY",
          "usePrefixTitle": false
        }]
      }]
    }]
  },
  "defaultOptions": {
    "items": {
      "animationDuration": 10
    },
    "pane": {
      "yAxisHeaderWidth": 75,
      "paneWidth": 200,
      "paneHeight": 200,
      "gridLineThickness": 1,
      "gridLineColour": "rgba(229,229,229,1)",
      "headerStyle": {
        "size": 12,
        "colour": "#333333",
        "backgroundColour": "#FFFFFF"
      },
      "tileHeaderAlignment": "CENTER",
      "xHeaderPlacement": "TOP",
      "yHeaderPlacement": "LEFT",
      "showColourKeyInEveryPane": false,
      "enableTouchScrolling": false
    }
  },
  "pane": {
    "minWidth": 50,
    "minHeight": 50
  }
}