Product knowledge
Docs
Extension template reference
Discover the templates installed with your Gateway and choose one that matches the required visual or action contract.
On this page
Use the installed catalogue
Call list_extension_templates to see the templates available to the connected Gateway, then get_extension_template for the selected ID. Read the returned manifest and base assets before generating a package. The installed catalogue is the reference for IDs, expected data and property options.
A visualization library suggests an implementation approach; it does not guarantee a public example will work unchanged inside Qlik. Check the data contract, bundled dependencies, browser behavior and licensing for the proposed extension.
- ECharts templates suit configurable chart patterns built around an explicit option and data mapping.
- D3 adapter templates provide a starting point for bespoke SVG or canvas rendering.
- Chart.js templates support canvas-based chart implementations.
- Picasso and nebula templates provide Qlik-oriented visualization patterns.
- The writeback action template provides a browser interface to a stored Gateway action; it does not create the database target or approve the action.
Define data and interaction before packaging
Identify each dimension and measure, its business meaning, aggregation, format and expected cardinality. Decide how nulls, totals, sorting, empty results and limited fetches should appear. Labels and categories often map to dimensions; position, size and numeric intensity often map to measures. Confirm the mapping against the actual Qlik model.
Document whether interactions make Qlik selections or only change the extension's local view. Local zoom, hover and drill behavior must remain understandable to users who expect Qlik selection state to apply consistently across the sheet.
Keep the package maintainable
Generated packages include a raptor-extension.json manifest for the extension's source, template, data contract and implementation notes. Keep chart-specific decisions there and in the customer's project files. Shared templates should remain reusable across projects.
Inspect the manifest after packaging and after publication. Check that required assets are present, remote resources are approved and the sheet object's extension type matches the published name. Finish with a browser test using representative data and the customer's intended user role.
Previous
Custom Qlik extensions
Next