.offset()
FuncUnit.prototype.offset
offset([offset] [,timeout] [,success] [,message])
Gets an element's offset or waits until the offset is a specified value.
// gets the offset
F("#foo").offset();
// waits until the offset is 100, 200
F("#foo").offset({top:100, left: 200})
Parameters
-
offset
{Object | function()}
OptionalIf provided uses this as a check before continuing to the next action. Or you can provide a function that returns true to continue to the next action.
-
timeout
{Number}
Optionaloverrides FuncUnit.timeout. If provided, the wait will fail if not completed before this timeout.
-
success
{function()}
Optionala callback that will run after this action completes.
-
message
{String}
Optionalif provided, an assertion will be passed when this wait condition completes successfully
Returns
{String | funcUnit}
if the offset parameter is provided, returns the funcUnit selector for chaining, otherwise returns the css of the selector.