|
|
||
|---|---|---|
| .. | ||
| .bower.json | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierrc | ||
| LICENSE.md | ||
| README.hbs | ||
| README.md | ||
| bower.json | ||
| package.json | ||
| polymer-vis.html | ||
| polymer-vis.js | ||
| polymer.json | ||
| yarn.lock | ||
README.md
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.
<link rel="import" href="../bower_components/polymer-vis.html">
Alternatively, you can also include it as a script instead.
<script src="../bower_components/build/es5/polymer-vis.js"></script>
API reference
PolymerVis.loadScript(src, onload, onerror, optAsync) ⇒ HTMLScriptElement ⏏
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 PolymerVis.loadScript
| Param | Type | Description |
|---|---|---|
| src | string |
The url to the script to load. |
| onload | function |
callback when script is loaded. |
| onerror | function |
callback when error loading script. |
| optAsync | boolean |
whether to execute the script asynchronously. |
PolymerVis.loadStylesheet(href, onload, onerror, optAsync) ⇒ HTMLLinkElement ⏏
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 PolymerVis.loadStylesheet
| Param | Type | Description |
|---|---|---|
| href | string |
The url to the script to load. |
| onload | function |
callback when script is loaded. |
| onerror | function |
callback when error loading script. |
| optAsync | boolean |
whether to execute the script asynchronously. |
PolymerVis.insertCssIntoShadowRoot(cssSrc, shadowRoot, id) ⏏
Load an external CSS file, and insert a style element
into the shadowRoot.
Kind: global method of PolymerVis.insertCssIntoShadowRoot
| Param | Type | Description |
|---|---|---|
| cssSrc | String |
url to the css file |
| shadowRoot | String |
Node to insert the style element |
| id | String |
id for style element |
Example
PolymerVis.insertCssIntoShadowRoot('https://some.css', ele.shadowRoot, 'custom');
PolymerVis.isInShadowRoot(node) ⇒ Node ⏏
Check if the node is inside a shadowRoot or not.
Return the shadowRoot otherwise return false.
Kind: global method of PolymerVis.isInShadowRoot
| Param | Type | Description |
|---|---|---|
| node | Node |
the node to check |