Use Qlik API Insights to see the version history for Qlik APIs and to compare API changes between versions.
API Insights is deprecated and may be removed in a future release. See API change log instead.
Qlik visual is a custom element definition, <qlik-visual>, that uses the Visualization API and exposes it as a web component. It allows you to create and modify visualizations on the fly without making use of the Qlik Sense client. Qlik visual supports:
- Displaying an existing visualization (by defining a visid to the element) in a web page.
- Creating visualizations on the fly using an existing app by injecting them into the web page.
- Dynamically modifying properties and attributes of the visualizations.
Creating visualizations on the fly to get started using the <qlik-visual> web component.
Examples of use
Learn how to use the <qlik-visual> web component.
Qlik Sense app id.
If all Qlik visuals use visualizations from the same app, you only need to define appid for the first instance.
If you use visualizations from different apps you should always define appid.
Additional configuration parameters:
Visualization id. Used when displaying existing visualizations.
Visualization type. Used when creating a visualization on the fly. Can be one of:
Optional. Options to set.
Options for all the properties that can be set for each visualization type.
Column definitions, dimensions and measures. Each entry can be of the following structures:
If the NxDimension or the NxMeasure refer to a library dimension or a library measure, you also need to add qType : "measure" or "dimension".
This parameter is optional. Leave empty for visualizations that does not have dimensions or measures.
Columns for details and examples.