new GoBrain.Node(node)
An HTMLElement wrapper, adding convenience functionality used to manipulate the element.
An HTMLElement wrapper, adding convenience functionality used to manipulate the element.
| Name | Type | Description |
|---|---|---|
node |
HTMLElement |
The element to work against. |
Members
-
SettingsString
-
Properties:
Name Type Default Description DataPrefixString data-internal-gobrain- This namespace is prepended to all attributes set with the .data() function.
Methods
-
addClass(clazz){GoBrain.Node}
GoBrain.Core/src/node.js, line 38Adds a css class if it doesn't already exist.
-
Adds a css class if it doesn't already exist.
Name Type Description clazzString The class to add.
Returns:
Type Description GoBrain.Node -
addEventListener(event, handler, options){GoBrain.Node}
GoBrain.Core/src/node.js, line 54Adds an event listener.
-
Adds an event listener.
Name Type Description eventString Event to listen to.
handlerfunction Handler to invoke when event occurs.
optionsBoolean | Object Options to use to add the event handler. If boolean, whether or not to add handler as passive, if supported.
Returns:
Type Description GoBrain.Node -
appendChild(child){GoBrain.Node}
GoBrain.Core/src/node.js, line 84Appends a child node/element.
-
Appends a child node/element.
Name Type Description childGoBrain.Node | HTMLElement The child to append.
Returns:
Type Description GoBrain.Node -
attribute(attribute, value){GoBrain.Node|String}
GoBrain.Core/src/node.js, line 100Gets or sets or removes node attribute.
-
Gets or sets or removes node attribute.
Name Type Description attributeString The name of the attribute.
valueString optional The value of the attribute.
Returns:
Type Description GoBrain.Node | String -
children(){Array.<GoBrain.Node>}
GoBrain.Core/src/node.js, line 127Gets children of node.
-
Gets children of node.
Returns:
Type Description Array.<GoBrain.Node> -
content(content){GoBrain.Node|*}
GoBrain.Core/src/node.js, line 144Gets or sets node content.
-
Gets or sets node content.
Name Type Description content* optional The content to set.
Returns:
Type Description GoBrain.Node | * -
context(){HTMLElement}
GoBrain.Core/src/node.js, line 182Gets the element that the node instance was created with.
-
Gets the element that the node instance was created with.
Returns:
Type Description HTMLElement -
css(styles){GoBrain.Node}
GoBrain.Core/src/node.js, line 193Sets node style properties.
-
Sets node style properties.
Name Type Description stylesObject.<String, *> The style properties to set.
Returns:
Type Description GoBrain.Node -
data(property, value){GoBrain.Node|String}
GoBrain.Core/src/node.js, line 244Gets or sets data attribute.
-
Gets or sets data attribute.
Name Type Description propertyString The name of the data attribute.
valueString optional The value of the data attribute.
Returns:
Type Description GoBrain.Node | String -
getNodeByClass(clazz){GoBrain.Node|null}
GoBrain.Core/src/node.js, line 266Gets first node beneath node that has a matching css class.
-
Gets first node beneath node that has a matching css class.
Name Type Description clazzString The class to look for.
Returns:
Type Description GoBrain.Node | null -
getNodeById(id){GoBrain.Node|null}
GoBrain.Core/src/node.js, line 280Gets first node beneath node that has a matching id.
-
Gets first node beneath node that has a matching id.
Name Type Description idString The id to look for.
Returns:
Type Description GoBrain.Node | null -
getNodesByAttributeAndValue(attribute, value){Array.<GoBrain.Node>}
GoBrain.Core/src/node.js, line 294Gets all nodes beneath node that have a matching attribute value pair.
-
Gets all nodes beneath node that have a matching attribute value pair.
Name Type Description attributeString The attribute to look for.
valueString The attribute value to look for.
Returns:
Type Description Array.<GoBrain.Node> -
getNodesByClass(clazz){Array.<GoBrain.Node>}
GoBrain.Core/src/node.js, line 313Gets all nodes beneath node that have a matching css class.
-
Gets all nodes beneath node that have a matching css class.
Name Type Description clazzString The class to look for.
Returns:
Type Description Array.<GoBrain.Node> -
getNodesById(id){Array.<GoBrain.Node>}
GoBrain.Core/src/node.js, line 331Gets all nodes beneath node that have a matching id.
-
Gets all nodes beneath node that have a matching id.
Name Type Description idString The id to look for.
Returns:
Type Description Array.<GoBrain.Node> -
hasAncestor(ancestor){Boolean}
GoBrain.Core/src/node.js, line 349Checks if the node has a specific element as ancestor.
-
Checks if the node has a specific element as ancestor.
Name Type Description ancestorGoBrain.Node | HTMLElement The potential ancestor to check against.
Returns:
Type Description Boolean -
hasAttribute(attribute){Boolean}
GoBrain.Core/src/node.js, line 365Checks if the node has a specific attribute.
-
Checks if the node has a specific attribute.
Name Type Description attributeString The attribute to look for.
Returns:
Type Description Boolean -
hasChild(child){Boolean}
GoBrain.Core/src/node.js, line 381Checks if the node has a specific element as first level child.
-
Checks if the node has a specific element as first level child.
Name Type Description childGoBrain.Node | HTMLElement The potential child to check against.
Returns:
Type Description Boolean -
hasClass(clazz){Boolean}
GoBrain.Core/src/node.js, line 397Checks if the node has a specific css class.
-
Checks if the node has a specific css class.
Name Type Description clazzString The css class to look for.
Returns:
Type Description Boolean -
hasDescendant(descendant){Boolean}
GoBrain.Core/src/node.js, line 423Checks if the node has a specific element as descendant.
-
Checks if the node has a specific element as descendant.
Name Type Description descendantGoBrain.Node | HTMLElement The potential descendant to check against.
Returns:
Type Description Boolean -
height(value){GoBrain.Node|Number}
GoBrain.Core/src/node.js, line 450Gets or sets the node height.
-
Gets or sets the node height.
Name Type Description valueNumber | String optional The new height.
Returns:
Type Description GoBrain.Node | Number -
hide(){GoBrain.Node}
GoBrain.Core/src/node.js, line 473Hides the node.
-
Hides the node.
Returns:
Type Description GoBrain.Node -
innerContent(content){GoBrain.Node|*}
GoBrain.Core/src/node.js, line 492Gets or sets node inner content.
-
Gets or sets node inner content.
Name Type Description content* optional The content to set.
Returns:
Type Description GoBrain.Node | * -
insertAfter(element){GoBrain.Node}
GoBrain.Core/src/node.js, line 514Inserts a node/element after the node.
-
Inserts a node/element after the node.
Name Type Description elementGoBrain.Node | HTMLElement The node element to insert.
Returns:
Type Description GoBrain.Node -
insertBefore(element){GoBrain.Node}
GoBrain.Core/src/node.js, line 530Inserts a node/element before the node.
-
Inserts a node/element before the node.
Name Type Description elementGoBrain.Node | HTMLElement The node element to insert.
Returns:
Type Description GoBrain.Node -
matches(selector){Boolean}
GoBrain.Core/src/node.js, line 546Checks if the node matches a selector.
-
Checks if the node matches a selector.
Name Type Description selectorString The selector to check against.
Returns:
Type Description Boolean -
nextSibling(){GoBrain.Node|null}
GoBrain.Core/src/node.js, line 581Gets the node's next sibling.
-
Gets the node's next sibling.
Returns:
Type Description GoBrain.Node | null -
parent(){GoBrain.Node}
GoBrain.Core/src/node.js, line 596Gets the node's parent node.
-
Gets the node's parent node.
Returns:
Type Description GoBrain.Node -
previousSibling(){GoBrain.Node|null}
GoBrain.Core/src/node.js, line 611Gets the node's previous sibling.
-
Gets the node's previous sibling.
Returns:
Type Description GoBrain.Node | null -
query(query){Array.<GoBrain.Node>}
GoBrain.Core/src/node.js, line 626Gets all nodes beneath node that have a matching query.
-
Gets all nodes beneath node that have a matching query.
Name Type Description queryString The query to look for.
Returns:
Type Description Array.<GoBrain.Node> -
remove(){null}
GoBrain.Core/src/node.js, line 644Removes the node.
-
Removes the node.
Returns:
Type Description null -
removeChild(child){GoBrain.Node}
GoBrain.Core/src/node.js, line 661Removes a child from the node.
-
Removes a child from the node.
Name Type Description childGoBrain.Node | HTMLElement The child to remove.
Returns:
Type Description GoBrain.Node -
removeClass(clazz){GoBrain.Node}
GoBrain.Core/src/node.js, line 677Removes a css class from the node.
-
Removes a css class from the node.
Name Type Description clazzString The css class to remove.
Returns:
Type Description GoBrain.Node -
removeEventListener(event, handler, options){GoBrain.Node}
GoBrain.Core/src/node.js, line 695Removes an event listener.
-
Removes an event listener.
Name Type Description eventString Event to remove listener from.
handlerfunction Handler to remove.
optionsBoolean | Object Options to use to remove the event handler. If boolean, whether or not to remove passive handler, if supported.
Returns:
Type Description GoBrain.Node -
show(){GoBrain.Node}
GoBrain.Core/src/node.js, line 725Shows the node.
-
Shows the node.
Returns:
Type Description GoBrain.Node -
style(property, value){GoBrain.Node|*}
GoBrain.Core/src/node.js, line 740Gets or sets a node style property.
-
Gets or sets a node style property.
Name Type Description propertyString The style property name.
value* optional The style property value.
Returns:
Type Description GoBrain.Node | * -
toggleClass(clazz){GoBrain.Node}
GoBrain.Core/src/node.js, line 797Toggles a css class, if the node has the class it will be removed otherwise it will be added.
-
Toggles a css class, if the node has the class it will be removed otherwise it will be added.
Name Type Description clazzString The css class to toggle.
Returns:
Type Description GoBrain.Node -
width(value){GoBrain.Node|Number}
GoBrain.Core/src/node.js, line 817Gets or sets the node width.
-
Gets or sets the node width.
Name Type Description valueNumber | String optional The new width.
Returns:
Type Description GoBrain.Node | Number