@nebula.js/sn-sankey-chart/api-specifications/plugins.json

A flow diagram visually emphasizing major transfers or flows within defined system boundaries.

{
  "scriptappy": "1.1.0",
  "info": {
    "name": "@nebula.js/sn-sankey-chart:plugins",
    "description": "Sankey chart plugins API definitions",
    "version": "1.10.31",
    "license": "MIT",
    "stability": "experimental",
    "x-qlik-visibility": "public"
  },
  "entries": {
    "pluginArguments": {
      "description": "The arguments that are passed to the fn function of the plugin definition.",
      "kind": "namespace",
      "entries": {
        "keys": {
          "description": "The keys (references) to different types of chart internals",
          "entries": {
            "COMPONENT": {
              "description": "The unique keys of the existing components available in the sankey chart.\nThey are useful if you want to extend or override the existing components.",
              "entries": {
                "LABELS": {
                  "description": "The labels component",
                  "defaultValue": "labels",
                  "type": "string"
                },
                "LABELS_TITLES": {
                  "description": "The labels titles component",
                  "defaultValue": "labels-titles",
                  "type": "string"
                }
              },
              "kind": "object"
            },
            "SCALE": {
              "description": "The scales associated with the sankey chart.\nThey are useful if you want to, via plugin, add a new component that\nuses the same scale as one of the measures.",
              "entries": {
                "DIMENSIONS": {
                  "description": "The dimensions scale",
                  "defaultValue": "dimensions",
                  "type": "string"
                }
              },
              "kind": "object"
            }
          },
          "kind": "object"
        },
        "layout": {
          "description": "The layout from the enigma model.",
          "type": "object"
        }
      }
    }
  },
  "definitions": {
    "getPluginArgs": {
      "description": "Prepare important chart internals for the users to build their own plugins",
      "kind": "function",
      "params": [
        {
          "name": "layoutService",
          "type": "object"
        }
      ],
      "returns": {
        "description": "Chart internals that will be exposed to the users.",
        "type": "#/entries/pluginArguments"
      }
    }
  }
}