Workbook.RubProps

Syntax

RubProps: Object;

Description

The RubProps property sets properties of time series database.

Example

To execute the example, the page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component), and also add the following code in the handler, that processes document opening event:

	var getRubPropsButt = new PP.Ui.Button({
		ParentNode: document.body, //DOM parent node
		Content: "Source Properties", //text      
		Click: PP.Delegate(onClickGetRubProps)     
	});
	function onClickGetRubProps(){
		var rubKey = wbk.getWbkMetadata().rubrs.def.k; 
		var rubProps = wbk.getRubProps(rubKey);
		alert('autoUpdateStat: ' + rubProps['@autoUpdateStat'] +
		'\n' + 'compoundFactorKey: ' + rubProps['@compoundFactorKey'] + 
		'\n' + 'factsOnQuery: ' + rubProps['@factsOnQuery'] + 
		'\n' + 'hasEmptyAttribute: ' + rubProps['@hasEmptyAttribute'] + 
		'\n' + 'hasMnemonics: ' + rubProps['@hasMnemonics'] + 
		'\n' + 'keepHistory: ' + rubProps['@keepHistory'] + 
		'\n' + 'lightWeight: ' + rubProps['@lightWeight'] + 
		'\n' + 'revisionsOnQuery: ' + rubProps['@revisionsOnQuery'] + 
		'\n' + 'runtimeLightWeight: ' + rubProps['@runtimeLightWeight'] + 
		'\n' + 'unitIsRequired: ' + rubProps['@unitIsRequired'] + 
		'\n' + 'useDistinctSequence: ' + rubProps['@useDistinctSequence'] + 
		'\n' + 'valuesOnQuery: ' + rubProps['@valuesOnQuery']);
	}

After executing the example a button named Source Properties is placed in the HTML page. Clicking this button sets time series database properties and shows the following message:

See also:

Workbook