85 lines
3.4 KiB
Markdown
85 lines
3.4 KiB
Markdown
# PolymerVis
|
|
PolymerVis is a suite of Polymer elements for visualizations.
|
|
|
|
## Quick start
|
|
Import the `polymer-vis.html` file to use any of the utility functions.
|
|
|
|
```html
|
|
<link rel="import" href="../bower_components/polymer-vis.html">
|
|
```
|
|
|
|
Alternatively, you can also include it as a script instead.
|
|
```html
|
|
<script src="../bower_components/build/es5/polymer-vis.js"></script>
|
|
```
|
|
|
|
## API reference
|
|
<a name="exp_module_loadScript--PolymerVis.loadScript"></a>
|
|
|
|
## PolymerVis.loadScript(src, onload, onerror, optAsync) ⇒ <code>HTMLScriptElement</code> ⏏
|
|
Convenience method for dynamically loading a script.
|
|
|
|
This method creates a new `<script>` element with the provided URL and
|
|
appends it to the document to start loading. In the onload callback, the
|
|
import property of the link element will contain the imported document
|
|
contents.
|
|
|
|
**Kind**: global method of [<code>PolymerVis.loadScript</code>](#exp_module_loadScript--PolymerVis.loadScript)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| src | <code>string</code> | The url to the script to load. |
|
|
| onload | <code>function</code> | callback when script is loaded. |
|
|
| onerror | <code>function</code> | callback when error loading script. |
|
|
| optAsync | <code>boolean</code> | whether to execute the script asynchronously. |
|
|
|
|
<a name="exp_module_loadStylesheet--PolymerVis.loadStylesheet"></a>
|
|
|
|
## PolymerVis.loadStylesheet(href, onload, onerror, optAsync) ⇒ <code>HTMLLinkElement</code> ⏏
|
|
Convenience method for dynamically loading a stylesheet.
|
|
|
|
This method creates a new `<link rel="stylesheet">` element with the
|
|
provided URL and appends it to the document to start loading. In the onload
|
|
callback, the import property of the link element will contain the
|
|
imported document contents.
|
|
|
|
**Kind**: global method of [<code>PolymerVis.loadStylesheet</code>](#exp_module_loadStylesheet--PolymerVis.loadStylesheet)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| href | <code>string</code> | The url to the script to load. |
|
|
| onload | <code>function</code> | callback when script is loaded. |
|
|
| onerror | <code>function</code> | callback when error loading script. |
|
|
| optAsync | <code>boolean</code> | whether to execute the script asynchronously. |
|
|
|
|
<a name="exp_module_insertCssIntoShadowRoot--PolymerVis.insertCssIntoShadowRoot"></a>
|
|
|
|
## PolymerVis.insertCssIntoShadowRoot(cssSrc, shadowRoot, id) ⏏
|
|
Load an external CSS file, and insert a `style` element
|
|
into the shadowRoot.
|
|
|
|
**Kind**: global method of [<code>PolymerVis.insertCssIntoShadowRoot</code>](#exp_module_insertCssIntoShadowRoot--PolymerVis.insertCssIntoShadowRoot)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| cssSrc | <code>String</code> | url to the css file |
|
|
| shadowRoot | <code>String</code> | Node to insert the `style` element |
|
|
| id | <code>String</code> | id for style element |
|
|
|
|
**Example**
|
|
```js
|
|
PolymerVis.insertCssIntoShadowRoot('https://some.css', ele.shadowRoot, 'custom');
|
|
```
|
|
<a name="exp_module_isInShadowRoot--PolymerVis.isInShadowRoot"></a>
|
|
|
|
## PolymerVis.isInShadowRoot(node) ⇒ <code>Node</code> ⏏
|
|
Check if the node is inside a [`shadowRoot`](https://developer.mozilla.org/en-US/docs/Web/API/shadowRoot) or not.
|
|
Return the `shadowRoot` otherwise return `false`.
|
|
|
|
**Kind**: global method of [<code>PolymerVis.isInShadowRoot</code>](#exp_module_isInShadowRoot--PolymerVis.isInShadowRoot)
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| node | <code>Node</code> | the node to check |
|
|
|