getList method

Note: STABLE.
This API is reliable and breaking changes are unlikely.

qlik.app.getList(type, callback)

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

Version history

Introduced 1.0
Updated 1.1, 2.0, 2.1

Parameters

type

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

Type: Function

Optional.

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

Returns

A promise of an object model

Tip: For more information regarding a promise, see https://code.angularjs.org/1.7.0/docs/api/ng/service/$q#the-promise-api.

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);
	});
});

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?