qlik-visual web component

If you are using Qlik Sense Business or Qlik Sense Enterprise SaaS, see the API documentation at the Qlik (Developer Portal).

Syntax

<qlik-visual>

Version history

Version history
Version state	Details
Introduced	2.2

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.

Getting started

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.

Creating visualizations on the fly

Properties

Properties
Name	Type	Description
appid	String	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.
config	Object	Optional. Additional configuration parameters: host: Type: String Attr: <optional> Descr: Qlik host. port: Type: String or Integer Attr: <optional> Descr: Port number. prefix: Type: String Attr: <optional> Descr: isSecure: Type: Boolean Attr: <optional> Descr: Qlik virtual proxy. "/" if no proxy. openWithoutData: Type: Boolean Attr: <optional> Descr: Use SSL. identity: Type: String Attr: <optional> Descr: Unique identity for the session. If omitted, the session will be shared.
visid	String	Optional. Visualization id. Used when displaying existing visualizations.
type	String	Optional. Visualization type. Used when creating a visualization on the fly. Can be one of: barchart combochart gauge kpi linechart piechart pivot-table scatterplot table treemap extension
options	String	Optional. Options to set. Options for all the properties that can be set for each visualization type.
cols	String	Column definitions, dimensions and measures. Each entry can be of the following structures: String NxDimension NxMeasure 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.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here