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

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

{
  "scriptappy": "1.1.3",
  "info": {
    "name": "@nebula.js/sn-sankey-chart:properties",
    "description": "Sankey chart generic object definition",
    "version": "1.15.0",
    "license": "MIT",
    "stability": "stable",
    "x-qlik-visibility": "public"
  },
  "entries": {
    "properties": {
      "kind": "namespace",
      "entries": {
        "footnote": {
          "description": "Visualization footnote.",
          "optional": true,
          "defaultValue": "",
          "kind": "union",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "StringExpression"
            }
          ]
        },
        "link": {
          "description": "Link style settings.",
          "entries": {
            "opacity": {
              "description": "Opacity of the links in the chart. Between 0 and 1.",
              "defaultValue": 0.5,
              "type": "number"
            }
          },
          "kind": "object"
        },
        "node": {
          "description": "Node settings.",
          "entries": {
            "padding": {
              "description": "Padding between the nodes. Between 0 and 1.",
              "defaultValue": 0.2,
              "type": "number"
            },
            "sort": {
              "description": "Sorting mode for nodes.\n\n- `undefined` - Prioritize sorting for optimal layout.\n- `'valueA'` - Sort according to value of each node, in ascending order.\n- `'valueD'` - Sort according to value of each node, in descending order.\n- `'data` - Sort according to the order of the data.",
              "optional": true,
              "kind": "union",
              "items": [
                {
                  "kind": "literal",
                  "value": "'valueA'"
                },
                {
                  "kind": "literal",
                  "value": "'valueD'"
                },
                {
                  "kind": "literal",
                  "value": "'data'"
                }
              ]
            },
            "width": {
              "description": "Width of the nodes. Can be a value between 0 and 1.",
              "defaultValue": 0.2,
              "type": "number"
            }
          },
          "kind": "object"
        },
        "qHyperCubeDef": {
          "description": "Extends `HyperCubeDef`, see Engine API: `HyperCubeDef`.",
          "extends": [
            {
              "type": "HyperCubeDef"
            }
          ],
          "kind": "object",
          "entries": {
            "qDimensions": {
              "kind": "array",
              "items": {
                "type": "#/definitions/DimensionProperties"
              }
            },
            "qMeasures": {
              "kind": "array",
              "items": {
                "type": "#/definitions/MeasureProperties"
              }
            },
            "qSuppressMissing": {
              "defaultValue": true,
              "type": "boolean"
            },
            "qSuppressZero": {
              "defaultValue": false,
              "type": "boolean"
            }
          }
        },
        "showTitles": {
          "description": "Show title for the visualization.",
          "optional": true,
          "defaultValue": true,
          "type": "boolean"
        },
        "subtitle": {
          "description": "Visualization subtitle.",
          "optional": true,
          "defaultValue": "",
          "kind": "union",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "StringExpression"
            }
          ]
        },
        "title": {
          "description": "Visualization title.",
          "optional": true,
          "defaultValue": "",
          "kind": "union",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "StringExpression"
            }
          ]
        },
        "version": {
          "description": "Current version of this generic object definition",
          "type": "string"
        }
      }
    }
  },
  "definitions": {
    "AttributeExpressionProperties": {
      "description": "Extends `NxAttrExprDef`, see Engine API: `NxAttrExprDef`.\nCan be used to color nodes (specified under dimension) or a links (specified under measure) (CSS color).\nSee example below on how to specify custom color for links in the chart.",
      "extends": [
        {
          "type": "NxAttrExprDef"
        }
      ],
      "kind": "interface",
      "entries": {},
      "examples": [
        "Set color of links to be \"green\"\n\n```json\n\"qAttributeExpressions\": [\n    {\n      \"qExpression\": \"'green'\",\n      \"qLibraryId\": \"\",\n      \"qAttribute\": true\n    }\n]\n```"
      ]
    },
    "DimensionProperties": {
      "description": "Extends `NxDimension`, see Engine API: `NxDimension`.",
      "extends": [
        {
          "type": "NxDimension"
        }
      ],
      "kind": "object",
      "entries": {
        "qAttributeExpressions": {
          "kind": "array",
          "items": {
            "type": "#/definitions/AttributeExpressionProperties"
          }
        },
        "qDef": {
          "type": "#/definitions/InlineDimensionDef"
        }
      }
    },
    "InlineDimensionDef": {
      "description": "Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.",
      "extends": [
        {
          "type": "NxInlineDimensionDef"
        }
      ],
      "kind": "object",
      "entries": {
        "othersLabel": {
          "kind": "union",
          "items": [
            {
              "type": "string"
            },
            {
              "type": "StringExpression"
            }
          ]
        },
        "autoSort": {
          "description": "Set to automatically sort the dimension.",
          "optional": true,
          "type": "boolean"
        },
        "cId": {
          "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
          "optional": true,
          "type": "string"
        }
      }
    },
    "InlineMeasureDef": {
      "description": "Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.",
      "extends": [
        {
          "type": "NxInlineMeasureDef"
        }
      ],
      "kind": "object",
      "entries": {
        "isCustomFormatted": {
          "description": "Set to true to toggle off the default client formatting.",
          "type": "boolean"
        },
        "numFormatFromTemplate": {
          "description": "When enabled, the number format to use can be selected from multiple predefined formats based on the desired type (number, date).",
          "defaultValue": true,
          "type": "boolean"
        },
        "autoSort": {
          "description": "Set to automatically sort the measure.",
          "optional": true,
          "type": "boolean"
        },
        "cId": {
          "description": "ID used by the Qlik Sense. Must be unique within the current chart.",
          "optional": true,
          "type": "string"
        }
      }
    },
    "MeasureProperties": {
      "description": "Extends `NxMeasure`, see Engine API: `NxMeasure`.",
      "extends": [
        {
          "type": "NxMeasure"
        }
      ],
      "kind": "object",
      "entries": {
        "qAttributeExpressions": {
          "kind": "array",
          "items": {
            "type": "#/definitions/AttributeExpressionProperties"
          }
        },
        "qDef": {
          "type": "#/definitions/InlineMeasureDef"
        }
      }
    }
  }
}