UNPKG

1.27 kBJavaScriptView Raw
1/**
2 * @externs
3 * @fileoverview Externs for Polymer.Iconset.
4 */
5
6/**
7 * The interface that iconsets should obey. Iconsets are registered by setting
8 * their name in the IronMeta 'iconset' db, and a value of type Polymer.Iconset.
9 *
10 * Used by iron-icon but needs to live here since iron-icon, iron-iconset, etc don't
11 * depend on each other at all and talk only through iron-meta.
12 *
13 * @interface
14 */
15Polymer.Iconset = function() {};
16
17/**
18 * Applies an icon to the given element as a css background image. This
19 * method does not size the element, and it's usually necessary to set
20 * the element's height and width so that the background image is visible.
21 *
22 * @param {Element} element The element to which the icon is applied.
23 * @param {string} icon The name of the icon to apply.
24 * @param {string=} theme (optional) The name or index of the icon to apply.
25 * @param {number=} scale (optional, defaults to 1) Icon scaling factor.
26 */
27Polymer.Iconset.prototype.applyIcon = function(
28 element, icon, theme, scale) {};
29
30/**
31 * Remove an icon from the given element by undoing the changes effected
32 * by `applyIcon`.
33 *
34 * @param {Element} element The element from which the icon is removed.
35 */
36Polymer.Iconset.prototype.removeIcon = function(element) {};