How to add
You can add this library by the key below. (for legacy script editor)
MJqa3Uidm9a8fNR_0snRPwKWZ8rqdjnSl
if you want to know how to use this key , please check this guidance.
How to use
1. Get html text by UrlFetchApp, PhantomJsCloud (if require script running to get html) or other tools.
2. make Html class by the html text like below.
(insert html text string to argument.)
var html = Html.parse({htmlText}); //get Html class
console.log(html.tree()); //check the structure of the html and get XPath of each Element. 3. use Html class methods and get Element you want to reach.
(insert XPath string to argument. for example: ‘/body/div/header[1]/div’)
var elm = html.getElmX({XPath}); //get Element class4. use Element class methods and get detail of this Element.
var tagName = elm.tag(); //get tag tagName
var attObj = elm.att(); //get attribution object.
var innerText = elm.innerText(); //get inner text (Not including inner html)Class Html
Access all Elements included in this Html.
| Method | Return type | Brief description |
|---|---|---|
| tree() | String | Make structural description of the whole html for programmer's convinience. It includes also xpath and attributions for each tags. when making code, you use this method to comfirm xpath and attributions of the element you want to reach. |
| getElmX('XPath') | Element | search whole html and return Element correspond to 'XPath' string. If no fitting Element, return null. |
| getElmId('idValue') | Element | search whole html and return Element with id attribution and the value correspond to 'idValue' string. If no fitting Element, return null. |
| getElmIds('idValue') | [Elements] | search whole html and return array which contains all Element with id attribution and the value correspond to 'idValue' string. If no fitting Element, return null. |
| getElmClass('clsValue') | Element | search whole html and return Element with class attribution and the value correspond to 'clsValue' string. If no fitting Element, return null. |
| getElmClasses('clsValue') | [Elements] | search whole html and return array which contains all Element with class attribution and the value correspond to 'clsValue' string. If no fitting Element, return null. |
| getElmTag('tagName') | Element | search whole html and return Element whose tag is correspond to 'tagName' string. If no fitting Element, return null. |
| getElmTags('tagName') | [Elements] | search whole html and return array which contains all Elements whose tag is correspond to 'tagName' string. If no fitting Element, return null. |
| getElmAtt(attObject) | Element | search whole html and return Element having attObject's all keys in the attribution keys and each attribution value is correspond to each attObject's value. If no fitting Element, return null. |
| getElmAtts(attObject) | [Elements] | search whole html and return array which contains all Elements having attObject's all keys in the attribution keys and each attribution value is correspond to each attObject's value. If no fitting Element, return null. |
| html() | String | return whole html text acquired by structural analysis. |
Class Element
Get detail of this Element and access all Elements locate directly under this Element.
| Method | Return type | Brief description |
|---|---|---|
| tree() | String | Make structural description of the whole html for programmer's convinience. It includes also xpath and attributions for each tags. when making code, you use this method to comfirm xpath and attributions of the element you want to reach. |
| level() | Integer | return hierarchy depth of this Element. Usually html tag is level 1. head tag or body tag that locate directly under html tag are level 2 |
| tag() | String | return tag name of this Element. |
| topTag() | String | return whole start tag html of this Element. |
| lastTag() | String | return whole end tag html of this Element. |
| innerHtml() | String | return inner html of included Elements (this Element and all Elements locate directly under this Element). Not include inner text. |
| innerText() | String | return inner text of included Elements (this Element and all Elements locate directly under this Element). Not include inner html. |
| att() | Object | return Object contains all attributions information of this Element. At each key-value pair in the Object, key is attribution's name, value is attribution's value. |
| getElmX('XPath') | Element | search included Elements and return Element correspond to 'XPath' string. If no fitting Element, return null. [caution!] need only a part of XPath after this elements. |
| getElmId('idValue') | Element | search included Elements and return Element with id attribution and the value correspond to 'idValue' string. If no fitting Element, return null. |
| getElmIds('idValue') | [Elements] | search included Elements and return array which contains all Element with id attribution and the value correspond to 'idValue' string. If no fitting Element, return null. |
| getElmClass('clsValue') | Element | search included Elements and return Element with class attribution and the value correspond to 'clsValue' string. If no fitting Element, return null. |
| getElmClasses('clsValue') | [Elements] | search included Elements and return array which contains all Element with class attribution and the value correspond to 'clsValue' string. If no fitting Element, return null. |
| getElmTag('tagName') | Element | search included Elements and return Element whose tag is correspond to 'tagName' string. If no fitting Element, return null. |
| getElmTags('tagName') | [Elements] | search included Elements and return array which contains all Elements whose tag is correspond to 'tagName' string. If no fitting Element, return null. |
| getElmAtt(attObject) | Element | search included Elements and return Element having attObject's all keys in the attribution keys and each attribution value is correspond to each attObject's value. If no fitting Element, return null. |
| getElmAtts(attObject) | [Elements] | search included Elements and return array which contains all Elements having attObject's all keys in the attribution keys and each attribution value is correspond to each attObject's value. If no fitting Element, return null. |
| html() | String | return included html text acquired by structural analysis. |