@nebula.js/sn-kpi

{ "scriptappy": "1.1.0", "info": { "name": "@nebula.js/sn-kpi:properties", "description": "KPI generic object definition", "version": "2.0.6", "license": "MIT", "stability": "stable", "x-qlik-visibility": "public" }, "entries": { "properties": { "extends": [ { "type": "GenericObjectProperties" } ], "kind": "object", "entries": { "version": { "description": "Current version of this generic object definition", "type": "string" }, "qHyperCubeDef": { "description": "Extends HyperCubeDef, see Engine API: HyperCubeDef", "extends": [ { "type": "HyperCubeDef" } ], "kind": "object", "entries": { "qMeasures": { "kind": "array", "items": { "type": "#/definitions/MeasureProperties" } }, "qSuppressZero": { "defaultValue": false, "type": "boolean" }, "qSuppressMissing": { "defaultValue": true, "type": "boolean" } } }, "showTitles": { "optional": true, "defaultValue": false, "type": "boolean" }, "title": { "optional": true, "defaultValue": "", "type": "string" }, "subtitle": { "optional": true, "defaultValue": "", "type": "string" }, "footnote": { "optional": true, "defaultValue": "", "type": "string" }, "showDetails": { "optional": true, "defaultValue": true, "type": "boolean" }, "showMeasureTitle": { "defaultValue": true, "type": "boolean" }, "showSecondMeasureTitle": { "defaultValue": true, "type": "boolean" }, "textAlign": { "optional": true, "defaultValue": "center", "kind": "union", "items": [ { "kind": "literal", "value": "'left'" }, { "kind": "literal", "value": "'center'" }, { "kind": "literal", "value": "'right'" } ] }, "layoutBehavior": { "optional": true, "defaultValue": "relative", "kind": "union", "items": [ { "kind": "literal", "value": "'responsive'" }, { "kind": "literal", "value": "'fixed'" }, { "kind": "literal", "value": "'relative'" } ] }, "disableNavMenu": { "defaultValue": false, "type": "boolean" }, "fontSize": { "defaultValue": "M", "kind": "union", "items": [ { "kind": "literal", "value": "'S'" }, { "kind": "literal", "value": "'M'" }, { "kind": "literal", "value": "'L'" } ] }, "useLink": { "defaultValue": false, "type": "boolean" }, "sheetLink": { "optional": true, "defaultValue": "", "type": "string" }, "openUrlInNewTab": { "optional": true, "defaultValue": true, "type": "boolean" }, "components": { "type": "array" } } } }, "definitions": { "MeasureProperties": { "description": "Extends `NxMeasure`, see Engine API: `NxMeasure`.", "extends": [ { "type": "NxMeasure" } ], "kind": "object", "entries": { "coloring": { "optional": true, "type": "#/definitions/Coloring" }, "measureAxis": { "type": "#/definitions/MeasureAxis" }, "conditionalColoring": { "type": "#/definitions/ConditionalColoring" } } }, "Coloring": { "kind": "alias", "items": { "kind": "object", "entries": { "baseColor": { "optional": true, "type": "#/definitions/PaletteColor" }, "gradient": { "optional": true, "type": "#/definitions/Gradient" } } } }, "MeasureAxis": { "kind": "alias", "items": { "kind": "object", "entries": { "min": { "type": "number" }, "max": { "type": "number" } } } }, "ConditionalColoring": { "kind": "alias", "items": { "kind": "object", "entries": { "useConditionalColoring": { "type": "boolean" }, "useBaseColors": { "type": "boolean" }, "paletteSingleColor": { "type": "#/definitions/PaletteColor" }, "segments": { "type": "#/definitions/Segments" } } } }, "Gradient": { "kind": "alias", "items": { "kind": "object", "entries": { "colors": { "kind": "array", "items": { "type": "#/definitions/PaletteColor" } }, "breakTypes": { "kind": "array", "items": { "type": "boolean" } }, "limits": { "kind": "array", "items": { "type": "number" } }, "limitType": { "kind": "union", "items": [ { "kind": "literal", "value": "'percent'" }, { "kind": "literal", "value": "'absolute'" } ] } } } }, "Segments": { "kind": "alias", "items": { "kind": "object", "entries": { "limits": { "kind": "array", "items": { "type": "#/definitions/Limit" } }, "paletteColors": { "kind": "array", "items": { "type": "#/definitions/PaletteColor" } } } } }, "Limit": { "kind": "alias", "items": { "kind": "object", "entries": { "value": { "type": "number" }, "gradient": { "type": "boolean" } } } }, "PaletteColor": { "kind": "alias", "items": { "kind": "object", "entries": { "index": { "type": "number" }, "color": { "type": "string" } } } } } }