# cp.ui.axutils.compare

Contains functions for comparing axuielements.

# API Overview

Functions - API calls offered directly by the extension

bottomToTop
leftToRight
rightToLeft
topToBottom

# API Documentation

# Functions

# bottomToTop


Signature	`cp.ui.axutils.compare.bottomToTop(a, b) -> boolean`
Type	Function
Description	Returns `true` if element `a` is below element `b`. May be used with `table.sort`.
Parameters	a - The first element b - The second element
Returns	`true` if `a` is below `b`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 467

# leftToRight


Signature	`cp.ui.axutils.compare.leftToRight(a, b) -> boolean`
Type	Function
Description	Returns `true` if element `a` is left of element `b`. May be used with `table.sort`.
Parameters	a - The first element b - The second element
Returns	`true` if `a` is left of `b`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 419

# rightToLeft


Signature	`cp.ui.axutils.compare.rightToLeft(a, b) -> boolean`
Type	Function
Description	Returns `true` if element `a` is right of element `b`. May be used with `table.sort`.
Parameters	a - The first element b - The second element
Returns	`true` if `a` is right of `b`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 435

# topToBottom


Signature	`cp.ui.axutils.compare.topToBottom(a, b) -> boolean`
Type	Function
Description	Returns `true` if element `a` is above element `b`. May be used with `table.sort`.
Parameters	a - The first element b - The second element
Returns	`true` if `a` is above `b`.
Notes	None
Examples	None
Source	src/extensions/cp/ui/axutils.lua line 451