@nebula.js/sn-pivot-table 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Qlik - Open Source Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+[![CircleCI](https://circleci.com/gh/qlik-oss/sn-pivot-table.svg?style=shield)](https://circleci.com/gh/qlik-oss/sn-pivot-table)
+
+# sn-pivot-table
+
+Pivot Table supernova for [nebula.js]
+
+More specifics and information about the sn-pivot-table can be found in [the Qlik developer portal](https://qlik.dev/libraries-and-tools/visualizations/pivot-table).
+
+## Mashup Usage
+
+### Installing
+
+If you use npm:
+
+`npm install @nebula.js/sn-pivot-table`
+
+Or without build tool, You can also load the sn-pivot-table through the script tag from [unpkg](https://unpkg.com/@nebula.js/sn-pivot-table).
+
+```html
+<script src="https://unpkg.com/@nebula.js/sn-pivot-table"></script>
+```
+
+### Usage
+
+```js
+import { embed } from '@nebula.js/stardust';
+import pivotTable from '@nebula.js/sn-pivot-table';
+
+// 'app' is an enigma app model
+const nuked = embed(app, {
+  types: [{ // register the pivot table object
+    name: 'pivot-table',
+    load: () => Promise.resolve(pivotTable);
+  }]
+});
+
+nuked.render({
+  element,
+  type: 'pivot-table',
+});
+```
+
+### Tutorial & Examples
+
+Look into [Build a simple mashup using nebula.js](https://qlik.dev/tutorials/build-a-simple-mashup-using-nebulajs) and [Embed a visualization](https://qlik.dev/libraries-and-tools/nebulajs/rendering) to learn more.
+
+[Check full examples](./mashup-example) of the mashup usage.
+
+## Visualization Extension Usage
+
+### Building and adding the sn-pivot-table extension to Qlik Sense
+
+Install all dependencies:
+
+```sh
+yarn
+```
+
+Build a nebula.js visualization as a Qlik Sense extension:
+
+```sh
+yarn build
+```
+
+Compress the generated 'sn-pivot-table-ext' folder into the 'application/zip' file format
+
+|                                [Saas Edition of Qlik Sense]                              |                        [Qlik Sense Enterprise]                         |                               [Qlik Sense Desktop]                               |
+| :--------------------------------------------------------------------------------------: | :--------------------------------------------------------------------: | :------------------------------------------------------------------------------: |
+| Copy sn-pivot-table-ext into https://your-tenant-id.us.qlikcloud.com/console/extensions/ | Copy sn-pivot-table-ext into Qlik Management Console (QMC)->Extensions | Copy sn-pivot-table-ext into ..\Users\<UserName>\Documents\Qlik\Sense\Extensions |
+
+## API
+
+The API can also be found in [the Qlik developer portal](https://qlik.dev/apis/javascript/nebula-pivot-table)
+
+## Contribution
+
+To learn how to run a sn-pivot-table extension using nebula development server and develop, see our [contributing guide](./.github/CONTRIBUTION.md).
+
+## Package
+
+| name             | status                                         | description                         |
+| ---------------- | ---------------------------------------------- | ----------------------------------- |
+| [sn-pivot-table] | [![sn-pivot-table-status]][sn-pivot-table-npm] | pivot-table supernova for nebula.js |
+
+## License
+
+`@nebula.js/sn-pivot-table` is [MIT licensed](./LICENSE).
+
+[nebula.js]: https://qlik.dev/libraries-and-tools/nebulajs
+[sn-pivot-table]: https://github.com/qlik-oss/sn-pivot-table
+[sn-pivot-table-status]: https://img.shields.io/npm/v/@nebula.js/sn-pivot-table.svg
+[sn-pivot-table-npm]: https://www.npmjs.com/package/@nebula.js/sn-pivot-table
+[saas edition of qlik sense]: https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-extensions.htm
+[qlik sense enterprise]: https://help.qlik.com/en-US/sense-developer/May2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm
+[qlik sense desktop]: https://help.qlik.com/en-US/sense-developer/May2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm

package/api-specifications/properties.json

@@ -0,0 +1,130 @@
+{
+  "scriptappy": "1.0.0",
+  "info": {
+    "name": "@nebula.js/sn-pivot-table:properties",
+    "description": "Pivot Table generic object definition",
+    "version": "0.2.0",
+    "license": "MIT",
+    "stability": "experimental",
+    "x-qlik-visibility": "public"
+  },
+  "entries": {
+    "properties": {
+      "extends": [
+        {
+          "type": "GenericObjectProperties"
+        }
+      ],
+      "kind": "object",
+      "entries": {
+        "footnote": {
+          "description": "Visualization footnote",
+          "optional": true,
+          "defaultValue": "",
+          "kind": "union",
+          "items": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "StringExpression"
+            }
+          ],
+          "type": "any"
+        },
+        "nullValueRepresentation": {
+          "description": "Null value properties",
+          "optional": true,
+          "kind": "object",
+          "entries": {
+            "text": {
+              "description": "Null value text",
+              "optional": true,
+              "defaultValue": "-",
+              "type": "string"
+            }
+          }
+        },
+        "qHyperCubeDef": {
+          "extends": [
+            {
+              "type": "HyperCubeDef"
+            }
+          ],
+          "kind": "object",
+          "entries": {
+            "qAlwaysFullyExpanded": {
+              "defaultValue": false,
+              "type": "boolean"
+            },
+            "qDimensions": {
+              "kind": "array",
+              "items": {
+                "type": "NxDimension"
+              }
+            },
+            "qMeasures": {
+              "kind": "array",
+              "items": {
+                "type": "NxMeasure"
+              }
+            },
+            "qShowTotalsAbove": {
+              "defaultValue": true,
+              "type": "boolean"
+            },
+            "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"
+            }
+          ],
+          "type": "any"
+        },
+        "title": {
+          "description": "Visualization title",
+          "optional": true,
+          "defaultValue": "",
+          "kind": "union",
+          "items": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "StringExpression"
+            }
+          ],
+          "type": "any"
+        },
+        "version": {
+          "description": "Current version of this generic object definition",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "definitions": {}
+}