PP.TS.isModSerie

Syntax

isModSerie (serie);

Parameters

serie. Sets series index.

Description

The isModSerie method determines whether specified series is calculated using the Mod formula.

Comments

This method returns True if formula type of the series passed to the method as a parameter, is Mod, otherwise the method returns False.

Example

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

var getIsModSerieButt = new PP.Ui.Button({
	ParentNode: document.body, //DOM parent node
	Content: "Get Series Type", //Text      
	Click: PP.Delegate(onClickType)     
}); 
function onClickType()
	{
		var series = wbk.getSeries();
		var messageString = "";
		for (var i = 0; i<series.length; i++)
			{
				//Determine whether the specified series is calculated by the Mod formula
				PP.TS.isModSerie(series[i]) ? addModSerieString(i) : addNonModSerieString(i);				
			}
		function addModSerieString(rowIndex)
			{
				messageString = messageString + "The series number " + i + " - has the Mod formula type" + '\n';
			}
		function addNonModSerieString(rowIndex)
			{
				messageString = messageString + "The series number " + i + " -  has the formula type that differs from the Mod type" + '\n';
			}
		alert(messageString);
	}

After executing the example the Get Series Type button is placed in the HTML page. Clicking this button shows a message if the series available in the table are calculated using the Mod formula.

See also:

PP.TS