@nebula.js/cli-sense

@nebula.js/cli-sense

The nebula sense command builds a nebula visualization so that it can be used as an extension in Qlik Sense.

Install

npm install @nebula.js/cli

Usage

nebula sense

Build a nebula visualization as a Qlik Sense extension

Options:
  --version    Show version number                                     [boolean]
  --ext        Extension definition                                     [string]
  --meta       Extension meta information                               [string]
  --output     Destination directory            [string] [default: "<name>-ext"]
  --minify     Minify and uglify code                  [boolean] [default: true]
  --sourcemap  Generate sourcemaps                    [boolean] [default: false]
  -h, --help   Show help                                               [boolean]

Extension

You can provide some additional information as part of the Qlik Sense Extension API by creating a separate file for the extension info and providing it as argument to --ext:

// def.js
export default {
  definition: {
    // Property panel definition
  },
  support: {
    exportData: true,
  },
};

nebula sense --ext def.js

The command generates all required files into the specified --output folder. You can the zip the folder and upload it as an extension on Qlik Sense Enterprise for Windows or Qlik Sense Enterprise on Kubernetes

Meta

You can add more meta about the extension by providing a .json formatted file with --meta:

{
  "name": "My tasty banana extension",
  "icon": "barchart"
}

nebula sense --meta meta.json

The rest of the required information is populated automatically based on the content in package.json.

Changelog

1.0.0 (2020-06-09)

Note: Version bump only for package nebula.js