Interface

Element

Get an Element using ID

Get an Element's Property using its ID

 

{ }
[{"data":{"type":"library","step":"Get element's property","args":{"id":"ele_id"},"data_to_var":"text","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.get","interface":"interface","interface.element.get":"get"},"paths":[]}]

Example Response

{"ele":""}

Get an Element using selector

Get an Element's Property using a CSS Selector

 

{ }
[{"data":{"type":"library","step":"Get element's property","args":{"selector":"div.ele"},"data_to_var":"ele_class","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.get","interface":"interface","interface.element.get":"get"},"paths":[]}]

Example Response

{"ele":""}

Create a new Element

Create a New Element

 

{ }
[{"data":{"type":"library","step":"Create element","args":{"properties":{"class":"ele"},"type":"div"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.new","interface":"interface","interface.element.new":"new"},"paths":[]}]

Example Response

{"ele":""}

Get an Element's Property

Returns the selected options of a select element

 

{ }
[{"data":{"type":"library","step":"Get element's property","args":{"element":"ele_id","property":"prop"},"data_to_var":"prop","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getProperty","interface":"interface","interface.element.getProperty":"getProperty"},"paths":[]}]

Example Response

{"prop":"custom"}

Set a Property of an Element

Set an Element's property. Returns the element. You can either provide the element as a native object, by ID or by CSS selector.

 

{ }
[{"data":{"type":"library","step":"Set an element's property","args":{"element":"ele_id","property":"prop","value":"new_prop"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.set","interface":"interface","interface.element.set":"set"},"paths":[]}]

Example Response

{"ele":""}

Set Multiple Properties of an Element

Set Mulitple Properties of an Element. Returns the element. You can either provide the element as a native object, by ID or by CSS selector.

 

{ }
[{"data":{"type":"library","step":"Set multiple properties","args":{"element":"ele_id","properties":{"prop1":"p1","prop2":"p2"}},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.set","interface":"interface","interface.element.set":"set"},"paths":[]}]

Example Response

{"ele":""}

Remove a Property from an Element

Remove a property from an Element. Returns the element. You can either provide the element as a native object, by ID or by CSS selector.

 

{ }
[{"data":{"type":"library","step":"Remove element property","args":{"element":"ele_id","property":"class"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.erase","interface":"interface","interface.element.erase":"erase"},"paths":[]}]

Example Response

{"ele":""}

Check if a Element Matches Another using HTML tag

Tests an element to see if it matches the argument passed in.

 

{ }
[{"data":{"type":"library","step":"Remove property","args":{"element":"headline","tag":"h1"},"data_to_var":"matches","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.match","interface":"interface","interface.element.match":"match"},"paths":[]}]

Example Response

{"matches":true}

Check if a Element Matches Another using CSS selector

Tests this Element to see if it matches the argument passed in.

 

{ }
[{"data":{"type":"library","step":"Remove property","args":{"element":"ele_id","selector":"div.ele"},"data_to_var":"matches","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.match","interface":"interface","interface.element.match":"match"},"paths":[]}]

Example Response

{"matches":true}

Check if a Element Matches Another using element

Tests this Element to see if it matches the argument passed in.

 

{ }
[{"data":{"type":"library","step":"Get element","args":{"id":"ele_id"},"data_to_var":"text","maxpaths":1,"uuid":"071651f79538c5be3173b651cc9bcb7e","x":0,"y":0,"width":120,"height":32,"call":"interface.element.get","interface":"interface","interface.element.get":"get"},"paths":["9148d39266042bc89aff74e46b1a483b"]},{"data":{"type":"library","step":"Remove property","args":{"element":{"~":"ele"},"el":"ele_id"},"data_to_var":"matches","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":80,"width":120,"height":32,"call":"interface.element.match","interface":"interface","interface.element.match":"match"},"paths":[]}]

Example Response

{"matches":true}

Check if a Element contains the Element provided

Tests this Element to see if it matches the argument passed in.

 

{ }
[{"data":{"type":"library","step":"Check contains child","args":{"element":"div.par","el":"div.ch1"},"data_to_var":"contains","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.contains","interface":"interface","interface.element.contains":"contains"},"paths":[]}]

Example Response

{"contains":true}

Inject an Element

Injects, or inserts, the Element at a particular place relative to the Element's children (specified by the second the argument).

 

{ }
[{"data":{"type":"library","step":"Create element","args":{"properties":{"class":"new_ele","text":"hello"},"type":"div"},"data_to_var":"ele","maxpaths":1,"uuid":"071651f79538c5be3173b651cc9bcb7e","x":0,"y":0,"width":120,"height":32,"call":"interface.element.new","interface":"interface","interface.element.new":"new"},"paths":["9148d39266042bc89aff74e46b1a483b"]},{"data":{"type":"library","step":"Inject element","args":{"element":{"~":"ele"},"el":"div.ch4","where":"before"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":80,"width":120,"height":32,"call":"interface.element.inject","interface":"interface","interface.element.inject":"inject"},"paths":[]}]

Example Response

{"ele":""}

Grab an Element

Appends the Element at a particular place relative to the Element's children (specified by the where parameter).

 

{ }
[{"data":{"type":"library","step":"Grab element","args":{"element":"ele_id","el":"div.ch4","where":"before"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.grab","interface":"interface","interface.element.grab":"grab"},"paths":[]}]

Example Response

{"ele":""}

Adopt an Element

Works like Element:grab, but allows multiple elements to be adopted and only appended at the bottom.

Inserts the passed element(s) inside the Element (which will then become the parent element).

 

{ }
[{"data":{"type":"library","step":"Adopt element","args":{"element":"ele_id","el":"div.par"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.adopt","interface":"interface","interface.element.adopt":"adopt"},"paths":[]}]

Example Response

{"ele":""}

Adopt Multiple Elements

Works like Element:grab, but allows multiple elements to be adopted and only appended at the bottom.

Inserts the passed element(s) inside the Element (which will then become the parent element).

 

{ }
[{"data":{"type":"library","step":"Adopt elements","args":{"element":"div.par","elements":["ele_id","h1"]},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.adopt","interface":"interface","interface.element.adopt":"adopt"},"paths":[]}]

Example Response

{"ele":""}

Wrap an Element

Works like Element:grab, but replaces the element in its place, and then appends the replaced element in the location specified inside the this element.

 

{ }
[{"data":{"type":"library","step":"Wrap element","args":{"element":"ele_id","el":"div.ch4","where":"after"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.wraps","interface":"interface","interface.element.wraps":"wraps"},"paths":[]}]

Example Response

{}

Append HTML to an Element

Works like Element:grab, but instead of accepting an id or an element, it only accepts an HTML string. The HTML string will be parsed to create new DOM elements, and then injected relative to the element from where the method was called.

 

{ }
[{"data":{"type":"library","step":"Append HTML to element","args":{"element":"ele_id","html":"
new html<\/div>","where":"after"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.appendHTML","interface":"interface","interface.element.appendHTML":"appendHTML"},"paths":[]}]

Example Response

{}

Append text to an Element

Works like Element:grab, but instead of accepting an id or an element, it only accepts text. A text node will be created inside this Element, in either the top or bottom position.

 

{ }
[{"data":{"type":"library","step":"Append text to element","args":{"element":"ele_id","text":"new text","where":"after"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.appendText","interface":"interface","interface.element.appendText":"appendText"},"paths":[]}]

Example Response

{}

Remove an Element

Removes the Element and its children from the DOM and prepares them for garbage collection

 

{ }
[{"data":{"type":"library","step":"Remove element","args":{"element":"ele_id"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.destroy","interface":"interface","interface.element.destroy":"destroy"},"paths":[]}]

Example Response

{}

Clone an Element

Clones the Element and returns the cloned one.

Optional args: contents - (boolean, optional: defaults to true) When set to false the Element's contents are not cloned.
keepid - (boolean, optional: defaults to false) When true the cloned Element keeps the id attribute, if present. Same goes for any of the cloned childNodes.

 

{ }
[{"data":{"type":"library","step":"Clone element","args":{"element":"ele_id"},"data_to_var":"cloned_ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.clone","interface":"interface","interface.element.clone":"clone"},"paths":[]}]

Example Response

{"cloned_ele":""}

Replace an Element

Replaces the passed Element with Element

 

{ }
[{"data":{"type":"library","step":"Create element","args":{"properties":{"class":"ele"},"type":"div"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.new","interface":"interface","interface.element.new":"new"},"paths":["2972ab09b5a4051dd5d340e725fb6ccc"]},{"data":{"type":"library","step":"Replace element","args":{"element":{"~":"ele"},"el":"ele_id"},"data_to_var":"","maxpaths":1,"uuid":"2972ab09b5a4051dd5d340e725fb6ccc","x":0,"y":80,"width":120,"height":32,"call":"interface.element.replaces","interface":"interface","interface.element.replaces":"replaces"},"paths":[]}]

Example Response

{"ele":""}

Check if an Element has a Class

Tests the Element to see if it has the passed in className

 

{ }
[{"data":{"type":"library","step":"Does element have class","args":{"element":"ele_id","class":"ele"},"data_to_var":"hasclass","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.hasClass","interface":"interface","interface.element.hasClass":"hasClass"},"paths":[]}]

Example Response

{"hasclass":true}

Add a Class to an Element

Adds the passed in class to the Element, if the Element doesnt already have it.

 

{ }
[{"data":{"type":"library","step":"Add class to element","args":{"element":"ele_id","class":"new_class"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.addClass","interface":"interface","interface.element.addClass":"addClass"},"paths":[]}]

Example Response

{"ele":""}

Remove a Class from an Element

Works like Element:addClass, but removes the class from the Element

 

{ }
[{"data":{"type":"library","step":"Remove class from element","args":{"element":"ele_id","class":"ele"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.removeClass","interface":"interface","interface.element.removeClass":"removeClass"},"paths":[]}]

Example Response

{"ele":""}

Toggle an Element's Class

Adds or removes the passed in class name to the Element, depending on whether or not it's already present.

 

{ }
[{"data":{"type":"library","step":"Toggle element's class","args":{"element":"ele_id","property":"ele"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.toggleClass","interface":"interface","interface.element.toggleClass":"toggleClass"},"paths":[]}]

Example Response

{"ele":""}

Get the Element's Previous Sibling Element

Returns the previousSibling of the Element (excluding text nodes).
Optional args: match - (string, optional): A tag name to match the the found element(s) with. A full CSS selector can be passed.

 

{ }
[{"data":{"type":"library","step":"Get previous sibling","args":{"element":"ele_id"},"data_to_var":"prev","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getPrevious","interface":"interface","interface.element.getPrevious":"getPrevious"},"paths":[]}]

Example Response

{"prev":""}

Get all of the Element's Matched Previous Sibling Elements

Like Element:getPrevious, but returns a collection of all the matched previousSiblings

 

{ }
[{"data":{"type":"library","step":"Get all previous siblings","args":{"element":"ele_id"},"data_to_var":"eles","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getAllPrevious","interface":"interface","interface.element.getAllPrevious":"getAllPrevious"},"paths":[]}]

Example Response

{"eles":[""]}

Get the Element's Next Sibling Element

As Element:getPrevious, but tries to find the nextSibling (excluding text nodes).

 

{ }
[{"data":{"type":"library","step":"Get next sibling","args":{"element":"ele_id"},"data_to_var":"next","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getNext","interface":"interface","interface.element.getNext":"getNext"},"paths":[]}]

Example Response

{"next":""}

Get all of the Element's Matched Next Sibling Elements

Like Element.getNext, but returns a collection of all the matched nextSiblings

 

{ }
[{"data":{"type":"library","step":"Get all next siblings","args":{"element":"ele_id"},"data_to_var":"eles","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.set","interface":"interface","interface.element.set":"set"},"paths":[]}]

Example Response

{"eles":[""]}

Get the First Matching Element

Gets the first element that matches the passed in expression

 

{ }
[{"data":{"type":"library","step":"Get first match","args":{"element":"div.par","match":"div.ch"},"data_to_var":"match","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getFirst","interface":"interface","interface.element.getFirst":"getFirst"},"paths":[]}]

Example Response

{"match":""}

Get the Last Matching Element

Gets the last element that matches the passed in expression

 

{ }
[{"data":{"type":"library","step":"Get last match","args":{"element":"div.par","match":"div.ch"},"data_to_var":"match","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getLast","interface":"interface","interface.element.getLast":"getLast"},"paths":[]}]

Example Response

{"match":""}

Get an Element's Parent Element

Works as Element:getPrevious, but tries to find the parentNode

 

{ }
[{"data":{"type":"library","step":"Get parent DIV","args":{"element":"ele_id","match":"div"},"data_to_var":"par","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getParent","interface":"interface","interface.element.getParent":"getParent"},"paths":[]}]

Example Response

{"par":""}

Get all Matching Parent Elements

Like Element:getParent, but returns a collection of all the matched parentNodes up the tree.

 

{ }
[{"data":{"type":"library","step":"Get parent DIVs","args":{"element":"ele_id","match":"div"},"data_to_var":"par","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getParents","interface":"interface","interface.element.getParents":"getParents"},"paths":[]}]

Example Response

{"par":["",""]}

Get an Element Sibling Elements

Like Element:getAllPrevious but returns all Element's previous and next siblings (excluding text nodes). Returns as Elements

 

{ }
[{"data":{"type":"library","step":"Get siblings","args":{"element":"div.ch1","match":"div"},"data_to_var":"sibs","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getSiblings","interface":"interface","interface.element.getSiblings":"getSiblings"},"paths":[]}]

Example Response

{"sibs":["","","",""]}

Get an Element's Children Elements

Returns all the Element's children (excluding text nodes). Returns as Elements.

 

{ }
[{"data":{"type":"library","step":"Get parent DIVs","args":{"element":"div.par","match":"div"},"data_to_var":"children","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getChildren","interface":"interface","interface.element.getChildren":"getChildren"},"paths":[]}]

Example Response

{"children":["","","",""]}

Empty an Element

Empties an Element of all its children

 

{ }
[{"data":{"type":"library","step":"Empty element","args":{"element":"div.par"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.empty","interface":"interface","interface.element.empty":"empty"},"paths":[]}]

Example Response

{"ele":""}

Create Query String from Element Children

Reads the child inputs of the Element and generates a query string based on their values.

 

{ }
[{"data":{"type":"library","step":"Create query string","args":{"element":"my_form"},"data_to_var":"qs","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.toQueryString","interface":"interface","interface.element.toQueryString":"toQueryString"},"paths":[]}]

Example Response

{"qs":"input1=hello&input2=world"}

Get Selected Options of an Element

Returns the selected options of a select element

 

{ }
[{"data":{"type":"library","step":"Get selected option","args":{"element":"sel_country"},"data_to_var":"sel","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getSelected","interface":"interface","interface.element.getSelected":"getSelected"},"paths":[]}]

Example Response

{"sel":"IT"}

Get Properties of an Element

Gets multiple element attributes

 

{ }
[{"data":{"type":"library","step":"Get an element's property","args":{"element":"ele_id","properties":["class","prop"]},"data_to_var":"props","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getProperties","interface":"interface","interface.element.getProperties":"getProperties"},"paths":[]}]

Example Response

{"props":{"class":"ele","prop":"custom"}}

Set an Element's Property

Sets an attribute or special property for this Element

 

{ }
[{"data":{"type":"library","step":"Set an element's property","args":{"element":"ele_id","property":"prop","value":"new_prop"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.setProperty","interface":"interface","interface.element.setProperty":"setProperty"},"paths":[]}]

Example Response

{"ele":""}

Set Multiple Properties for an Element

Sets numerous attributes for the Element

 

{ }
[{"data":{"type":"library","step":"Set multiple properties","args":{"element":"ele_id","properties":{"prop1":"p1","prop2":"p2"}},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.setProperties","interface":"interface","interface.element.setProperties":"setProperties"},"paths":[]}]

Example Response

{"ele":""}

Remove an Element's Property

Removes an attribute from the Element

 

{ }
[{"data":{"type":"library","step":"Set an element's property","args":{"element":"ele_id","property":"prop"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.removeProperty","interface":"interface","interface.element.removeProperty":"removeProperty"},"paths":[]}]

Example Response

{"ele":""}

Remove Multiple Properties for an Element

Removes numerous attributes from the Element

 

{ }
[{"data":{"type":"library","step":"Remove properties","args":{"element":"ele_id","properties":["prop","class"]},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.removeProperties","interface":"interface","interface.element.removeProperties":"removeProperties"},"paths":[]}]

Example Response

{"ele":""}

Store Data in an Element

Stores an item in the Elements Storage, linked to this Element

 

{ }
[{"data":{"type":"library","step":"Store data","args":{"element":"ele_id","key":"hello","value":"world"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.store","interface":"interface","interface.element.store":"store"},"paths":[]}]

Example Response

{"ele":""}

Retrieve Data from an Element

Retrieves a value from the Elements storage. If default is provided and no data exists, the default value is returned.

 

{ }
[{"data":{"type":"library","step":"Retrieve data","args":{"element":"ele_id","key":"hello"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.retrieve","interface":"interface","interface.element.retrieve":"retrieve"},"paths":[]}]

Example Response

{"data":"world"}

Remove Data from an Element

Eliminates a key from the Elements storage

 

{ }
[{"data":{"type":"library","step":"Remove data","args":{"element":"ele_id","key":"hello"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.eliminate","interface":"interface","interface.element.eliminate":"eliminate"},"paths":[]}]

Example Response

{"ele":""}

Sets the CSS style for an Element

Sets the CSS style for an Element

 

{ }
[{"data":{"type":"library","step":"Set an element's style","args":{"element":"ele_id","style":"border","value":"1px solid red"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.setStyle","interface":"interface","interface.element.setStyle":"setStyle"},"paths":[]}]

Example Response

{"ele":""}

Get a style from an Element

Returns the style of the Element given the property passed in

 

{ }
[{"data":{"type":"library","step":"Get an element's style","args":{"element":"ele_id","style":"border-color"},"data_to_var":"border_color","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getStyle","interface":"interface","interface.element.getStyle":"getStyle"},"paths":[]}]

Example Response

{"border_color":"red"}

Set Multiple Styles for an Element

Applies a collection of styles to the Element. Returns the element.

 

{ }
[{"data":{"type":"library","step":"Set an element's styles","args":{"element":"ele_id","styles":{"border":"1px solid red","background":"yellow"}},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.setStyles","interface":"interface","interface.element.setStyles":"setStyles"},"paths":[]}]

Example Response

{"ele":""}

Get Multiple Styles from an Element

Returns an object of styles of the Element for each argument passed in

 

{ }
[{"data":{"type":"library","step":"Get an element's styles","args":{"element":"ele_id","styles":["background","border-color"]},"data_to_var":"styles","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getStyles","interface":"interface","interface.element.getStyles":"getStyles"},"paths":[]}]

Example Response

{"styles":{"background":"#cccccc","border-color":"green"}}

Add an Event to an Element

Attaches an event listener to a DOM element. Returns the element

 

{ }
[{"data":{"type":"library","step":"Add click event","args":{"element":"ele_id","type":"click","function":"hello"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.addEvent","interface":"interface","interface.element.addEvent":"addEvent"},"paths":[]}]

Example Response

{"ele":""}

Remove an Event from an Element

Works as Element.addEvent, but instead removes the specified event listener.

 

{ }
[{"data":{"type":"library","step":"Remove click event","args":{"element":"ele_id","type":"click","function":"hello"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.removeEvent","interface":"interface","interface.element.removeEvent":"removeEvent"},"paths":[]}]

Example Response

{"ele":""}

Add Multiple Events to an Element

The same as Element:addEvent, but accepts an object to add multiple events at once. Returns element

 

{ }
[{"data":{"type":"library","step":"Add element events","args":{"element":"ele_id","events":{"click":"hello","mouseover":"over"}},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.addEvents","interface":"interface","interface.element.addEvents":"addEvents"},"paths":[]}]

Example Response

{"ele":""}

Remove all Events from an Element

Removes all events from an Element.

 

{ }
[{"data":{"type":"library","step":"Remove all events","args":{"element":"ele_id"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.removeEvents","interface":"interface","interface.element.removeEvents":"removeEvents"},"paths":[]}]

Example Response

{"ele":""}

Remove all Events of a Type from an Element

Removes all events of a certain type from an Element.

 

{ }
[{"data":{"type":"library","step":"Remove click events","args":{"element":"ele_id","events":"click"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.removeEvents","interface":"interface","interface.element.removeEvents":"removeEvents"},"paths":[]}]

Example Response

{"ele":""}

Fire an Event for an Element

Executes all events of the specified type present in the Element. Returns the element.

Arguments:
type - (string) The event name (e.g. 'click')
args - (mixed, optional) Array or single object, arguments to pass to the function. If more than one argument, must be an array.
delay - (number, optional) Delay (in ms) to wait to execute the event.

 

{ }
[{"data":{"type":"library","step":"Fire an element's event","args":{"element":"ele_id","type":"click"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.fireEvent","interface":"interface","interface.element.fireEvent":"fireEvent"},"paths":[]}]

Example Response

{"ele":""}

Clone all Events from one Element to Another

Clones all events from an Element to this Element.

 

{ }
[{"data":{"type":"library","step":"Clone events","args":{"element":"ele_id","from":"div.par"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.cloneEvents","interface":"interface","interface.element.cloneEvents":"cloneEvents"},"paths":[]}]

Example Response

{"ele":""}

Clone Certain Element's Events to Another Element

Clones all events, of a specified type, from an Element to this Element.

 

{ }
[{"data":{"type":"library","step":"Clone events from one element to another","args":{"element":"ele_id","from":"div.par","type":"click"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.cloneEvents","interface":"interface","interface.element.cloneEvents":"cloneEvents"},"paths":[]}]

Example Response

{"ele":""}

Scroll to an Element

Scrolls the element to the specified coordinated (if the element has an overflow). The following method is also available on the Window object.

 

{ }
[{"data":{"type":"library","step":"Scroll element","args":{"element":"ele_id","x":10,"y":15},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.scrollTo","interface":"interface","interface.element.scrollTo":"scrollTo"},"paths":[]}]

Example Response

{"ele":""}

Get an Element's Size

Returns the height and width of the Element, taking into account borders and padding. The following method is also available on the Window object.

 

{ }
[{"data":{"type":"library","step":"Get size","args":{"element":"ele_id"},"data_to_var":"ele_size","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getSize","interface":"interface","interface.element.getSize":"getSize"},"paths":[]}]

Example Response

{"ele_size":{"x":10,"y":20}}

Get an Element's Scrollable Size

Returns an Object representing the size of the target Element, including scrollable area. The following method is also available on the Window object.

 

{ }
[{"data":{"type":"library","step":"Get scroll size","args":{"element":"ele_id"},"data_to_var":"ele_size","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getScrollSize","interface":"interface","interface.element.getScrollSize":"getScrollSize"},"paths":[]}]

Example Response

{"ele_size":{"x":10,"y":20}}

Get an Element's Scrolled Position

Returns an Object representing how far the target Element is scrolled in either direction. The following method is also available on the Window object.

 

{ }
[{"data":{"type":"library","step":"Get scrolled","args":{"element":"ele_id"},"data_to_var":"ele_scroll","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getScroll","interface":"interface","interface.element.getScroll":"getScroll"},"paths":[]}]

Example Response

{"ele_scroll":{"x":0,"y":20}}

Get an Element's Position

Returns the real offsets of the element

 

{ }
[{"data":{"type":"library","step":"Get position","args":{"element":"ele_id"},"data_to_var":"ele_pos","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getPosition","interface":"interface","interface.element.getPosition":"getPosition"},"paths":[]}]

Example Response

{"ele_pos":{"x":10,"y":20}}

Set an Element's Position

Sets the position of the element's left and top values to the x/y positions you specify.

 

{ }
[{"data":{"type":"library","step":"Set position","args":{"element":"ele_id","positions":{"x":20,"y":40}},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.setPosition","interface":"interface","interface.element.setPosition":"setPosition"},"paths":[]}]

Example Response

{"ele":""}

Get an Element's Coordinates

Returns an object with width, height, left, right, top, and bottom coordinate values of the Element.

 

{ }
[{"data":{"type":"library","step":"Get an element's coordinates","args":{"element":"ele_id"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getCoordinates","interface":"interface","interface.element.getCoordinates":"getCoordinates"},"paths":[]}]

Example Response

{"ele":{"top":50,"left":100,"width":200,"height":300,"right":300,"bottom":350}}

Get an Element's Offset Parent

Returns the parent of the element that is positioned, if there is one.

 

{ }
[{"data":{"type":"library","step":"Get offset parent","args":{"element":"ele_id"},"data_to_var":"par","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.getOffsetParent","interface":"interface","interface.element.getOffsetParent":"getOffsetParent"},"paths":[]}]

Example Response

{"par":""}

Tween an Element's Style

Element shortcut method which immediately transitions any single CSS property of an Element to a value.

 

{ }
[{"data":{"type":"library","step":"Tween border","args":{"element":"ele_id","property":"border-color","to":"red"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.tween","interface":"interface","interface.element.tween":"tween"},"paths":[]}]

Example Response

{"ele":""}

Tween an Element's Style from One Value to Another

Element shortcut method which immediately transitions any single CSS property of an Element from one value to another.

 

{ }
[{"data":{"type":"library","step":"Tween border","args":{"element":"ele_id","property":"border-color","from":"yellow","to":"red"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.tween","interface":"interface","interface.element.tween":"tween"},"paths":[]}]

Example Response

{"ele":""}

Fade an Element

Element shortcut method for tween with opacity. Useful for fading an Element in and out or to a certain opacity level.

how - (mixed, optional: defaults to 'toggle') The opacity level as a number or string representation. Possible values include:
'in' - Fade the element to 100% opacity.
'out' - Fade the element to 0% opacity.
'show' - Immediately set the element's opacity to 100%.
'hide' - Immediately set the element's opacity to 0%.
'toggle' - If visible, fade the element out, otherwise, fade it in.
(number) - A float value between 0 and 1. Will fade the element to this opacity.

 

{ }
[{"data":{"type":"library","step":"Fade element","args":{"element":"ele_id"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.fade","interface":"interface","interface.element.fade":"fade"},"paths":[]}]

Example Response

{"ele":""}

Highlight an Element

Element shortcut method which immediately transitions any single CSS property of an Element to a value.

 

{ }
[{"data":{"type":"library","step":"Highlight border","args":{"element":"ele_id","end":"yellow"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.highlight","interface":"interface","interface.element.highlight":"highlight"},"paths":[]}]

Example Response

{"ele":""}

Highlight an Element from One Value to Another

Element shortcut method which immediately transitions any single CSS property of an Element from one value to another.

 

{ }
[{"data":{"type":"library","step":"Highlight border","args":{"element":"ele_id","start":"orange","end":"yellow"},"data_to_var":"ele","maxpaths":1,"uuid":"9148d39266042bc89aff74e46b1a483b","x":0,"y":0,"width":120,"height":32,"call":"interface.element.highlight","interface":"interface","interface.element.highlight":"highlight"},"paths":[]}]

Example Response

{"ele":""}