Skip to main content Skip to complementary content

initialProperties property

Information noteSTABLE.

This API is reliable and breaking changes are unlikely.

initialProperties()

Specifies the properties the object should have when created. Define either as a hypercube (qHyperCubeDef) or as a list object (qListObjectDef).

Set up all custom properties and assign default values to custom properties.

The maximum number of cells (qWidth * qHeight) allowed in an initial data fetch is 10,000. Retrieve additional data in chunks using the getData method in the Backend API.

Version history

Version history
Version state Details
Introduced 1.0

Examples

Information noteYou need to define how many rows and columns you should get in the initial fetch.

Example: An example using a hypercube

initialProperties : {
	qHyperCubeDef : {
		qDimensions : [],
		qMeasures : [],
		qInitialDataFetch : [{
			qWidth : 2,
			qHeight : 50
		}]
	}
}

Example: An example that uses a list object and also defines some custom properties

initialProperties : {
	qListObjectDef : {
		qShowAlternatives : true,
		qFrequencyMode : "V",
		qInitialDataFetch : [{
			qWidth : 2,
			qHeight : 50
		}]
	},
	fixed : true,
	width : 25,
	percent : true,
	selectionMode : "CONFIRM"
}

Learn more

 

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!