Skip to content
Get Free Trial

Alignment Functions

Alignment functions can be used for checking alignment of one element with respect to the other. With which one can check alignment of different elements on different screen sizes i.e. to check responsiveness. A sample test page is added at Sahi_Pro\htdocs\demo\alignmentTestPage.htm and a sample test script is added at Sahi_Pro\userdata\scripts\demo\testAlignmentAPIs.sah to give a better understanding of these APIs.

Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_areHorizontallyAligned($leftElement, $rightElement[, $position[, $gap[, $offset]]])

Arguments

NameTypeDescription
$leftElementHTML DOM elementLeft element to be checked.
$rightElementHTML DOM elementRight element to be checked.
$positionstringoptionalPosition to be checked. By default position = "middle". Value of position can be either "top" or "bottom" or "both" or "middle".
$gapar_i|ioptionalGap between right edge of left element and left edge of right element. If gap is an integer, it will take the exact value. And if gap is an array, Eg. gap = [10, 40], implies gap can range from 10 to 40. To force sahi to check for the gap between the two elements, use the gap. If nothing provided it wouldn't consider gap.
$offsetar_i|ioptionalOffset above and below within which to look for elements boundary for given position. If offset is an integer, both above and below offsets are set to this offset. rightElement may be slightly above or below leftElement. Sahi normally matches only elements whose bases match. To force it to look a little above or below while looking to the right, use the offset.

Returns

booleantrue if two elements are horizontally aligned, else false.

_areHorizontallyAligned checks whether two elements are horizontally aligned or not.

Horizontally Aligned

Horizontally Aligned

_areHorizontallyAligned(_div("item1"), _div("item2")) //by default middle position will be checked
_areHorizontallyAligned(_div("item1"), _div("item2"), "top")
_areHorizontallyAligned(_div("item1"), _div("item2"), "top", 20) //gap is exact 20.
_areHorizontallyAligned(_div("item1"), _div("item2"), "top", [0, 20]) //gap is only positive i.e. no overlapping is allowed
_areHorizontallyAligned(_div("item1"), _div("item2"), "top", [0, 20], 10) //gap is only positive i.e. no overlapping is allowed and offset for the top edge is 10
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_areVerticallyAligned($topElement, $bottomElement[, $position[, $gap[, $offset]]])

Arguments

NameTypeDescription
$topElementHTML DOM elementTop element to be checked.
$bottomElementHTML DOM elementBottom element to be checked.
$positionstringoptionalPosition to be checked. By default position = "center". Value of position can be either "left" or "right" or "both" or "center".
$gapar_i|ioptionalGap between bottom edge of top element and top edge of bottom element. If gap is an integer, it will take the exact value. And if gap is an array, Eg. gap = [0, 40], implies gap can range from 0 to 40. To force sahi to check for the gap between the two elements, use the gap. If nothing provided it wouldn't consider gap.
$offsetar_i|ioptionalOffset left and right within which to look for elements boundary for given position. If offset is an integer, both left and right offsets are set to this offset. topElement may be slightly left or right to the bottomElement.

Returns

booleantrue if two elements are vertically aligned, else false.

_areVerticallyAligned checks whether two elements are vertically aligned or not. Returns true if two elements are vertically aligned, else false.

Vertically Aligned

Vertically Aligned

Example

_areVerticallyAligned(_div("item1"), _div("item2")) //by default center position will be checked
_areVerticallyAligned(_div("item1"), _div("item2"), "left")
_areVerticallyAligned(_div("item1"), _div("item2"), "left", 20) //gap can take the values between [-20, 20]
_areVerticallyAligned(_div("item1"), _div("item2"), "left", [0, 20]) //gap is only positive i.e. no overlapping is allowed
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_isCentered($element, $containerElement, $alignment[, $offset])

Arguments

NameTypeDescription
$elementHTML DOM elementInner element to be checked.
$containerElementHTML DOM elementContainer element to be checked.
$alignmentstringCan be "vertical" or "horizontal".
$offsetar_i|ioptionalOffset left and right within which to look for elements boundary for given position. If offset is an integer, both left and right offsets are set to this offset. topElement may be slightly left or right to the bottomElement.

Returns

booleantrue if inner element is vertically or horizontally centered to the container element, else false

_isCentered checks whether inner element is vertically or horizontally centered to the container element.

centered

Example

_isCentered(_div("item1"), _div("item2"), "vertical")
_isCentered(_div("item1"), _div("item2"), "horizontal")
_isCentered(_div("item1"), _div("item2"), "horizontal", 1)
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_isVisiblyInside($element1, $element2)

Arguments

NameTypeDescription
$element1HTML DOM elementFirst element to be checked.
$element2HTML DOM elementSecond element to be checked.

Returns

booleantrue if element1 is visibly completely inside element2, else false

_isVisiblyInside checks whether element1 is completely contained inside element2.

// Example
_isVisiblyInside(_div("item1"), _div("item2")) //implies _div("item1") is inside _div("item2")
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_isVisiblyOutside($element1, $element2)

