initialProperties property

Note: STABLE.
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

Introduced 1.0

Examples

Note: You 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"
}

See also:

 

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?