English Qlik Sense Developers 3.2

qlik-visual web component

Syntax:  

<qlik-visual>

Since:
  • 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

See: Creating visualizations on the fly with Qlik visual to get started using the <qlik-visual> web component.

Examples of use

Learn how to use the <qlik-visual> web component.

See: Creating visualizations on the fly with Qlik visual

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:

Name Type Attr Descr
host String <optional> Qlik host.
port

String or integer

<optional> Port number.
prefix String <optional> Qlik virtual proxy. "/" if no proxy.
isSecure Boolean   Use SSL.
openWithoutData Boolean <optional>

Open app without loading data.

identity String <optional> Unique identity for the session. If omitted, the session will be shared.
visid String

This property is optional.

Visualization id. Used when displaying existing visualizations.

type String

This property is 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

This property is optional. Options to set.

See: 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.

See: Columns for details and examples.