Arguments

NameTypeDescription
$element1HTML DOM elementFirst element to be checked.
$element2HTML DOM elementSecond element to be checked.

Returns

booleantrue if element1 is visibly completely outside element2, else false

_isVisiblyOutside checks whether element1 is completely outside element2 i.e one is not contained within other.

// Example
_isVisiblyOutside(_div("item1"), _div("item2")) //implies _div("item1") is outside _div("item2")
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_isVisiblyOn($element1, $element2[, $topSpace[, $rightSpace[, $bottomSpace[, $leftSpace]]]])

Arguments

NameTypeDescription
$element1HTML DOM elementFirst element to be checked.
$element2HTML DOM elementSecond element to be checked. Base Element.
$topSpacear_i|ioptionalSpace between top edges of the two elements. If topSpace is an integer, it will take the exact value. And if topSpace = [-20, 0], implies top edge of element2 lies above top edge of element1. To force sahi to check for the topSpace between the two elements, use the topSpace. If nothing provided it wouldn't consider topSpace.
$rightSpacear_i|ioptionalSpace between right edges of the two elements. If rightSpace is an integer, it will take the exact value. And if rightSpace = [0, 20], implies right edge of element2 lies to the right side of right edge of element1. To force sahi to check for the rightSpace between the two elements, use the rightSpace. If nothing provided it wouldn't consider rightSpace.
$bottomSpacear_i|ioptionalSpace between bottom edges of the two elements. If bottomSpace is an integer, it will take the exact value. And if bottomSpace = [0, 20], implies bottom edge of element2 lies below bottom edge of element1. To force sahi to check for the bottomSpace between the two elements, use the bottomSpace. If nothing provided it wouldn't consider bottomSpace.
$leftSpacear_i|ioptionalSpace between left edges of the two elements. If leftSpace is an integer, it will take the exact value. And if leftSpace = [0, 20], implies top edge of element2 lies to the right side of left edge of element1. To force sahi to check for the leftSpace between the two elements, use the leftSpace. If nothing provided it wouldn't consider leftSpace.

Returns

booleantrue if element1 is visibly placed on element2, else false

_isVisiblyOn checks whether element1 is placed on top of element2. element1 may extend beyond element2 boundaries.

visiblyOn

Example

_isVisiblyOn(_div("item1"), _div("item2"), [0,25]); //implies _div("item1") is placed on _div("item2") where top edge of div("item1") can be upto
// 25 units below div("item2") top edge
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_fitsWidth($element1, $element2[, $leftSpace[, $rightSpace]])

Arguments

NameTypeDescription
$element1HTML DOM elementFirst element to be checked.
$element2HTML DOM elementSecond element to be checked. Base Element.
$leftSpacear_i|ioptionalSpace between left edges of the two elements. If leftSpace is an integer, it will take the exact value. And if leftSpace = [0, 20], implies top edge of element2 lies to the right side of left edge of element1. If nothing provided leftSpace will be considered as 0.
$rightSpacear_i|ioptionalSpace between right edges of the two elements. If rightSpace is an integer, it will take the exact value. And if rightSpace = [0, 20], implies right edge of element2 lies to the right side of right edge of element1. If nothing provided rightSpace will be considered as 0.

Returns

booleantrue if element1 fits within width of element2, else false

_fitsWidth checks whether element1 fits within the width of element2.

fitsWidth

Example

_fitsWidth(_div("item1"), _div("item2"), [0,25], [-25,0]); //implies _div("item1") is on _div("item2") where left edge of div("item1") can be
//upto 25 units right to div("item2") left edge and right edge of div("item1") can be upto 25 units left to div("item2") right edge
Since
Sahi Pro 6.3.0
Desktop Engine 8.0.0

Modes BrowserWindowsJava

_fitsHeight($element1, $element2[, $topSpace[, $bottomSpace]])

Arguments

NameTypeDescription
$element1HTML DOM elementFirst element to be checked.
$element2HTML DOM elementSecond element to be checked. Base Element.
$topSpacear_i|ioptionalSpace between top edges of the two elements. If topSpace is an integer, it will take the exact value. And if topSpace = [-20, 0], implies top edge of element2 lies above top edge of element1. If nothing provided topSpace will be considered as 0.
$bottomSpacear_i|ioptionalSpace between bottom edges of the two elements. If bottomSpace is an integer, it will take the exact value. And if bottomSpace = [0, 20], implies bottom edge of element2 lies below bottom edge of element1. If nothing provided bottomSpace will be considered as 0.

Returns

booleantrue if element1 fits within height of element2, else false

_fitsHeight checks whether element1 fits within the height of element2.

fitsHeight

Example

_fitsHeight(_div("item1"), _div("item2"), [0,25], [-25,0]); //implies _div("item1") is on _div("item2") where top edge of div("item1") can be
//upto 25 units below div("item2") top edge and bottom edge of div("item1") can be upto 25 units above div("item2") bottom edge