@nebula.js/sn-pivot-table 2.1.0 → 2.3.0

package/api-specifications/properties.json

@@ -3,7 +3,7 @@
   "info": {
     "name": "@nebula.js/sn-pivot-table:properties",
     "description": "Pivot Table generic object definition",
-    "version": "2.1.0",
+    "version": "2.3.0",
     "license": "MIT",
     "stability": "experimental",
     "x-qlik-visibility": "public"
@@ -36,13 +36,13 @@
             "qDimensions": {
               "kind": "array",
               "items": {
-                "type": "NxDimension"
+                "type": "#/definitions/DimensionProperties"
               }
             },
             "qMeasures": {
               "kind": "array",
               "items": {
-                "type": "NxMeasure"
+                "type": "#/definitions/MeasureProperties"
               }
             },
             "qSuppressMissing": {
@@ -121,8 +121,8 @@
           "kind": "object"
         },
         "components": {
-          "description": "Holds general styling",
-          "nullable": true,
+          "description": "General and chart specific styling",
+          "optional": true,
           "kind": "array",
           "items": {
             "type": "#/definitions/Component"
@@ -132,99 +132,399 @@
     }
   },
   "definitions": {
+    "DimensionProperties": {
+      "description": "Extends `NxDimension`, see Engine API: `NxDimension`",
+      "extends": [
+        {
+          "type": "NxDimension"
+        }
+      ],
+      "kind": "object",
+      "entries": {
+        "qDef": {
+          "type": "#/definitions/InlineDimensionDef"
+        },
+        "qAttributeExpressions": {
+          "kind": "array",
+          "items": {
+            "type": "#/definitions/AttributeExpressionDef"
+          }
+        }
+      }
+    },
+    "MeasureProperties": {
+      "description": "Extends `NxMeasure`, see Engine API: `NxMeasure`",
+      "extends": [
+        {
+          "type": "NxMeasure"
+        }
+      ],
+      "kind": "object",
+      "entries": {
+        "qDefs": {
+          "type": "#/definitions/InlineMeasureDef"
+        },
+        "qAttributeExpressions": {
+          "kind": "array",
+          "items": {
+            "type": "#/definitions/AttributeExpressionDef"
+          }
+        }
+      }
+    },
+    "AttributeExpressionDef": {
+      "kind": "union",
+      "items": [
+        {
+          "type": "#/definitions/ColorByExpressionDef"
+        },
+        {
+          "type": "NxAttrExprDef"
+        }
+      ]
+    },
+    "ColorByExpressionId": {
+      "description": "Color by expression identifier",
+      "kind": "union",
+      "items": [
+        {
+          "kind": "literal",
+          "value": "\"cellBackgroundColor\""
+        },
+        {
+          "kind": "literal",
+          "value": "\"cellForegroundColor\""
+        }
+      ]
+    },
+    "ColorByExpressionDef": {
+      "kind": "object",
+      "entries": {
+        "qExpression": {
+          "type": "StringExpression"
+        },
+        "id": {
+          "type": "#/definitions/ColorByExpressionId"
+        }
+      },
+      "examples": [
+        "{ qExpression: \"=if(Sum([Sales Quantity]) > 500, green(), blue())\", id: \"cellBackgroundColor\" }"
+      ]
+    },
+    "InlineDimensionDef": {
+      "description": "Extends `NxInlineDimensionDef`, see Engine API: `NxInlineDimensionDef`.",
+      "extends": [
+        {
+          "type": "NxInlineDimensionDef"
+        }
+      ],
+      "kind": "object",
+      "entries": {
+        "columnWidth": {
+          "optional": true,
+          "type": "#/definitions/ColumnWidth"
+        }
+      }
+    },
+    "InlineMeasureDef": {
+      "description": "Extends `NxInlineMeasureDef`, see Engine API: `NxInlineMeasureDef`.",
+      "extends": [
+        {
+          "type": "NxInlineMeasureDef"
+        }
+      ],
+      "kind": "object",
+      "entries": {
+        "columnWidth": {
+          "optional": true,
+          "type": "#/definitions/ColumnWidth"
+        }
+      }
+    },
+    "ColumnWidth": {
+      "description": "Column width info. For the left grid, the properties are always applied.\nFor the right grid, only the leaf nodes will listen to the properties, and the columns above will get the width of the leaves accumulated",
+      "kind": "object",
+      "entries": {
+        "type": {
+          "description": "Defines how the column width is set. For the right grid, `auto` calculates the width(s) so the total width of the columns equals the right grid width. If the width reaches a minimum value, the columns will overflow. For the left grid, `auto` is N/A and defaults to `fitToContent`. `fitToContent` calculates a width based on the column's content. `pixels` uses a specified pixel value. `percentage` sets the column width to specified percentage of the chart/grid width",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'auto'"
+            },
+            {
+              "kind": "literal",
+              "value": "'FitToContent'"
+            },
+            {
+              "kind": "literal",
+              "value": "'pixels'"
+            },
+            {
+              "kind": "literal",
+              "value": "'percentage'"
+            }
+          ]
+        },
+        "pixels": {
+          "description": "Pixel value used if type is `pixels`",
+          "optional": true,
+          "type": "number"
+        },
+        "percentage": {
+          "description": "Percentage value used if type is `percentage`. Note that for the left grid columns, this is a percentage of the whole chart width. For the right grid columns, it is a percentage of the right grid width",
+          "optional": true,
+          "type": "number"
+        }
+      }
+    },
     "Component": {
-      "description": "General styling for all columns.\nSplit up into header and content (body) styling.\nIf any property is not set, default values specific for each property is used.",
-      "kind": "alias",
-      "items": {
-        "kind": "object",
-        "entries": {
-          "key": {
-            "description": "This should be set to `theme`",
-            "type": "string"
-          },
-          "content": {
-            "optional": true,
-            "type": "#/definitions/ContentStyling"
-          },
-          "header": {
-            "optional": true,
-            "type": "#/definitions/HeaderStyling"
+      "description": "Styling defintions",
+      "kind": "union",
+      "items": [
+        {
+          "type": "#/definitions/ChartStyling"
+        },
+        {
+          "type": "#/definitions/GeneralStyling"
+        }
+      ]
+    },
+    "GeneralStylingKey": {
+      "description": "Mandatory key for general styling",
+      "kind": "literal",
+      "value": "\"general\""
+    },
+    "FontStyleValues": {
+      "description": "Font styling values",
+      "kind": "union",
+      "items": [
+        {
+          "kind": "literal",
+          "value": "\"bold\""
+        },
+        {
+          "kind": "literal",
+          "value": "\"italic\""
+        },
+        {
+          "kind": "literal",
+          "value": "\"underline\""
+        }
+      ]
+    },
+    "GeneralStyling": {
+      "description": "General chart styling",
+      "kind": "object",
+      "entries": {
+        "key": {
+          "type": "#/definitions/GeneralStylingKey"
+        },
+        "title": {
+          "type": "#/definitions/TitleStyling"
+        }
+      },
+      "examples": [
+        "{\n key: \"general\",\n title: {\n   main: {\n     fontSize: \"18px\",\n     fontFamily: \"Arial\",\n     fontStyle: [\"bold\", \"italic\"],\n     color: { color: \"orangered\" },\n   }\n }\n}"
+      ]
+    },
+    "TitleOptions": {
+      "description": "Title styling options",
+      "kind": "object",
+      "entries": {
+        "fontSize": {
+          "description": "Font size in pixel value",
+          "optional": true,
+          "type": "string"
+        },
+        "fontFamily": {
+          "description": "Font family",
+          "optional": true,
+          "type": "string"
+        },
+        "fontStyle": {
+          "description": "Font style",
+          "optional": true,
+          "kind": "array",
+          "items": {
+            "type": "#/definitions/FontStyleValues"
           }
+        },
+        "color": {
+          "description": "Font color palette",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
         }
       }
     },
-    "ContentStyling": {
-      "description": "Holds properties for font size, font color and hover styling.",
-      "kind": "alias",
-      "items": {
-        "kind": "object",
-        "entries": {
-          "fontSize": {
-            "description": "Defaults to `14`",
-            "optional": true,
-            "type": "number"
-          },
-          "fontColor": {
-            "description": "Defaults to `#404040`",
-            "optional": true,
-            "type": "#/definitions/PaletteColor"
-          },
-          "hoverEffect": {
-            "description": "Toggles hover effect",
-            "optional": true,
-            "type": "boolean"
-          },
-          "hoverColor": {
-            "description": "Background hover color. Uses `#f4f4f4` if no hover colors are set, is transparent if only `hoverFontColor` is set",
-            "optional": true,
-            "type": "#/definitions/PaletteColor"
-          },
-          "hoverFontColor": {
-            "description": "When only `hoverColor` is set, this is adjusted to either `#f4f4f4` or `#ffffff` for optimal contrast",
-            "optional": true,
-            "type": "#/definitions/PaletteColor"
-          },
-          "padding": {
-            "description": "Css setting for the cell padding, defaults to `4px 12px`",
-            "optional": true,
-            "type": "string"
+    "TitleStyling": {
+      "description": "Title styling",
+      "kind": "object",
+      "entries": {
+        "main": {
+          "description": "Styling for chart title",
+          "optional": true,
+          "type": "#/definitions/TitleOptions"
+        },
+        "subTitle": {
+          "description": "Styling for chart sub title",
+          "optional": true,
+          "type": "#/definitions/TitleOptions"
+        },
+        "footer": {
+          "description": "Styling for chart footer",
+          "optional": true,
+          "type": "#/definitions/TitleOptions"
+        }
+      }
+    },
+    "ChartStylingKey": {
+      "description": "Mandatory key for chart styling",
+      "kind": "literal",
+      "value": "\"theme\""
+    },
+    "ChartStyling": {
+      "description": "Custom styling of cells",
+      "kind": "object",
+      "entries": {
+        "key": {
+          "type": "#/definitions/ChartStylingKey"
+        },
+        "header": {
+          "description": "Styling for header cells",
+          "optional": true,
+          "type": "#/definitions/CellStyling"
+        },
+        "dimensionValues": {
+          "description": "Styling for dimension value cells",
+          "optional": true,
+          "type": "#/definitions/CellStyling"
+        },
+        "measureValues": {
+          "description": "Styling for measure value cells",
+          "optional": true,
+          "type": "#/definitions/CellStyling"
+        },
+        "measureLabels": {
+          "description": "Styling for measure label cells",
+          "optional": true,
+          "type": "#/definitions/PartialCellStyling"
+        },
+        "totalValues": {
+          "description": "Styling for total value cells",
+          "optional": true,
+          "type": "#/definitions/PartialCellStyling"
+        },
+        "nullValues": {
+          "description": "Styling for null values cells",
+          "optional": true,
+          "type": "#/definitions/PartialCellStyling"
+        },
+        "grid": {
+          "description": "General grid styling",
+          "optional": true,
+          "type": "#/definitions/GridStyling"
+        }
+      },
+      "examples": [
+        "{\n key: \"theme\",\n dimensionValues: {\n   fontSize: \"18px\",\n   fontFamily: \"Arial\",\n   fontStyle: [\"bold\", \"italic\"],\n   fontColor: { color: \"orangered\" },\n   background: { index: 2 }\n }\n}"
+      ]
+    },
+    "CellStyling": {
+      "description": "Properties for styling a cell",
+      "kind": "object",
+      "entries": {
+        "fontSize": {
+          "description": "Font size in pixel value",
+          "optional": true,
+          "type": "string"
+        },
+        "fontFamily": {
+          "description": "Font family",
+          "optional": true,
+          "type": "string"
+        },
+        "fontStyle": {
+          "description": "Font style",
+          "optional": true,
+          "kind": "array",
+          "items": {
+            "type": "#/definitions/FontStyleValues"
           }
+        },
+        "fontColor": {
+          "description": "Font color palette",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "background": {
+          "description": "Cell background color palette",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
         }
       }
     },
-    "HeaderStyling": {
-      "description": "Holds properties for font size and color.",
-      "kind": "alias",
-      "items": {
-        "kind": "object",
-        "entries": {
-          "fontSize": {
-            "description": "Defaults to `14`",
-            "optional": true,
-            "type": "number"
-          },
-          "fontColor": {
-            "description": "Defaults to `#404040`",
-            "optional": true,
-            "type": "#/definitions/PaletteColor"
+    "PartialCellStyling": {
+      "description": "Properties for styling a cell",
+      "kind": "object",
+      "entries": {
+        "fontStyle": {
+          "description": "Font style",
+          "optional": true,
+          "kind": "array",
+          "items": {
+            "type": "#/definitions/FontStyleValues"
           }
+        },
+        "fontColor": {
+          "description": "Font color palette",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "background": {
+          "description": "Cell background color palette",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        }
+      }
+    },
+    "GridStyling": {
+      "description": "General grid styling",
+      "kind": "object",
+      "entries": {
+        "lineClamp": {
+          "description": "A numerical value that represents the number of lines a text at most can be splitt into",
+          "optional": true,
+          "type": "number"
+        },
+        "border": {
+          "description": "Border color between cells",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "divider": {
+          "description": "Border color between row and column dimensions sections",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "background": {
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
         }
       }
     },
     "PaletteColor": {
       "description": "Color information structure. Holds the actual color and index in palette",
-      "kind": "alias",
-      "items": {
-        "kind": "object",
-        "entries": {
-          "color": {
-            "description": "Color as hex string (mandatory if index: -1)",
-            "type": "string"
-          },
-          "index": {
-            "description": "Index in palette",
-            "type": "number"
-          }
+      "kind": "object",
+      "entries": {
+        "color": {
+          "description": "Color as hex string (mandatory if index: -1)",
+          "type": "string"
+        },
+        "index": {
+          "description": "Index in palette",
+          "type": "number"
         }
       }
     }