English Qlik Sense Developers 3.2

getList method

qlik.app.getList(type, callback)

Gets a list of internal Qlik Sense objects and registers a callback to receive the data.

Since:
  • 1.0
Updated:
  • 1.1, 2.0, 2.1

Parameters

Name Type Description
type String

Type of object:

  • FieldList
  • MeasureList
  • DimensionList
  • BookmarkList
  • SelectionObject
  • SnapshotList

    (Introduced in version 1.1)

  • MediaList

    (Introduced in version 1.1)

  • sheet

    (Introduced in version 1.1)

  • MasterObject

    (Introduced in version 1.1)

  • VariableList

    (Introduced in version 2.0)

  • story

    (Introduced in version 2.1)

callback Function

Optional.

Registers a callback that is executed every time data is returned.

Returns

A promise of an object model

For more information regarding a promise, see http://docs.angularjs.org/api/ng.$q.

Examples

Example: Retrieving a FieldList

app.getList("FieldList", function(reply){
	var str = "";
	$.each(reply.qFieldList.qItems, function(key, value) {
		str +=  value.qName + ' ';
	});
	alert(str);
});

Example: Retrieving a SnapshotList

app.getList("SnapshotList", function(reply){
	reply.qBookmarkList.qItems.forEach(function(snapshot){
		console.log(snapshot.qInfo.qId);
	});
});