oe-ui-misc
Version:
collection of miscellaneous oe-ui Polymer components
1,713 lines • 553 kB
JSON
{
"schema_version": "1.0.0",
"elements": [
{
"description": "`oe-breadcrumb` component can be used as a navigation aid in user interfaces and it has been categorised in 2 ways:\n\n1. Basic Breadcrumb navigation: When list has less than 4 elements, then the list is shown in a linear fashion way separated by '/'.\n e.g. Home / Sub Level 1 / Sub Level 2\n2. Collapse Breadcrumb navigation: When list has more than 3 elements, then between the first and last element menu icon appears.\n On click of menu icon, a dropdown with all the middle element appears. e.g. Home / ... / Sub Level 5\n\n### Styling\n\r\nThe following custom properties and mixins are available for styling:\n\r\nCustom property | Description | Default\n----------------|-------------|----------\n`--oe-breadcrumb-bcg-color` | Background color for breadcrumb list | `#ffffff` |\n`--oe-breadcrumb-hover-color` | Hover color for item selected | `rgb(0, 107, 255,0.3)` |\n`--oe-breadcrumb-lastData-color` | Last item color | `#808080` |\n`--oe-breadcrumb-hover-text-color` | Text color on hovering the selected item | `rgb(0, 107, 255,1)` |",
"summary": "",
"path": "oe-breadcrumb.js",
"properties": [
{
"name": "list",
"type": "Array | null | undefined",
"description": "Array of navigation objects with label and path strings",
"privacy": "public",
"sourceRange": {
"start": {
"line": 132,
"column": 6
},
"end": {
"line": 138,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"_computeList\"",
"attributeType": "Array"
}
},
"defaultValue": "[]"
}
],
"methods": [
{
"name": "_computeList",
"description": "Function that checks the lengthlengthlength of list and finds first, midle and last elemnts from a list",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 145,
"column": 2
},
"end": {
"line": 177,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "_tapActionOnOverflow",
"description": "Fires oe-breadcrumb-selected event on selection of any item from the dropdown menu",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 184,
"column": 2
},
"end": {
"line": 197,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "e"
}
],
"return": {
"type": "void"
}
},
{
"name": "_tapActionFirstItem",
"description": "Fires oe-breadcrumb-selected event on selection of first item",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 202,
"column": 2
},
"end": {
"line": 211,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
},
{
"name": "_tapActionMidItem",
"description": "Fires oe-breadcrumb-selected event on selection of middle item",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 216,
"column": 2
},
"end": {
"line": 229,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "e"
}
],
"return": {
"type": "void"
}
},
{
"name": "_tapActionLastItem",
"description": "Fires oe-breadcrumb-selected event on selection of last item",
"privacy": "protected",
"sourceRange": {
"start": {
"line": 235,
"column": 2
},
"end": {
"line": 248,
"column": 3
}
},
"metadata": {},
"params": [],
"return": {
"type": "void"
}
}
],
"staticMethods": [],
"demos": [
{
"url": "demo/demo-oe-breadcrumbs.html",
"description": ""
}
],
"metadata": {},
"sourceRange": {
"start": {
"line": 31,
"column": 0
},
"end": {
"line": 249,
"column": 1
}
},
"privacy": "public",
"superclass": "HTMLElement",
"name": "OeBreadcrumb",
"attributes": [
{
"name": "list",
"description": "Array of navigation objects with label and path strings",
"sourceRange": {
"start": {
"line": 132,
"column": 6
},
"end": {
"line": 138,
"column": 7
}
},
"metadata": {},
"type": "Array | null | undefined"
}
],
"events": [
{
"type": "CustomEvent",
"name": "oe-breadcrumb-selected",
"description": "Fired when an item from the breadcrumb is clicked",
"metadata": {}
}
],
"styling": {
"cssVariables": [],
"selectors": []
},
"slots": [],
"tagname": "oe-breadcrumb"
},
{
"description": "`oe-document-data`",
"summary": "",
"path": "oe-document-data.js",
"properties": [
{
"name": "document",
"type": "Object | null | undefined",
"description": "Object which contains documentName and documentData property.",
"privacy": "public",
"sourceRange": {
"start": {
"line": 56,
"column": 6
},
"end": {
"line": 59,
"column": 7
}
},
"metadata": {
"polymer": {
"notify": true,
"attributeType": "Object"
}
}
},
{
"name": "documentId",
"type": "string | null | undefined",
"description": "Property of type string and has a documentSet as an observer.",
"privacy": "public",
"sourceRange": {
"start": {
"line": 63,
"column": 6
},
"end": {
"line": 66,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"documentSet\"",
"attributeType": "String"
}
}
},
{
"name": "documentPostUrl",
"type": "string | null | undefined",
"description": "URL used in makeAjaxcall.",
"privacy": "public",
"sourceRange": {
"start": {
"line": 70,
"column": 6
},
"end": {
"line": 72,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "String"
}
}
},
{
"name": "relationName",
"type": "string | null | undefined",
"description": "Name of relation.",
"privacy": "public",
"sourceRange": {
"start": {
"line": 76,
"column": 6
},
"end": {
"line": 78,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "String"
}
}
},
{
"name": "documentParentAttribute",
"type": "string | null | undefined",
"description": "property of type string.",
"privacy": "public",
"sourceRange": {
"start": {
"line": 82,
"column": 6
},
"end": {
"line": 84,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "String"
}
}
},
{
"name": "parentId",
"type": "string | null | undefined",
"description": "It is parameter for documentSet method.",
"privacy": "public",
"sourceRange": {
"start": {
"line": 88,
"column": 6
},
"end": {
"line": 90,
"column": 7
}
},
"metadata": {
"polymer": {
"attributeType": "String"
}
}
}
],
"methods": [
{
"name": "makeAjaxCall",
"description": "Generates a oe-ajax call based on the parameter and calls the callback function with error or response.",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-ajax-mixin.js",
"start": {
"line": 37,
"column": 8
},
"end": {
"line": 88,
"column": 9
}
},
"metadata": {},
"params": [
{
"name": "url",
"type": "string",
"description": "url to make the ajax call"
},
{
"name": "method",
"type": "string",
"description": "method for ajax call ,'get','put','post' or 'delete'"
},
{
"name": "body",
"type": "Object",
"description": "Content to pass as body of the call"
},
{
"name": "header",
"type": "Object",
"description": "Headers set on the request"
},
{
"name": "params",
"type": "Object",
"description": "Query parameters like filter etc."
},
{
"name": "ajaxProps",
"type": "Object",
"description": "Properties to set on ajax like contentType and handleAs."
},
{
"name": "cb",
"type": "Function",
"description": "Function called with Error and response."
}
],
"return": {
"type": "void"
},
"inheritedFrom": "OEAjaxMixin"
},
{
"name": "makeXhrCall",
"description": "Generates a Vanilla JS XHR call based on the arguments",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-ajax-mixin.js",
"start": {
"line": 98,
"column": 8
},
"end": {
"line": 126,
"column": 9
}
},
"metadata": {},
"params": [
{
"name": "url",
"type": "string",
"description": "url to make the xhr call"
},
{
"name": "method",
"type": "string",
"description": "method for xhr call ,'get','put','post' or 'delete'"
},
{
"name": "body",
"type": "Object",
"description": "Content to pass as body of the call"
},
{
"name": "header",
"type": "Object",
"description": "Headers set on the request"
},
{
"name": "cb",
"type": "Function",
"description": "Function called with Error and response."
}
],
"return": {
"type": "void"
},
"inheritedFrom": "OEAjaxMixin"
},
{
"name": "resolveError",
"description": "Resolves the error from server into error message",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-ajax-mixin.js",
"start": {
"line": 133,
"column": 8
},
"end": {
"line": 137,
"column": 9
}
},
"metadata": {},
"params": [
{
"name": "err",
"type": "Error",
"description": "Error from server call"
}
],
"return": {
"type": "string",
"desc": "error message"
},
"inheritedFrom": "OEAjaxMixin"
},
{
"name": "resolveErrors",
"description": "Resolves multiple errors from server into error message",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-ajax-mixin.js",
"start": {
"line": 144,
"column": 8
},
"end": {
"line": 236,
"column": 9
}
},
"metadata": {},
"params": [
{
"name": "err",
"type": "Error",
"description": "Error from server call"
}
],
"return": {
"type": "(string | Object)",
"desc": "error message or errors array"
},
"inheritedFrom": "OEAjaxMixin"
},
{
"name": "_getRestApiUrl",
"description": "Computes valid path based on restApiRoot",
"privacy": "protected",
"sourceRange": {
"file": "../oe-mixins/oe-ajax-mixin.js",
"start": {
"line": 242,
"column": 8
},
"end": {
"line": 245,
"column": 9
}
},
"metadata": {},
"params": [
{
"name": "path",
"type": "string"
}
],
"inheritedFrom": "OEAjaxMixin"
},
{
"name": "_deepValue",
"description": "Get the value from the 'obj' based on the 'path'.",
"privacy": "protected",
"sourceRange": {
"file": "../oe-mixins/oe-common-mixin.js",
"start": {
"line": 37,
"column": 4
},
"end": {
"line": 43,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "obj",
"type": "Object",
"description": "object to navigate"
},
{
"name": "path",
"type": "string",
"description": "path for navigation"
}
],
"return": {
"type": "Any",
"desc": "value present in the given path of the obj."
},
"inheritedFrom": "OECommonMixin"
},
{
"name": "_deepSet",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "../oe-mixins/oe-common-mixin.js",
"start": {
"line": 45,
"column": 4
},
"end": {
"line": 62,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "obj"
},
{
"name": "path"
},
{
"name": "value"
}
],
"inheritedFrom": "OECommonMixin"
},
{
"name": "debounce",
"description": "Call `debounce` to collapse multiple requests for a named task into\none invocation which is made after the wait time has elapsed with\nno new request. If no wait time is given, the callback will be called\nat microtask timing (guaranteed before paint).\n\n debouncedClickAction(e) {\n // will not call `processClick` more than once per 100ms\n this.debounce('click', function() {\n this.processClick();\n } 100);\n }",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-common-mixin.js",
"start": {
"line": 88,
"column": 4
},
"end": {
"line": 92,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "jobName",
"type": "string",
"description": "String to identify the debounce job."
},
{
"name": "callback",
"type": "function (): void",
"description": "Function that is called (with `this`\n context) when the wait time elapses."
},
{
"name": "wait",
"type": "number",
"description": "Optional wait time in milliseconds (ms) after the\n last signal that must elapse before invoking `callback`"
}
],
"return": {
"type": "!Object",
"desc": "Returns a debouncer object on which exists the\nfollowing methods: `isActive()` returns true if the debouncer is\nactive; `cancel()` cancels the debouncer if it is active;\n`flush()` immediately invokes the debounced callback if the debouncer\nis active."
},
"inheritedFrom": "OECommonMixin"
},
{
"name": "async",
"description": "Runs a callback function asynchronously.\n\nBy default (if no waitTime is specified), async callbacks are run at\nmicrotask timing, which will occur before paint.",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-common-mixin.js",
"start": {
"line": 106,
"column": 4
},
"end": {
"line": 109,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "callback",
"type": "!Function",
"description": "The callback function to run, bound to `this`."
},
{
"name": "waitTime",
"type": "number=",
"description": "Time to wait before calling the\n `callback`. If unspecified or 0, the callback will be run at microtask\n timing (before paint)."
}
],
"return": {
"type": "number",
"desc": "Handle that may be used to cancel the async job."
},
"inheritedFrom": "OECommonMixin"
},
{
"name": "cancelAsync",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-common-mixin.js",
"start": {
"line": 120,
"column": 4
},
"end": {
"line": 122,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "handle"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "OECommonMixin"
},
{
"name": "fire",
"description": "Polymer fire function used to dispatch custom events",
"privacy": "public",
"sourceRange": {
"file": "../oe-mixins/oe-common-mixin.js",
"start": {
"line": 131,
"column": 4
},
"end": {
"line": 143,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "type",
"type": "string",
"description": "event name"
},
{
"name": "detail",
"type": "Object",
"description": "data to be sent in the event"
},
{
"name": "options",
"type": "Object",
"description": "optionals options for the event {bubbles:Boolean,cancelable:Boolean,composed:Boolean,node:HTML Element}"
}
],
"return": {
"type": "Event",
"desc": "Custom event created based on the parameters"
},
"inheritedFrom": "OECommonMixin"
},
{
"name": "documentSet",
"description": "eslint no-undef: \"error\"",
"privacy": "public",
"sourceRange": {
"start": {
"line": 95,
"column": 2
},
"end": {
"line": 136,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "parentId"
}
],
"return": {
"type": "void"
}
},
{
"name": "openFile",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 137,
"column": 2
},
"end": {
"line": 140,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "event"
}
],
"return": {
"type": "void"
}
},
{
"name": "getFile",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 141,
"column": 2
},
"end": {
"line": 156,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "event"
}
],
"return": {
"type": "void"
}
},
{
"name": "download",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 157,
"column": 2
},
"end": {
"line": 193,
"column": 3
}
},
"metadata": {},
"params": [
{
"name": "parentId"
}
],
"return": {
"type": "void"
}
},
{
"name": "showInput",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 194,
"column": 2
},
"end": {
"line": 201,
"column": 3
}
},
"metadata": {},
"params": []
}
],
"staticMethods": [],
"demos": [],
"metadata": {},
"sourceRange": {
"start": {
"line": 23,
"column": 0
},
"end": {
"line": 209,
"column": 1
}
},
"privacy": "public",
"superclass": "HTMLElement",
"name": "OeDocumentData",
"attributes": [
{
"name": "document",
"description": "Object which contains documentName and documentData property.",
"sourceRange": {
"start": {
"line": 56,
"column": 6
},
"end": {
"line": 59,
"column": 7
}
},
"metadata": {},
"type": "Object | null | undefined"
},
{
"name": "document-id",
"description": "Property of type string and has a documentSet as an observer.",
"sourceRange": {
"start": {
"line": 63,
"column": 6
},
"end": {
"line": 66,
"column": 7
}
},
"metadata": {},
"type": "string | null | undefined"
},
{
"name": "document-post-url",
"description": "URL used in makeAjaxcall.",
"sourceRange": {
"start": {
"line": 70,
"column": 6
},
"end": {
"line": 72,
"column": 7
}
},
"metadata": {},
"type": "string | null | undefined"
},
{
"name": "relation-name",
"description": "Name of relation.",
"sourceRange": {
"start": {
"line": 76,
"column": 6
},
"end": {
"line": 78,
"column": 7
}
},
"metadata": {},
"type": "string | null | undefined"
},
{
"name": "document-parent-attribute",
"description": "property of type string.",
"sourceRange": {
"start": {
"line": 82,
"column": 6
},
"end": {
"line": 84,
"column": 7
}
},
"metadata": {},
"type": "string | null | undefined"
},
{
"name": "parent-id",
"description": "It is parameter for documentSet method.",
"sourceRange": {
"start": {
"line": 88,
"column": 6
},
"end": {
"line": 90,
"column": 7
}
},
"metadata": {},
"type": "string | null | undefined"
}
],
"events": [
{
"type": "CustomEvent",
"name": "document-changed",
"description": "Fired when the `document` property changes.",
"metadata": {}
}
],
"styling": {
"cssVariables": [],
"selectors": []
},
"slots": [],
"tagname": "oe-document-data",
"mixins": [
"OEAjaxMixin",
"OECommonMixin"
]
},
{
"description": "`oe-hbox`\n`oe-hbox` displays content horizontally. child elements occupy their default width and wrap around when 'oe-hbox' width is not sufficient.\n```\n<oe-hbox>\n <paper-input label=\"First Name\"></paper-input>\n <paper-input label=\"Last Name\"></paper-input>\n <paper-input label=\"City\"></paper-input>\n <paper-input label=\"Zip Code\"></paper-input>\n</oe-hbox>\n```\nfor arranging controls in two column, apply additional css class on hbox like below\n\n### Style\n```\n<style>\n .layout-2-col > * {\n width: calc(50.00% - 16px);\n padding-left: 8px;\n padding-right: 8px;\n }\n</style>\n```\n\n```\n<oe-hbox class=\"layout-2-col\">\n ...\n ...\n</oe-hbox>\n```",
"summary": "",
"path": "oe-hbox.js",
"properties": [
{
"name": "__dataEnabled",
"type": "boolean",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/properties-changed.js",
"start": {
"line": 167,
"column": 6
},
"end": {
"line": 167,
"column": 24
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"defaultValue": "false",
"inheritedFrom": "PropertiesChanged"
},
{
"name": "__dataClientsReady",
"type": "boolean",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1116,
"column": 6
},
"end": {
"line": 1116,
"column": 30
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataPendingClients",
"type": "Array",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1118,
"column": 6
},
"end": {
"line": 1118,
"column": 32
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataToNotify",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1120,
"column": 6
},
"end": {
"line": 1120,
"column": 26
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataLinkedPaths",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1122,
"column": 6
},
"end": {
"line": 1122,
"column": 29
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataHasPaths",
"type": "boolean",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1124,
"column": 6
},
"end": {
"line": 1124,
"column": 26
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataCompoundStorage",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1126,
"column": 6
},
"end": {
"line": 1126,
"column": 33
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataHost",
"type": "Polymer_PropertyEffects",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1128,
"column": 6
},
"end": {
"line": 1128,
"column": 22
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataTemp",
"type": "!Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1130,
"column": 6
},
"end": {
"line": 1130,
"column": 22
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataClientsInitialized",
"type": "boolean",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1132,
"column": 6
},
"end": {
"line": 1132,
"column": 36
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__data",
"type": "!Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1134,
"column": 6
},
"end": {
"line": 1134,
"column": 18
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataPending",
"type": "(!Object | null)",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1136,
"column": 6
},
"end": {
"line": 1136,
"column": 25
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__dataOld",
"type": "!Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1138,
"column": 6
},
"end": {
"line": 1138,
"column": 21
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__computeEffects",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1140,
"column": 6
},
"end": {
"line": 1140,
"column": 28
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__reflectEffects",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1142,
"column": 6
},
"end": {
"line": 1142,
"column": 28
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__notifyEffects",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1144,
"column": 6
},
"end": {
"line": 1144,
"column": 27
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__propagateEffects",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1146,
"column": 6
},
"end": {
"line": 1146,
"column": 30
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__observeEffects",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1148,
"column": 6
},
"end": {
"line": 1148,
"column": 28
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__readOnly",
"type": "Object",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1150,
"column": 6
},
"end": {
"line": 1150,
"column": 22
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "__templateInfo",
"type": "!TemplateInfo",
"description": "",
"privacy": "private",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1152,
"column": 6
},
"end": {
"line": 1152,
"column": 26
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "PROPERTY_EFFECT_TYPES",
"type": "!Object.<string, string>",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 1158,
"column": 4
},
"end": {
"line": 1160,
"column": 5
}
},
"metadata": {
"polymer": {
"readOnly": true
}
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "_template",
"type": "HTMLTemplateElement",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/element-mixin.js",
"start": {
"line": 523,
"column": 6
},
"end": {
"line": 523,
"column": 21
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "ElementMixin"
},
{
"name": "_importPath",
"type": "string",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/element-mixin.js",
"start": {
"line": 525,
"column": 6
},
"end": {
"line": 525,
"column": 23
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "ElementMixin"
},
{
"name": "rootPath",
"type": "string",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/element-mixin.js",
"start": {
"line": 527,
"column": 6
},
"end": {
"line": 527,
"column": 20
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "ElementMixin"
},
{
"name": "importPath",
"type": "string",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/element-mixin.js",
"start": {
"line": 529,
"column": 6
},
"end": {
"line": 529,
"column": 22
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "ElementMixin"
},
{
"name": "root",
"type": "(StampedTemplate | HTMLElement | ShadowRoot)",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/element-mixin.js",
"start": {
"line": 531,
"column": 6
},
"end": {
"line": 531,
"column": 16
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "ElementMixin"
},
{
"name": "$",
"type": "!Object.<string, !Element>",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/element-mixin.js",
"start": {
"line": 533,
"column": 6
},
"end": {
"line": 533,
"column": 13
}
},
"metadata": {
"polymer": {
"readOnly": false
}
},
"inheritedFrom": "ElementMixin"
}
],
"methods": [
{
"name": "_stampTemplate",
"description": "Stamps the provided template and performs instance-time setup for\nPolymer template features, including data bindings, declarative event\nlisteners, and the `this.$` map of `id`'s to nodes. A document fragment\nis returned containing the stamped DOM, ready for insertion into the\nDOM.\n\nThis method may be called more than once; however note that due to\n`shadycss` polyfill limitations, only styles from templates prepared\nusing `ShadyCSS.prepareTemplate` will be correctly polyfilled (scoped\nto the shadow root and support CSS custom properties), and note that\n`ShadyCSS.prepareTemplate` may only be called once per element. As such,\nany styles required by in runtime-stamped templates must be included\nin the main element template.",
"privacy": "protected",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/property-effects.js",
"start": {
"line": 2490,
"column": 4
},
"end": {
"line": 2515,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "template",
"type": "!HTMLTemplateElement",
"description": "Template to stamp"
}
],
"return": {
"type": "!StampedTemplate",
"desc": "Cloned template content"
},
"inheritedFrom": "PropertyEffects"
},
{
"name": "_addMethodEventListenerToNode",
"description": "Adds an event listener by method name for the event provided.\n\nThis method generates a handler function that looks up the method\nname at handling time.",
"privacy": "protected",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/template-stamp.js",
"start": {
"line": 527,
"column": 4
},
"end": {
"line": 532,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "node",
"type": "!EventTarget",
"description": "Node to add listener on"
},
{
"name": "eventName",
"type": "string",
"description": "Name of event"
},
{
"name": "methodName",
"type": "string",
"description": "Name of method"
},
{
"name": "context",
"type": "*=",
"description": "Context the method will be called on (defaults\n to `node`)"
}
],
"return": {
"type": "Function",
"desc": "Generated handler function"
},
"inheritedFrom": "TemplateStamp"
},
{
"name": "_addEventListenerToNode",
"description": "Override point for adding custom or simulated event handling.",
"privacy": "protected",
"sourceRange": {
"file": "../@polymer/polymer/lib/mixins/template-stamp.js",
"start": {
"line": 543,
"column": 4
},
"end": {
"line": 545,
"column": 5
}
},
"metadata": {},
"params": [
{
"name": "node",
"type": "!EventTarget",
"description": "Node to add event listener to"
},
{
"name": "eventName",
"type": "string",
"description": "Name of event"
},
{
"name": "handler",
"type": "function (!Event): void",
"description": "Listener function to add"
}
],
"return": {
"type": "void"
},
"inheritedFrom": "TemplateStamp"
},
{
"name": "_removeEventListenerFromNode",
"description": "Override point for adding custom or simulated event handling.",
"privacy": "protected",
"sourceRange": {
"file": "../@poly