{ "schema_version": "1.0.0", "elements": [ { "description": "`isu-array-selector`\n\nExample:\n```html\n\n```", "summary": "", "path": "isu-array-selector.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.", "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.", "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" }, { "name": "employees", "type": "?", "description": "", "privacy": "public", "sourceRange": { "start": { "line": 48, "column": 6 }, "end": { "line": 55, "column": 7 } }, "metadata": { "polymer": {} } } ], "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": "../@polymer/polymer/lib/mixins/template-stamp.js", "start": { "line": 556, "column": 4 }, "end": { "line": 558, "column": 5 } }, "metadata": {}, "params": [ { "name": "node", "type": "!EventTarget", "description": "Node to remove event listener from" }, { "name": "eventName", "type": "string", "description": "Name of event" }, { "name": "handler", "type": "function (!Event): void", "description": "Listener function to remove" } ], "return": { "type": "void" }, "inheritedFrom": "TemplateStamp" }, { "name": "_createPropertyAccessor", "description": "Creates a setter/getter pair for the named property with its own\nlocal storage. The getter returns the value in the local storage,\nand the setter calls `_setProperty`, which updates the local storage\nfor the property and enqueues a `_propertiesChanged` callback.\n\nThis method may be called on a prototype or an instance. Calling\nthis method may overwrite a property value that already exists on\nthe prototype/instance by creating the accessor.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 113, "column": 4 }, "end": { "line": 122, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of the property" }, { "name": "readOnly", "type": "boolean=", "description": "When true, no setter is created; the\n protected `_setProperty` function must be used to set the property" } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_addPropertyToAttributeMap", "description": "Adds the given `property` to a map matching attribute names\nto property names, using `attributeNameForProperty`. This map is\nused when deserializing attribute values to properties.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 132, "column": 4 }, "end": { "line": 140, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of the property" } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_definePropertyAccessor", "description": "Defines a property accessor for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 149, "column": 5 }, "end": { "line": 162, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of the property" }, { "name": "readOnly", "type": "boolean=", "description": "When true, no setter is created" } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "ready", "description": "Stamps the element template.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 644, "column": 4 }, "end": { "line": 650, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "ElementMixin" }, { "name": "_initializeProperties", "description": "Overrides the default `PropertyAccessors` to ensure class\nmetaprogramming related to property accessors and effects has\ncompleted (calls `finalize`).\n\nIt also initializes any property defaults provided via `value` in\n`properties` metadata.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 548, "column": 4 }, "end": { "line": 580, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "ElementMixin" }, { "name": "_initializeInstanceProperties", "description": "Called at ready time with bag of instance properties that overwrote\naccessors when the element upgraded.\n\nThe default implementation sets these properties back into the\nsetter at ready time. This method is provided as an override\npoint for customizing or providing more efficient initialization.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 235, "column": 4 }, "end": { "line": 237, "column": 5 } }, "metadata": {}, "params": [ { "name": "props", "type": "Object", "description": "Bag of property values that were overwritten\n when creating property accessors." } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_setProperty", "description": "Updates the local storage for a property (via `_setPendingProperty`)\nand enqueues a `_proeprtiesChanged` callback.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 249, "column": 4 }, "end": { "line": 253, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of the property" }, { "name": "value", "type": "*", "description": "Value to set" } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_getProperty", "description": "Returns the value for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 262, "column": 4 }, "end": { "line": 264, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of property" } ], "return": { "type": "*", "desc": "Value for the given property" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_setPendingProperty", "description": "Updates the local storage for a property, records the previous value,\nand adds it to the set of \"pending changes\" that will be passed to the\n`_propertiesChanged` callback. This method does not enqueue the\n`_propertiesChanged` callback.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 280, "column": 4 }, "end": { "line": 296, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of the property" }, { "name": "value", "type": "*", "description": "Value to set" }, { "name": "ext", "type": "boolean=", "description": "Not used here; affordance for closure" } ], "return": { "type": "boolean", "desc": "Returns true if the property changed" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_invalidateProperties", "description": "Marks the properties as invalid, and enqueues an async\n`_propertiesChanged` callback.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 307, "column": 4 }, "end": { "line": 317, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_enableProperties", "description": "Call to enable property accessor processing. Before this method is\ncalled accessor values will be set but side effects are\nqueued. When called, any pending side effects occur immediately.\nFor elements, generally `connectedCallback` is a normal spot to do so.\nIt is safe to call this method multiple times as it only turns on\nproperty accessors once.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 331, "column": 4 }, "end": { "line": 340, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_flushProperties", "description": "Calls the `_propertiesChanged` callback with the current set of\npending changes (and old values recorded when pending changes were\nset), and resets the pending set of changes. Generally, this method\nshould not be called in user code.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 352, "column": 4 }, "end": { "line": 361, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_shouldPropertiesChange", "description": "Called in `_flushProperties` to determine if `_propertiesChanged`\nshould be called. The default implementation returns true if\nproperties are pending. Override to customize when\n`_propertiesChanged` is called.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 376, "column": 4 }, "end": { "line": 378, "column": 5 } }, "metadata": {}, "params": [ { "name": "currentProps", "type": "!Object", "description": "Bag of all current accessor values" }, { "name": "changedProps", "type": "?Object", "description": "Bag of properties changed since the last\n call to `_propertiesChanged`" }, { "name": "oldProps", "type": "?Object", "description": "Bag of previous values for each property\n in `changedProps`" } ], "return": { "type": "boolean", "desc": "true if changedProps is truthy" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_propertiesChanged", "description": "Callback called when any properties with accessors created via\n`_createPropertyAccessor` have been set.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 393, "column": 4 }, "end": { "line": 394, "column": 5 } }, "metadata": {}, "params": [ { "name": "currentProps", "type": "!Object", "description": "Bag of all current accessor values" }, { "name": "changedProps", "type": "?Object", "description": "Bag of properties changed since the last\n call to `_propertiesChanged`" }, { "name": "oldProps", "type": "?Object", "description": "Bag of previous values for each property\n in `changedProps`" } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_shouldPropertyChange", "description": "Method called to determine whether a property value should be\nconsidered as a change and cause the `_propertiesChanged` callback\nto be enqueued.\n\nThe default implementation returns `true` if a strict equality\ncheck fails. The method always returns false for `NaN`.\n\nOverride this method to e.g. provide stricter checking for\nObjects/Arrays when using immutable patterns.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 415, "column": 4 }, "end": { "line": 422, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" }, { "name": "value", "type": "*", "description": "New property value" }, { "name": "old", "type": "*", "description": "Previous property value" } ], "return": { "type": "boolean", "desc": "Whether the property should be considered a change\n and enqueue a `_proeprtiesChanged` callback" }, "inheritedFrom": "PropertiesChanged" }, { "name": "attributeChangedCallback", "description": "Implements native Custom Elements `attributeChangedCallback` to\nset an attribute value to a property via `_attributeToProperty`.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 436, "column": 4 }, "end": { "line": 443, "column": 5 } }, "metadata": {}, "params": [ { "name": "name", "type": "string", "description": "Name of attribute that changed" }, { "name": "old", "type": "?string", "description": "Old attribute value" }, { "name": "value", "type": "?string", "description": "New attribute value" }, { "name": "namespace", "type": "?string", "description": "Attribute namespace." } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_attributeToProperty", "description": "Deserializes an attribute to its associated property.\n\nThis method calls the `_deserializeValue` method to convert the string to\na typed value.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 458, "column": 4 }, "end": { "line": 465, "column": 5 } }, "metadata": {}, "params": [ { "name": "attribute", "type": "string", "description": "Name of attribute to deserialize." }, { "name": "value", "type": "?string", "description": "of the attribute." }, { "name": "type", "type": "*=", "description": "type to deserialize to, defaults to the value\nreturned from `typeForProperty`" } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_propertyToAttribute", "description": "Serializes a property to its associated attribute.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 478, "column": 4 }, "end": { "line": 484, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name to reflect." }, { "name": "attribute", "type": "string=", "description": "Attribute name to reflect to." }, { "name": "value", "type": "*=", "description": "Property value to refect." } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_valueToNodeAttribute", "description": "Sets a typed value to an HTML attribute on a node.\n\nThis method calls the `_serializeValue` method to convert the typed\nvalue to a string. If the `_serializeValue` method returns `undefined`,\nthe attribute will be removed (this is the default for boolean\ntype `false`).", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 500, "column": 4 }, "end": { "line": 510, "column": 5 } }, "metadata": {}, "params": [ { "name": "node", "type": "Element", "description": "Element to set attribute to." }, { "name": "value", "type": "*", "description": "Value to serialize." }, { "name": "attribute", "type": "string", "description": "Attribute name to serialize to." } ], "return": { "type": "void" }, "inheritedFrom": "PropertiesChanged" }, { "name": "_serializeValue", "description": "Converts a typed JavaScript value to a string.\n\nThis method is called when setting JS property values to\nHTML attributes. Users may override this method to provide\nserialization for custom types.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 524, "column": 4 }, "end": { "line": 531, "column": 5 } }, "metadata": {}, "params": [ { "name": "value", "type": "*", "description": "Property value to serialize." } ], "return": { "type": "(string | undefined)", "desc": "String serialized from the provided\nproperty value." }, "inheritedFrom": "PropertiesChanged" }, { "name": "_deserializeValue", "description": "Converts a string to a typed JavaScript value.\n\nThis method is called when reading HTML attribute values to\nJS properties. Users may override this method to provide\ndeserialization for custom `type`s. Types for `Boolean`, `String`,\nand `Number` convert attributes to the expected types.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-changed.js", "start": { "line": 546, "column": 4 }, "end": { "line": 555, "column": 5 } }, "metadata": {}, "params": [ { "name": "value", "type": "?string", "description": "Value to deserialize." }, { "name": "type", "type": "*=", "description": "Type to deserialize the string to." } ], "return": { "type": "*", "desc": "Typed value deserialized from the provided string." }, "inheritedFrom": "PropertiesChanged" }, { "name": "_initializeProtoProperties", "description": "Overrides `PropertyAccessors` implementation to provide a\nmore efficient implementation of initializing properties from\nthe prototype on the instance.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1190, "column": 4 }, "end": { "line": 1194, "column": 5 } }, "metadata": {}, "params": [ { "name": "props", "type": "Object", "description": "Properties to initialize on the prototype" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_ensureAttribute", "description": "Ensures the element has the given attribute. If it does not,\nassigns the given value to the attribute.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-accessors.js", "start": { "line": 195, "column": 4 }, "end": { "line": 200, "column": 5 } }, "metadata": {}, "params": [ { "name": "attribute", "type": "string", "description": "Name of attribute to ensure is set." }, { "name": "value", "type": "string", "description": "of the attribute." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyAccessors" }, { "name": "_hasAccessor", "description": "Returns true if this library created an accessor for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-accessors.js", "start": { "line": 307, "column": 4 }, "end": { "line": 309, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "boolean", "desc": "True if an accessor was created" }, "inheritedFrom": "PropertyAccessors" }, { "name": "_isPropertyPending", "description": "Returns true if the specified property has a pending change.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-accessors.js", "start": { "line": 319, "column": 4 }, "end": { "line": 321, "column": 5 } }, "metadata": {}, "params": [ { "name": "prop", "type": "string", "description": "Property name" } ], "return": { "type": "boolean", "desc": "True if property has a pending change" }, "inheritedFrom": "PropertyAccessors" }, { "name": "_addPropertyEffect", "description": "Equivalent to static `addPropertyEffect` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1229, "column": 4 }, "end": { "line": 1237, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property that should trigger the effect" }, { "name": "type", "type": "string", "description": "Effect type, from this.PROPERTY_EFFECT_TYPES" }, { "name": "effect", "type": "Object=", "description": "Effect metadata object" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_removePropertyEffect", "description": "Removes the given property effect.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1248, "column": 4 }, "end": { "line": 1254, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property the effect was associated with" }, { "name": "type", "type": "string", "description": "Effect type, from this.PROPERTY_EFFECT_TYPES" }, { "name": "effect", "type": "Object=", "description": "Effect metadata object to remove" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_hasPropertyEffect", "description": "Returns whether the current prototype/instance has a property effect\nof a certain type.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1267, "column": 4 }, "end": { "line": 1270, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" }, { "name": "type", "type": "string=", "description": "Effect type, from this.PROPERTY_EFFECT_TYPES" } ], "return": { "type": "boolean", "desc": "True if the prototype/instance has an effect of this\n type" }, "inheritedFrom": "PropertyEffects" }, { "name": "_hasReadOnlyEffect", "description": "Returns whether the current prototype/instance has a \"read only\"\naccessor for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1282, "column": 4 }, "end": { "line": 1284, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "boolean", "desc": "True if the prototype/instance has an effect of this\n type" }, "inheritedFrom": "PropertyEffects" }, { "name": "_hasNotifyEffect", "description": "Returns whether the current prototype/instance has a \"notify\"\nproperty effect for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1296, "column": 4 }, "end": { "line": 1298, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "boolean", "desc": "True if the prototype/instance has an effect of this\n type" }, "inheritedFrom": "PropertyEffects" }, { "name": "_hasReflectEffect", "description": "Returns whether the current prototype/instance has a \"reflect to\nattribute\" property effect for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1310, "column": 4 }, "end": { "line": 1312, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "boolean", "desc": "True if the prototype/instance has an effect of this\n type" }, "inheritedFrom": "PropertyEffects" }, { "name": "_hasComputedEffect", "description": "Returns whether the current prototype/instance has a \"computed\"\nproperty effect for the given property.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1324, "column": 4 }, "end": { "line": 1326, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "boolean", "desc": "True if the prototype/instance has an effect of this\n type" }, "inheritedFrom": "PropertyEffects" }, { "name": "_setPendingPropertyOrPath", "description": "Sets a pending property or path. If the root property of the path in\nquestion had no accessor, the path is set, otherwise it is enqueued\nvia `_setPendingProperty`.\n\nThis function isolates relatively expensive functionality necessary\nfor the public API (`set`, `setProperties`, `notifyPath`, and property\nchange listeners via {{...}} bindings), such that it is only done\nwhen paths enter the system, and not at every propagation step. It\nalso sets a `__dataHasPaths` flag on the instance which is used to\nfast-path slower path-matching code in the property effects host paths.\n\n`path` can be a path string or array of path parts as accepted by the\npublic API.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1359, "column": 4 }, "end": { "line": 1391, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(number | string)>)", "description": "Path to set" }, { "name": "value", "type": "*", "description": "Value to set" }, { "name": "shouldNotify", "type": "boolean=", "description": "Set to true if this change should\n cause a property notification event dispatch" }, { "name": "isPathNotification", "type": "boolean=", "description": "If the path being set is a path\n notification of an already changed value, as opposed to a request\n to set and notify the change. In the latter `false` case, a dirty\n check is performed and then the value is set to the path before\n enqueuing the pending property change." } ], "return": { "type": "boolean", "desc": "Returns true if the property/path was enqueued in\n the pending changes bag." }, "inheritedFrom": "PropertyEffects" }, { "name": "_setUnmanagedPropertyToNode", "description": "Applies a value to a non-Polymer element/node's property.\n\nThe implementation makes a best-effort at binding interop:\nSome native element properties have side-effects when\nre-setting the same value (e.g. setting `.value` resets the\ncursor position), so we do a dirty-check before setting the value.\nHowever, for better interop with non-Polymer custom elements that\naccept objects, we explicitly re-set object changes coming from the\nPolymer world (which may include deep object changes without the\ntop reference changing), erring on the side of providing more\ninformation.\n\nUsers may override this method to provide alternate approaches.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1415, "column": 4 }, "end": { "line": 1427, "column": 5 } }, "metadata": {}, "params": [ { "name": "node", "type": "!Node", "description": "The node to set a property on" }, { "name": "prop", "type": "string", "description": "The property to set" }, { "name": "value", "type": "*", "description": "The value to set" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_enqueueClient", "description": "Enqueues the given client on a list of pending clients, whose\npending property changes can later be flushed via a call to\n`_flushClients`.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1535, "column": 4 }, "end": { "line": 1540, "column": 5 } }, "metadata": {}, "params": [ { "name": "client", "type": "Object", "description": "PropertyEffects client to enqueue" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_flushClients", "description": "Flushes any clients previously enqueued via `_enqueueClient`, causing\ntheir `_flushProperties` method to run.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1563, "column": 4 }, "end": { "line": 1574, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "__enableOrFlushClients", "description": "(c) the stamped dom enables.", "privacy": "private", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1588, "column": 4 }, "end": { "line": 1601, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_readyClients", "description": "Implements `PropertyEffects`'s `_readyClients` call. Attaches\nelement dom by calling `_attachDom` with the dom stamped from the\nelement's template via `_stampTemplate`. Note that this allows\nclient dom to be attached to the element prior to any observers\nrunning.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 662, "column": 4 }, "end": { "line": 671, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "ElementMixin" }, { "name": "setProperties", "description": "Sets a bag of property changes to this instance, and\nsynchronously processes all effects of the properties as a batch.\n\nProperty names must be simple properties, not paths. Batched\npath propagation is not supported.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1632, "column": 4 }, "end": { "line": 1643, "column": 5 } }, "metadata": {}, "params": [ { "name": "props", "type": "Object", "description": "Bag of one or more key-value pairs whose key is\n a property and value is the new value to set for that property." }, { "name": "setReadOnly", "type": "boolean=", "description": "When true, any private values set in\n `props` will be set. By default, `setProperties` will not set\n `readOnly: true` root properties." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_propagatePropertyChanges", "description": "Called to propagate any property changes to stamped template nodes\nmanaged by this element.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1732, "column": 4 }, "end": { "line": 1742, "column": 5 } }, "metadata": {}, "params": [ { "name": "changedProps", "type": "Object", "description": "Bag of changed properties" }, { "name": "oldProps", "type": "Object", "description": "Bag of previous values for changed properties" }, { "name": "hasPaths", "type": "boolean", "description": "True with `props` contains one or more paths" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "linkPaths", "description": "Aliases one data path as another, such that path notifications from one\nare routed to the other.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1754, "column": 4 }, "end": { "line": 1759, "column": 5 } }, "metadata": {}, "params": [ { "name": "to", "type": "(string | !Array.<(string | number)>)", "description": "Target path to link." }, { "name": "from", "type": "(string | !Array.<(string | number)>)", "description": "Source path to link." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "unlinkPaths", "description": "Removes a data path alias previously established with `_linkPaths`.\n\nNote, the path to unlink should be the target (`to`) used when\nlinking the paths.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1772, "column": 4 }, "end": { "line": 1777, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Target path to unlink." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "notifySplices", "description": "Notify that an array has changed.\n\nExample:\n\n this.items = [ {name: 'Jim'}, {name: 'Todd'}, {name: 'Bill'} ];\n ...\n this.items.splice(1, 1, {name: 'Sam'});\n this.items.push({name: 'Bob'});\n this.notifySplices('items', [\n { index: 1, removed: [{name: 'Todd'}], addedCount: 1,\n object: this.items, type: 'splice' },\n { index: 3, removed: [], addedCount: 1,\n object: this.items, type: 'splice'}\n ]);", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1813, "column": 4 }, "end": { "line": 1817, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "string", "description": "Path that should be notified." }, { "name": "splices", "type": "Array", "description": "Array of splice records indicating ordered\n changes that occurred to the array. Each record should have the\n following fields:\n * index: index at which the change occurred\n * removed: array of items that were removed from this index\n * addedCount: number of new items added at this index\n * object: a reference to the array in question\n * type: the string literal 'splice'\n\n Note that splice records _must_ be normalized such that they are\n reported in index order (raw results from `Object.observe` are not\n ordered and must be normalized/merged before notifying)." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "get", "description": "Convenience method for reading a value from a path.\n\nNote, if any part in the path is undefined, this method returns\n`undefined` (this method does not throw when dereferencing undefined\npaths).", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1839, "column": 4 }, "end": { "line": 1841, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to the value\n to read. The path may be specified as a string (e.g. `foo.bar.baz`)\n or an array of path parts (e.g. `['foo.bar', 'baz']`). Note that\n bracketed expressions are not supported; string-based path parts\n *must* be separated by dots. Note that when dereferencing array\n indices, the index may be used as a dotted part directly\n (e.g. `users.12.name` or `['users', 12, 'name']`)." }, { "name": "root", "type": "Object=", "description": "Root object from which the path is evaluated." } ], "return": { "type": "*", "desc": "Value at the path, or `undefined` if any part of the path\n is undefined." }, "inheritedFrom": "PropertyEffects" }, { "name": "set", "description": "Convenience method for setting a value to a path and notifying any\nelements bound to the same path.\n\nNote, if any part in the path except for the last is undefined,\nthis method does nothing (this method does not throw when\ndereferencing undefined paths).", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1865, "column": 4 }, "end": { "line": 1875, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to the value\n to write. The path may be specified as a string (e.g. `'foo.bar.baz'`)\n or an array of path parts (e.g. `['foo.bar', 'baz']`). Note that\n bracketed expressions are not supported; string-based path parts\n *must* be separated by dots. Note that when dereferencing array\n indices, the index may be used as a dotted part directly\n (e.g. `'users.12.name'` or `['users', 12, 'name']`)." }, { "name": "value", "type": "*", "description": "Value to set at the specified path." }, { "name": "root", "type": "Object=", "description": "Root object from which the path is evaluated.\n When specified, no notification will occur." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "push", "description": "Adds items onto the end of the array at the path specified.\n\nThe arguments after `path` and return value match that of\n`Array.prototype.push`.\n\nThis method notifies other paths to the same array that a\nsplice occurred to the array.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1892, "column": 4 }, "end": { "line": 1901, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to array." }, { "name": "items", "type": "...*", "rest": true, "description": "Items to push onto array" } ], "return": { "type": "number", "desc": "New length of the array." }, "inheritedFrom": "PropertyEffects" }, { "name": "pop", "description": "Removes an item from the end of array at the path specified.\n\nThe arguments after `path` and return value match that of\n`Array.prototype.pop`.\n\nThis method notifies other paths to the same array that a\nsplice occurred to the array.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1917, "column": 4 }, "end": { "line": 1926, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to array." } ], "return": { "type": "*", "desc": "Item that was removed." }, "inheritedFrom": "PropertyEffects" }, { "name": "splice", "description": "Starting from the start index specified, removes 0 or more items\nfrom the array and inserts 0 or more new items in their place.\n\nThe arguments after `path` and return value match that of\n`Array.prototype.splice`.\n\nThis method notifies other paths to the same array that a\nsplice occurred to the array.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1946, "column": 4 }, "end": { "line": 1983, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to array." }, { "name": "start", "type": "number", "description": "Index from which to start removing/inserting." }, { "name": "deleteCount", "type": "number=", "description": "Number of items to remove." }, { "name": "items", "type": "...*", "rest": true, "description": "Items to insert into array." } ], "return": { "type": "Array", "desc": "Array of removed items." }, "inheritedFrom": "PropertyEffects" }, { "name": "shift", "description": "Removes an item from the beginning of array at the path specified.\n\nThe arguments after `path` and return value match that of\n`Array.prototype.pop`.\n\nThis method notifies other paths to the same array that a\nsplice occurred to the array.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 1999, "column": 4 }, "end": { "line": 2008, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to array." } ], "return": { "type": "*", "desc": "Item that was removed." }, "inheritedFrom": "PropertyEffects" }, { "name": "unshift", "description": "Adds items onto the beginning of the array at the path specified.\n\nThe arguments after `path` and return value match that of\n`Array.prototype.push`.\n\nThis method notifies other paths to the same array that a\nsplice occurred to the array.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2025, "column": 4 }, "end": { "line": 2033, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "(string | !Array.<(string | number)>)", "description": "Path to array." }, { "name": "items", "type": "...*", "rest": true, "description": "Items to insert info array" } ], "return": { "type": "number", "desc": "New length of the array." }, "inheritedFrom": "PropertyEffects" }, { "name": "notifyPath", "description": "Notify that a path has changed.\n\nExample:\n\n this.item.user.name = 'Bob';\n this.notifyPath('item.user.name');", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2049, "column": 4 }, "end": { "line": 2066, "column": 5 } }, "metadata": {}, "params": [ { "name": "path", "type": "string", "description": "Path that should be notified." }, { "name": "value", "type": "*=", "description": "Value at the path (optional)." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_createReadOnlyProperty", "description": "Equivalent to static `createReadOnlyProperty` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2080, "column": 4 }, "end": { "line": 2087, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" }, { "name": "protectedSetter", "type": "boolean=", "description": "Creates a custom protected setter\n when `true`." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_createPropertyObserver", "description": "Equivalent to static `createPropertyObserver` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2103, "column": 4 }, "end": { "line": 2113, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" }, { "name": "method", "type": "(string | function (*, *))", "description": "Function or name of observer method\n to call" }, { "name": "dynamicFn", "type": "boolean=", "description": "Whether the method name should be included as\n a dependency to the effect." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_createMethodObserver", "description": "Equivalent to static `createMethodObserver` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2127, "column": 4 }, "end": { "line": 2133, "column": 5 } }, "metadata": {}, "params": [ { "name": "expression", "type": "string", "description": "Method expression" }, { "name": "dynamicFn", "type": "(boolean | Object)=", "description": "Boolean or object map indicating\n whether method names should be included as a dependency to the effect." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_createNotifyingProperty", "description": "Equivalent to static `createNotifyingProperty` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2145, "column": 4 }, "end": { "line": 2153, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_createReflectedProperty", "description": "Equivalent to static `createReflectedProperty` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2166, "column": 4 }, "end": { "line": 2179, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Property name" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_createComputedProperty", "description": "Equivalent to static `createComputedProperty` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2194, "column": 4 }, "end": { "line": 2200, "column": 5 } }, "metadata": {}, "params": [ { "name": "property", "type": "string", "description": "Name of computed property to set" }, { "name": "expression", "type": "string", "description": "Method expression" }, { "name": "dynamicFn", "type": "(boolean | Object)=", "description": "Boolean or object map indicating\n whether method names should be included as a dependency to the effect." } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "_marshalArgs", "description": "Gather the argument values for a method specified in the provided array\nof argument metadata.\n\nThe `path` and `value` arguments are used to fill in wildcard descriptor\nwhen the method is being called as a result of a path notification.", "privacy": "private", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2215, "column": 4 }, "end": { "line": 2236, "column": 5 } }, "metadata": {}, "params": [ { "name": "args", "type": "!Array.", "description": "Array of argument metadata" }, { "name": "path", "type": "string", "description": "Property/path name that triggered the method effect" }, { "name": "props", "type": "Object", "description": "Bag of current property changes" } ], "return": { "type": "Array.<*>", "desc": "Array of argument values" }, "inheritedFrom": "PropertyEffects" }, { "name": "_bindTemplate", "description": "Equivalent to static `bindTemplate` API but can be called on\nan instance to add effects at runtime. See that method for\nfull API docs.\n\nThis method may be called on the prototype (for prototypical template\nbinding, to avoid creating accessors every instance) once per prototype,\nand will be called with `runtimeBinding: true` by `_stampTemplate` to\ncreate and link an instance of the template metadata associated with a\nparticular stamping.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2423, "column": 4 }, "end": { "line": 2446, "column": 5 } }, "metadata": {}, "params": [ { "name": "template", "type": "!HTMLTemplateElement", "description": "Template containing binding\n bindings" }, { "name": "instanceBinding", "type": "boolean=", "description": "When false (default), performs\n \"prototypical\" binding of the template and overwrites any previously\n bound template for the class. When true (as passed from\n `_stampTemplate`), the template info is instanced and linked into\n the list of bound templates." } ], "return": { "type": "!TemplateInfo", "desc": "Template metadata object; for `runtimeBinding`,\n this is an instance of the prototypical template info" }, "inheritedFrom": "PropertyEffects" }, { "name": "_removeBoundDom", "description": "Removes and unbinds the nodes previously contained in the provided\nDocumentFragment returned from `_stampTemplate`.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/property-effects.js", "start": { "line": 2527, "column": 4 }, "end": { "line": 2548, "column": 5 } }, "metadata": {}, "params": [ { "name": "dom", "type": "!StampedTemplate", "description": "DocumentFragment previously returned\n from `_stampTemplate` associated with the nodes to be removed" } ], "return": { "type": "void" }, "inheritedFrom": "PropertyEffects" }, { "name": "connectedCallback", "description": "Provides a default implementation of the standard Custom Elements\n`connectedCallback`.\n\nThe default implementation enables the property effects system and\nflushes any pending properties, and updates shimmed CSS properties\nwhen using the ShadyCSS scoping/custom properties polyfill.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 631, "column": 4 }, "end": { "line": 636, "column": 5 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "ElementMixin" }, { "name": "disconnectedCallback", "description": "Called when the element is removed from a document", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/properties-mixin.js", "start": { "line": 230, "column": 3 }, "end": { "line": 234, "column": 4 } }, "metadata": {}, "params": [], "return": { "type": "void" }, "inheritedFrom": "PropertiesMixin" }, { "name": "_attachDom", "description": "Attaches an element's stamped dom to itself. By default,\nthis method creates a `shadowRoot` and adds the dom to it.\nHowever, this method may be overridden to allow an element\nto put its dom in another location.", "privacy": "protected", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 686, "column": 4 }, "end": { "line": 706, "column": 5 } }, "metadata": {}, "params": [ { "name": "dom", "type": "StampedTemplate", "description": "to attach to the element." } ], "return": { "type": "ShadowRoot", "desc": "node to which the dom has been attached." }, "inheritedFrom": "ElementMixin" }, { "name": "updateStyles", "description": "When using the ShadyCSS scoping and custom property shim, causes all\nshimmed styles in this element (and its subtree) to be updated\nbased on current custom property values.\n\nThe optional parameter overrides inline custom property styles with an\nobject of properties where the keys are CSS properties, and the values\nare strings.\n\nExample: `this.updateStyles({'--color': 'blue'})`\n\nThese properties are retained unless a value of `null` is set.\n\nNote: This function does not support updating CSS mixins.\nYou can not dynamically change the value of an `@apply`.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 730, "column": 4 }, "end": { "line": 734, "column": 5 } }, "metadata": {}, "params": [ { "name": "properties", "type": "Object=", "description": "Bag of custom property key/values to\n apply to this element." } ], "return": { "type": "void" }, "inheritedFrom": "ElementMixin" }, { "name": "resolveUrl", "description": "Rewrites a given URL relative to a base URL. The base URL defaults to\nthe original location of the document containing the `dom-module` for\nthis element. This method will return the same URL before and after\nbundling.\n\nNote that this function performs no resolution for URLs that start\nwith `/` (absolute URLs) or `#` (hash identifiers). For general purpose\nURL resolution, use `window.URL`.", "privacy": "public", "sourceRange": { "file": "../@polymer/polymer/lib/mixins/element-mixin.js", "start": { "line": 752, "column": 4 }, "end": { "line": 757, "column": 5 } }, "metadata": {}, "params": [ { "name": "url", "type": "string", "description": "URL to resolve." }, { "name": "base", "type": "string=", "description": "Optional base URL to resolve against, defaults\nto the element's `importPath`" } ], "return": { "type": "string", "desc": "Rewritten URL relative to base" }, "inheritedFrom": "ElementMixin" }, { "name": "toggleSelection", "description": "", "privacy": "public", "sourceRange": { "start": { "line": 58, "column": 2 }, "end": { "line": 61, "column": 3 } }, "metadata": {}, "params": [ { "name": "e" } ], "return": { "type": "void" } } ], "staticMethods": [ { "name": "_parseTemplate", "description": "Scans a template to produce template metadata.\n\nTemplate-specific metadata are stored in the object returned, and node-\nspecific metadata are stored in objects in its flattened `nodeInfoList`\narray. Only nodes in the template that were parsed as nodes of\ninterest contain an object in `nodeInfoList`. Each `nodeInfo` object\ncontains an `index` (`childNodes` index in parent) and optionally\n`parent`, which points to node info of its parent (including its index).\n\nThe template metadata object returned from this method has the following\nstructure (many fields optional):\n\n```js\n {\n // Flattened list of node metadata (for nodes that generated metadata)\n nodeInfoList: [\n {\n // `id` attribute for any nodes with id's for generating `$` map\n id: {string},\n // `on-event=\"handler\"` metadata\n events: [\n {\n name: {string}, // event name\n value: {string}, // handler method name\n }, ...\n ],\n // Notes when the template contained a `` for shady DOM\n // optimization purposes\n hasInsertionPoint: {boolean},\n // For nested `