_getLayout([$elementAPIs[, $elements]])

Sahi Pro Flowcharts Action :Get Layout

Details

Returns string representing page layout. User can provide the element apis as a first argument which he wants to ignore in layout. It needs to be used with _writeFile followed by _readLayoutFile and _verifyLayout.

// Example:
var $all = _getLayout(); //returns string representing page layout
_writeFile($all, "D:/getLayout.txt", true); //writes returned string to text file
var $temp = _readLayoutFile("D:/getLayout.txt");
//read the layout text file and return a 2 dimensional array of elements
_verifyLayout($temp,9); //verifying the page layout and layout from _getLayout

var $data = _getLayout(["_heading2", "_div", "_row", "_cell"]); //ignoring (_heading2,_div, _row and _cell) from page
_writeFile($data, "D:/getLayout.txt", true); //writes returned string to text file
var $temp = _readLayoutFile("D:/getLayout.txt");
//read the layout text file and return a 2 dimensional array of elements
_verifyLayout($temp,9); //verifying the page layout and layout from _getLayout

var $all = _getLayout(null, [_div("section"), _div("new-section")]); //returns string representing page layout of sections covered by _div("section") and _div("new-section")] elements.
var $all = _getLayout([_span], [_div("section"), _div("new-section")]); //returns string representing page layout of sections covered by _div("section") and _div("new-section")] elements ignoring _span apis.

_readLayoutFile($filePath)

Sahi Pro Flowcharts Action :Read Layout File

Details

Reads the layout text file and returns a 2 dimensional array of elements. The layout file is a simple way of defining layout in a text file.

Elements on a line are treated as horizontally aligned. Elements higher up in the layout file are vertically above elements defined on a lower line.

// For example, in
_cell("Python Cookbook"),_cell("7"),_cell("Rs. 350"),_textbox("q[2]")
_button("Add"),_button("Clear"),_button("Logout")

_cell("Python Cookbook") is to the left of _cell("Rs. 350") and _button("Add") is vertically below _cell("Python Cookbook") (not necessarily within _cell("Python Cookbook")'s boundaries though) and _button("Clear") is to the right of _button("Add")

This can be used to verify the layout of the following page:

//Read the layout text file and store it in the variable
var $data = _readLayoutFile("page_layout.txt");

_verifyLayout($data, $threshold)

Sahi Pro Flowcharts Action :Verify Layout

Details

Validates the page layout based on $data.

// Example:
 var $data = _readLayoutFile("page_layout.txt");
_verifyLayout($data, 10);