src/cm/media/js/lib/yui/yui3-3.15.0/build/graphics/graphics.js
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 602 e16a97fb364a
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
602
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     1
YUI.add('graphics', function (Y, NAME) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     2
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     3
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     4
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     5
 * <p>The `Graphics` module provides a JavaScript API for creating shapes in a variety of formats across
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     6
 * a <a href="http://developer.yahoo.com/yui/articles/gbs">browser test baseline</a>.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     7
 * Based on device and browser capabilities, `Graphics` leverages <a href="http://www.w3.org/TR/SVG/">SVG</a>,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     8
 * <a href="http://www.w3.org/TR/html5/the-canvas-element.html">Canvas</a> and <a href="http://www.w3.org/TR/NOTE-VML">VML</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
     9
 * to render its graphical elements.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    10
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    11
 * <p>The `Graphics` module features a <a href="../classes/Graphic.html">`Graphic`</a> class that allows you to easily create and manage shapes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    12
 * Currently, a <a href="../classes/Graphic.html">`Graphic`</a> instance can be used to create predifined shapes and free-form polygons with fill
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    13
 * and stroke properties.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    14
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    15
 * <p>The `Graphics` module normalizes an API through the use of alias and implementation classes that share
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    16
 * interfaces. Each alias class points to an appropriate implementation class dependent on the browser's
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    17
 * capabilities. There should rarely, if ever, be a need to interact directly with an implementation class.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    18
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    19
 * <p>Below is a list of available classes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    20
 *     <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    21
 *         <li><a href="../classes/Graphic.html">`Graphic`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    22
 *         <li><a href="../classes/Shape.html">`Shape`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    23
 *         <li><a href="../classes/Circle.html">`Circle`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    24
 *         <li><a href="../classes/Ellipse.html">`Ellipse`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    25
 *         <li><a href="../classes/Rect.html">`Rect`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    26
 *         <li><a href="../classes/Path.html">`Path`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    27
 *     </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    28
 * You can also extend the `Shape` class to create your own custom shape classes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    29
 * @module graphics
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    30
 * @main graphics
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    31
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    32
var SETTER = "setter",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    33
	PluginHost = Y.Plugin.Host,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    34
    VALUE = "value",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    35
    VALUEFN = "valueFn",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    36
    READONLY = "readOnly",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    37
    Y_LANG = Y.Lang,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    38
    STR = "string",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    39
    WRITE_ONCE = "writeOnce",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    40
    GraphicBase,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    41
    AttributeLite;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    42
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    43
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    44
	 * AttributeLite provides Attribute-like getters and setters for shape classes in the Graphics module.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    45
     * It provides a get/set API without the event infastructure. This class is temporary and a work in progress.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    46
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    47
	 * @class AttributeLite
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    48
	 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    49
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    50
    AttributeLite = function()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    51
    {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    52
        var host = this; // help compression
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    53
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    54
        // Perf tweak - avoid creating event literals if not required.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    55
        host._ATTR_E_FACADE = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    56
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    57
        Y.EventTarget.call(this, {emitFacade:true});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    58
        host._state = {};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    59
        host.prototype = Y.mix(AttributeLite.prototype, host.prototype);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    60
    };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    61
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    62
    AttributeLite.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    63
		/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    64
		 * Initializes the attributes for a shape. If an attribute config is passed into the constructor of the host,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    65
		 * the initial values will be overwritten.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    66
		 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    67
		 * @method addAttrs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    68
		 * @param {Object} cfg Optional object containing attributes key value pairs to be set.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    69
		 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    70
		addAttrs: function(cfg)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    71
		{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    72
			var host = this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    73
				attrConfig = this.constructor.ATTRS,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    74
				attr,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    75
				i,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    76
				fn,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    77
				state = host._state;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    78
			for(i in attrConfig)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    79
			{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    80
				if(attrConfig.hasOwnProperty(i))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    81
				{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    82
					attr = attrConfig[i];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    83
					if(attr.hasOwnProperty(VALUE))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    84
					{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    85
						state[i] = attr.value;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    86
					}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    87
					else if(attr.hasOwnProperty(VALUEFN))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    88
					{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    89
						fn = attr.valueFn;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    90
						if(Y_LANG.isString(fn))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    91
						{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    92
							state[i] = host[fn].apply(host);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    93
						}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    94
						else
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    95
						{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    96
							state[i] = fn.apply(host);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    97
						}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    98
					}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
    99
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   100
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   101
			host._state = state;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   102
            for(i in attrConfig)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   103
			{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   104
				if(attrConfig.hasOwnProperty(i))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   105
				{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   106
					attr = attrConfig[i];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   107
                    if(attr.hasOwnProperty(READONLY) && attr.readOnly)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   108
					{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   109
						continue;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   110
					}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   111
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   112
					if(attr.hasOwnProperty(WRITE_ONCE) && attr.writeOnce)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   113
					{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   114
						attr.readOnly = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   115
					}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   116
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   117
					if(cfg && cfg.hasOwnProperty(i))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   118
					{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   119
						if(attr.hasOwnProperty(SETTER))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   120
						{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   121
							host._state[i] = attr.setter.apply(host, [cfg[i]]);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   122
						}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   123
						else
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   124
						{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   125
							host._state[i] = cfg[i];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   126
						}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   127
					}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   128
				}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   129
			}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   130
		},
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   131
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   132
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   133
         * For a given item, returns the value of the property requested, or undefined if not found.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   134
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   135
         * @method get
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   136
         * @param name {String} The name of the item
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   137
         * @return {Any} The value of the supplied property.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   138
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   139
        get: function(attr)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   140
        {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   141
            var host = this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   142
                getter,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   143
                attrConfig = host.constructor.ATTRS;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   144
            if(attrConfig && attrConfig[attr])
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   145
            {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   146
                getter = attrConfig[attr].getter;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   147
                if(getter)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   148
                {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   149
                    if(typeof getter === STR)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   150
                    {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   151
                        return host[getter].apply(host);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   152
                    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   153
                    return attrConfig[attr].getter.apply(host);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   154
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   155
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   156
                return host._state[attr];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   157
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   158
            return null;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   159
        },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   160
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   161
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   162
         * Sets the value of an attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   163
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   164
         * @method set
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   165
         * @param {String|Object} name The name of the attribute. Alternatively, an object of key value pairs can
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   166
         * be passed in to set multiple attributes at once.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   167
         * @param {Any} value The value to set the attribute to. This value is ignored if an object is received as
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   168
         * the name param.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   169
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   170
        set: function()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   171
        {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   172
            var attr = arguments[0],
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   173
                i;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   174
            if(Y_LANG.isObject(attr))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   175
            {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   176
                for(i in attr)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   177
                {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   178
                    if(attr.hasOwnProperty(i))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   179
                    {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   180
                        this._set(i, attr[i]);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   181
                    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   182
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   183
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   184
            else
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   185
            {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   186
                this._set.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   187
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   188
        },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   189
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   190
		/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   191
         * Provides setter logic. Used by `set`.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   192
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   193
         * @method _set
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   194
         * @param {String|Object} name The name of the attribute. Alternatively, an object of key value pairs can
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   195
         * be passed in to set multiple attributes at once.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   196
         * @param {Any} value The value to set the attribute to. This value is ignored if an object is received as
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   197
         * the name param.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   198
		 * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   199
		 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   200
		_set: function(attr, val)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   201
		{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   202
			var host = this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   203
				setter,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   204
				args,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   205
				attrConfig = host.constructor.ATTRS;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   206
			if(attrConfig && attrConfig.hasOwnProperty(attr))
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   207
			{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   208
				setter = attrConfig[attr].setter;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   209
				if(setter)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   210
				{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   211
					args = [val];
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   212
					if(typeof setter === STR)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   213
					{
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   214
						val = host[setter].apply(host, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   215
					}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   216
					else
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   217
                    {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   218
                        val = attrConfig[attr].setter.apply(host, args);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   219
                    }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   220
				}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   221
				host._state[attr] = val;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   222
			}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   223
		}
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   224
	};
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   225
    Y.mix(AttributeLite, Y.EventTarget, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   226
	Y.AttributeLite = AttributeLite;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   227
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   228
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   229
     * GraphicBase serves as the base class for the graphic layer. It serves the same purpose as
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   230
     * Base but uses a lightweight getter/setter class instead of Attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   231
     * This class is temporary and a work in progress.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   232
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   233
     * @class GraphicBase
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   234
     * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   235
     * @param {Object} cfg Key value pairs for attributes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   236
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   237
    GraphicBase = function(cfg)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   238
    {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   239
        var host = this,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   240
            PluginHost = Y.Plugin && Y.Plugin.Host;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   241
        if (host._initPlugins && PluginHost) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   242
            PluginHost.call(host);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   243
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   244
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   245
        host.name = host.constructor.NAME;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   246
        host._eventPrefix = host.constructor.EVENT_PREFIX || host.constructor.NAME;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   247
        AttributeLite.call(host);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   248
        host.addAttrs(cfg);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   249
        host.init.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   250
        if (host._initPlugins) {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   251
            // Need to initPlugins manually, to handle constructor parsing, static Plug parsing
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   252
            host._initPlugins(cfg);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   253
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   254
        host.initialized = true;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   255
    };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   256
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   257
    GraphicBase.NAME = "baseGraphic";
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   258
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   259
    GraphicBase.prototype = {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   260
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   261
         * Init method, invoked during construction.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   262
         * Fires an init event after calling `initializer` on implementers.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   263
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   264
         * @method init
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   265
         * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   266
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   267
        init: function()
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   268
        {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   269
            this.publish("init", {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   270
                fireOnce:true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   271
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   272
            this.initializer.apply(this, arguments);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   273
            this.fire("init", {cfg: arguments[0]});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   274
        },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   275
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   276
        /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   277
         * Camel case concatanates two strings.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   278
         *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   279
         * @method _camelCaseConcat
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   280
         * @param {String} prefix The first string
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   281
         * @param {String} name The second string
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   282
         * @return String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   283
         * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   284
         */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   285
        _camelCaseConcat: function(prefix, name)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   286
        {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   287
            return prefix + name.charAt(0).toUpperCase() + name.slice(1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   288
        }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   289
    };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   290
//Straightup augment, no wrapper functions
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   291
Y.mix(GraphicBase, Y.AttributeLite, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   292
Y.mix(GraphicBase, PluginHost, false, null, 1);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   293
GraphicBase.prototype.constructor = GraphicBase;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   294
GraphicBase.plug = PluginHost.plug;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   295
GraphicBase.unplug = PluginHost.unplug;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   296
Y.GraphicBase = GraphicBase;
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   297
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   298
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   299
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   300
 * `Drawing` provides a set of drawing methods used by `Path` and custom shape classes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   301
 * `Drawing` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   302
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   303
 *      <li><a href="SVGDrawing.html">`SVGDrawing`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   304
 *      <li><a href="VMLDrawing.html">`VMLDrawing`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   305
 *      <li><a href="CanvasDrawing.html">`CanvasDrawing`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   306
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   307
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   308
 * @class Drawing
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   309
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   310
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   311
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   312
     * Draws a bezier curve.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   313
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   314
     * @method curveTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   315
     * @param {Number} cp1x x-coordinate for the first control point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   316
     * @param {Number} cp1y y-coordinate for the first control point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   317
     * @param {Number} cp2x x-coordinate for the second control point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   318
     * @param {Number} cp2y y-coordinate for the second control point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   319
     * @param {Number} x x-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   320
     * @param {Number} y y-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   321
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   322
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   323
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   324
     * Draws a quadratic bezier curve.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   325
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   326
     * @method quadraticCurveTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   327
     * @param {Number} cpx x-coordinate for the control point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   328
     * @param {Number} cpy y-coordinate for the control point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   329
     * @param {Number} x x-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   330
     * @param {Number} y y-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   331
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   332
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   333
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   334
     * Draws a rectangle.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   335
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   336
     * @method drawRect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   337
     * @param {Number} x x-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   338
     * @param {Number} y y-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   339
     * @param {Number} w width
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   340
     * @param {Number} h height
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   341
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   342
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   343
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   344
     * Draws a rectangle with rounded corners.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   345
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   346
     * @method drawRoundRect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   347
     * @param {Number} x x-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   348
     * @param {Number} y y-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   349
     * @param {Number} w width
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   350
     * @param {Number} h height
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   351
     * @param {Number} ew width of the ellipse used to draw the rounded corners
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   352
     * @param {Number} eh height of the ellipse used to draw the rounded corners
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   353
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   354
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   355
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   356
     * Draws a circle.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   357
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   358
     * @method drawCircle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   359
     * @param {Number} x y-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   360
     * @param {Number} y x-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   361
     * @param {Number} r radius
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   362
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   363
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   364
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   365
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   366
     * Draws an ellipse.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   367
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   368
     * @method drawEllipse
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   369
     * @param {Number} x x-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   370
     * @param {Number} y y-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   371
     * @param {Number} w width
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   372
     * @param {Number} h height
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   373
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   374
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   375
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   376
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   377
     * Draws a diamond.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   378
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   379
     * @method drawDiamond
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   380
     * @param {Number} x y-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   381
     * @param {Number} y x-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   382
     * @param {Number} width width
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   383
     * @param {Number} height height
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   384
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   385
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   386
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   387
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   388
     * Draws a wedge.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   389
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   390
     * @method drawWedge
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   391
     * @param {Number} x x-coordinate of the wedge's center point
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   392
     * @param {Number} y y-coordinate of the wedge's center point
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   393
     * @param {Number} startAngle starting angle in degrees
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   394
     * @param {Number} arc sweep of the wedge. Negative values draw clockwise.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   395
     * @param {Number} radius radius of wedge. If [optional] yRadius is defined, then radius is the x radius.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   396
     * @param {Number} yRadius [optional] y radius for wedge.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   397
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   398
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   399
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   400
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   401
     * Draws a line segment using the current line style from the current drawing position to the specified x and y coordinates.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   402
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   403
     * @method lineTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   404
     * @param {Number} point1 x-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   405
     * @param {Number} point2 y-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   406
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   407
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   408
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   409
     * Draws a line segment using the current line style from the current drawing position to the relative x and y coordinates.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   410
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   411
     * @method relativeLineTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   412
     * @param {Number} point1 x-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   413
     * @param {Number} point2 y-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   414
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   415
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   416
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   417
     * Moves the current drawing position to specified x and y coordinates.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   418
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   419
     * @method moveTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   420
     * @param {Number} x x-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   421
     * @param {Number} y y-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   422
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   423
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   424
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   425
     * Moves the current drawing position relative to specified x and y coordinates.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   426
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   427
     * @method relativeMoveTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   428
     * @param {Number} x x-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   429
     * @param {Number} y y-coordinate for the end point.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   430
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   431
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   432
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   433
     * Completes a drawing operation.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   434
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   435
     * @method end
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   436
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   437
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   438
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   439
     * Clears the path.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   440
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   441
     * @method clear
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   442
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   443
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   444
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   445
     * Ends a fill and stroke
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   446
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   447
     * @method closePath
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   448
     * @chainable
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   449
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   450
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   451
 *  <p>Base class for creating shapes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   452
 *  <p>`Shape` is an abstract class and is not meant to be used directly. The following classes extend
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   453
 *  `Shape`.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   454
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   455
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   456
 *      <li><a href="Circle.html">`Circle`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   457
 *      <li><a href="Ellipse.html">`Ellipse`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   458
 *      <li><a href="Rect.html">`Rect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   459
 *      <li><a href="Path.html">`Path`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   460
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   461
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   462
 * `Shape` can also be extended to create custom shape classes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   463
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   464
 * `Shape` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   465
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   466
 *      <li><a href="SVGShape.html">`SVGShape`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   467
 *      <li><a href="VMLShape.html">`VMLShape`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   468
 *      <li><a href="CanvasShape.html">`CanvasShape`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   469
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   470
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   471
 * It is not necessary to interact with these classes directly. `Shape` will point to the appropriate implemention.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   472
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   473
 * @class Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   474
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   475
 * @param {Object} cfg (optional) Attribute configs
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   476
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   477
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   478
     * Init method, invoked during construction.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   479
     * Calls `initializer` method.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   480
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   481
     * @method init
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   482
     * @protected
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   483
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   484
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   485
	 * Initializes the shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   486
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   487
	 * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   488
	 * @method initializer
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   489
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   490
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   491
	 * Add a class name to each node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   492
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   493
	 * @method addClass
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   494
	 * @param {String} className the class name to add to the node's class attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   495
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   496
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   497
	 * Removes a class name from each node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   498
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   499
	 * @method removeClass
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   500
	 * @param {String} className the class name to remove from the node's class attribute
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   501
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   502
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   503
	 * Gets the current position of the node in page coordinates.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   504
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   505
	 * @method getXY
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   506
	 * @return Array The XY position of the shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   507
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   508
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   509
	 * Set the position of the shape in page coordinates, regardless of how the node is positioned.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   510
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   511
	 * @method setXY
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   512
	 * @param {Array} Contains x & y values for new position (coordinates are page-based)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   513
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   514
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   515
	 * Determines whether the node is an ancestor of another HTML element in the DOM hierarchy.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   516
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   517
	 * @method contains
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   518
	 * @param {Shape | HTMLElement} needle The possible node or descendent
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   519
	 * @return Boolean Whether or not this shape is the needle or its ancestor.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   520
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   521
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   522
	 * Compares nodes to determine if they match.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   523
	 * Node instances can be compared to each other and/or HTMLElements.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   524
	 * @method compareTo
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   525
	 * @param {HTMLElement | Node} refNode The reference node to compare to the node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   526
	 * @return {Boolean} True if the nodes match, false if they do not.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   527
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   528
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   529
	 * Test if the supplied node matches the supplied selector.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   530
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   531
	 * @method test
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   532
	 * @param {String} selector The CSS selector to test against.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   533
	 * @return Boolean Wheter or not the shape matches the selector.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   534
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   535
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   536
     * Sets the value of an attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   537
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   538
     * @method set
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   539
     * @param {String|Object} name The name of the attribute. Alternatively, an object of key value pairs can
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   540
     * be passed in to set multiple attributes at once.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   541
     * @param {Any} value The value to set the attribute to. This value is ignored if an object is received as
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   542
     * the name param.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   543
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   544
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   545
	 * Specifies a 2d translation.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   546
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   547
	 * @method translate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   548
	 * @param {Number} x The value to transate on the x-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   549
	 * @param {Number} y The value to translate on the y-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   550
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   551
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   552
	 * Translates the shape along the x-axis. When translating x and y coordinates,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   553
	 * use the `translate` method.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   554
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   555
	 * @method translateX
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   556
	 * @param {Number} x The value to translate.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   557
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   558
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   559
	 * Translates the shape along the y-axis. When translating x and y coordinates,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   560
	 * use the `translate` method.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   561
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   562
	 * @method translateY
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   563
	 * @param {Number} y The value to translate.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   564
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   565
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   566
     * Skews the shape around the x-axis and y-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   567
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   568
     * @method skew
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   569
     * @param {Number} x The value to skew on the x-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   570
     * @param {Number} y The value to skew on the y-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   571
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   572
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   573
	 * Skews the shape around the x-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   574
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   575
	 * @method skewX
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   576
	 * @param {Number} x x-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   577
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   578
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   579
	 * Skews the shape around the y-axis.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   580
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   581
	 * @method skewY
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   582
	 * @param {Number} y y-coordinate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   583
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   584
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   585
	 * Rotates the shape clockwise around it transformOrigin.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   586
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   587
	 * @method rotate
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   588
	 * @param {Number} deg The degree of the rotation.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   589
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   590
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   591
	 * Specifies a 2d scaling operation.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   592
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   593
	 * @method scale
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   594
	 * @param {Number} val
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   595
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   596
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   597
	 * Returns the bounds for a shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   598
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   599
     * Calculates the a new bounding box from the original corner coordinates (base on size and position) and the transform matrix.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   600
     * The calculated bounding box is used by the graphic instance to calculate its viewBox.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   601
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   602
	 * @method getBounds
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   603
	 * @return Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   604
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   605
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   606
     * Destroys the instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   607
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   608
     * @method destroy
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   609
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   610
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   611
	 * An array of x, y values which indicates the transformOrigin in which to rotate the shape. Valid values range between 0 and 1 representing a
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   612
	 * fraction of the shape's corresponding bounding box dimension. The default value is [0.5, 0.5].
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   613
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   614
	 * @config transformOrigin
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   615
	 * @type Array
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   616
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   617
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   618
     * <p>A string containing, in order, transform operations applied to the shape instance. The `transform` string can contain the following values:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   619
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   620
     *    <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   621
     *        <dt>rotate</dt><dd>Rotates the shape clockwise around it transformOrigin.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   622
     *        <dt>translate</dt><dd>Specifies a 2d translation.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   623
     *        <dt>skew</dt><dd>Skews the shape around the x-axis and y-axis.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   624
     *        <dt>scale</dt><dd>Specifies a 2d scaling operation.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   625
     *        <dt>translateX</dt><dd>Translates the shape along the x-axis.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   626
     *        <dt>translateY</dt><dd>Translates the shape along the y-axis.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   627
     *        <dt>skewX</dt><dd>Skews the shape around the x-axis.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   628
     *        <dt>skewY</dt><dd>Skews the shape around the y-axis.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   629
     *        <dt>matrix</dt><dd>Specifies a 2D transformation matrix comprised of the specified six values.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   630
     *    </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   631
     * </p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   632
     * <p>Applying transforms through the transform attribute will reset the transform matrix and apply a new transform. The shape class also contains
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   633
     * corresponding methods for each transform that will apply the transform to the current matrix. The below code illustrates how you might use the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   634
     * `transform` attribute to instantiate a recangle with a rotation of 45 degrees.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   635
            var myRect = new Y.Rect({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   636
                type:"rect",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   637
                width: 50,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   638
                height: 40,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   639
                transform: "rotate(45)"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   640
            };
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   641
     * <p>The code below would apply `translate` and `rotate` to an existing shape.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   642
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   643
        myRect.set("transform", "translate(40, 50) rotate(45)");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   644
	 * @config transform
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   645
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   646
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   647
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   648
	 * Unique id for class instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   649
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   650
	 * @config id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   651
	 * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   652
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   653
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   654
	 * Indicates the x position of shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   655
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   656
	 * @config x
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   657
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   658
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   659
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   660
	 * Indicates the y position of shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   661
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   662
	 * @config y
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   663
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   664
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   665
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   666
	 * Indicates the width of the shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   667
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   668
	 * @config width
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   669
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   670
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   671
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   672
	 * Indicates the height of the shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   673
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   674
	 * @config height
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   675
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   676
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   677
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   678
	 * Indicates whether the shape is visible.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   679
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   680
	 * @config visible
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   681
	 * @type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   682
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   683
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   684
	 * Contains information about the fill of the shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   685
     *  <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   686
     *      <dt>color</dt><dd>The color of the fill.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   687
     *      <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the fill. The default value is 1.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   688
     *      <dt>type</dt><dd>Type of fill.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   689
     *          <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   690
     *              <dt>solid</dt><dd>Solid single color fill. (default)</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   691
     *              <dt>linear</dt><dd>Linear gradient fill.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   692
     *              <dt>radial</dt><dd>Radial gradient fill.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   693
     *          </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   694
     *      </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   695
     *  </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   696
     *  <p>If a `linear` or `radial` is specified as the fill type. The following additional property is used:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   697
     *  <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   698
     *      <dt>stops</dt><dd>An array of objects containing the following properties:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   699
     *          <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   700
     *              <dt>color</dt><dd>The color of the stop.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   701
     *              <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stop. The default value is 1.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   702
     *              Note: No effect for IE 6 - 8</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   703
     *              <dt>offset</dt><dd>Number between 0 and 1 indicating where the color stop is positioned.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   704
     *          </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   705
     *      </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   706
     *      <p>Linear gradients also have the following property:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   707
     *      <dt>rotation</dt><dd>Linear gradients flow left to right by default. The rotation property allows you to change the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   708
     *      flow by rotation. (e.g. A rotation of 180 would make the gradient pain from right to left.)</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   709
     *      <p>Radial gradients have the following additional properties:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   710
     *      <dt>r</dt><dd>Radius of the gradient circle.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   711
     *      <dt>fx</dt><dd>Focal point x-coordinate of the gradient.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   712
     *      <dt>fy</dt><dd>Focal point y-coordinate of the gradient.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   713
     *      <dt>cx</dt><dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   714
     *          <p>The x-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   715
     *          <p><strong>Note: </strong>Currently, this property is not implemented for corresponding `CanvasShape` and
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   716
     *          `VMLShape` classes which are used on Android or IE 6 - 8.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   717
     *      </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   718
     *      <dt>cy</dt><dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   719
     *          <p>The y-coordinate of the center of the gradient circle. Determines where the color stop begins. The default value 0.5.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   720
     *          <p><strong>Note: </strong>Currently, this property is not implemented for corresponding `CanvasShape` and `VMLShape`
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   721
     *          classes which are used on Android or IE 6 - 8.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   722
     *      </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   723
     *  </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   724
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   725
	 * @config fill
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   726
	 * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   727
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   728
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   729
	 * Contains information about the stroke of the shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   730
     *  <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   731
     *      <dt>color</dt><dd>The color of the stroke.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   732
     *      <dt>weight</dt><dd>Number that indicates the width of the stroke.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   733
     *      <dt>opacity</dt><dd>Number between 0 and 1 that indicates the opacity of the stroke. The default value is 1.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   734
     *      <dt>dashstyle</dt>Indicates whether to draw a dashed stroke. When set to "none", a solid stroke is drawn. When set
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   735
     *      to an array, the first index indicates the length of the dash. The second index indicates the length of gap.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   736
     *      <dt>linecap</dt><dd>Specifies the linecap for the stroke. The following values can be specified:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   737
     *          <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   738
     *              <dt>butt (default)</dt><dd>Specifies a butt linecap.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   739
     *              <dt>square</dt><dd>Specifies a sqare linecap.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   740
     *              <dt>round</dt><dd>Specifies a round linecap.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   741
     *          </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   742
     *      </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   743
     *      <dt>linejoin</dt><dd>Specifies a linejoin for the stroke. The following values can be specified:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   744
     *          <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   745
     *              <dt>round (default)</dt><dd>Specifies that the linejoin will be round.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   746
     *              <dt>bevel</dt><dd>Specifies a bevel for the linejoin.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   747
     *              <dt>miter limit</dt><dd>An integer specifying the miter limit of a miter linejoin. If you want to specify a linejoin
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   748
     *              of miter, you simply specify the limit as opposed to having separate miter and miter limit values.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   749
     *          </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   750
     *      </dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   751
     *  </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   752
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   753
	 * @config stroke
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   754
	 * @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   755
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   756
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   757
	 * Dom node for the shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   758
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   759
	 * @config node
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   760
	 * @type HTMLElement
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   761
	 * @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   762
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   763
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   764
     * Represents an SVG Path string. This will be parsed and added to shape's API to represent the SVG data across all
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   765
     * implementations. Note that when using VML or SVG implementations, part of this content will be added to the DOM using
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   766
     * respective VML/SVG attributes. If your content comes from an untrusted source, you will need to ensure that no
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   767
     * malicious code is included in that content.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   768
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   769
     * @config data
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   770
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   771
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   772
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   773
	 * Reference to the parent graphic instance
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   774
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   775
	 * @config graphic
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   776
	 * @type Graphic
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   777
	 * @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   778
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   779
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   780
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   781
 * <p>Creates circle shape with editable attributes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   782
 * <p>`Circle` instances can be created using the <a href="Graphic.html#method_addShape">`addShape`</a> method of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   783
 * <a href="Graphic.html">`Graphic`</a> class. The method's `cfg` argument contains a `type` attribute. Assigning "circle"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   784
 * or `Y.Circle` to this attribute will create a `Circle` instance. Required attributes for instantiating a `Circle` are
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   785
 * `type` and `radius`. Optional attributes include:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   786
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   787
 *      <li><a href="#attr_fill">fill</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   788
 *      <li><a href="#attr_id">id</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   789
 *      <li><a href="#attr_stroke">stroke</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   790
 *      <li><a href="#attr_transform">transform</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   791
 *      <li><a href="#attr_transformOrigin">transformOrigin</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   792
 *      <li><a href="#attr_visible">visible</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   793
 *      <li><a href="#attr_x">x</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   794
 *      <li><a href="#attr_y">y</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   795
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   796
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   797
 * The below code creates a circle by defining the `type` attribute as "circle":</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   798
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   799
        var myCircle = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   800
            type: "circle",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   801
            radius: 10,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   802
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   803
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   804
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   805
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   806
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   807
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   808
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   809
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   810
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   811
 * Below, this same circle is created by defining the `type` attribute with a class reference:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   812
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   813
        var myCircle = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   814
            type: Y.Circle,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   815
            radius: 10,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   816
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   817
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   818
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   819
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   820
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   821
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   822
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   823
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   824
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   825
 * <p>`Circle` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   826
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   827
 *      <li><a href="SVGCircle.html">`SVGCircle`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   828
 *      <li><a href="VMLCircle.html">`VMLCircle`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   829
 *      <li><a href="CanvasCircle.html">`CanvasCircle`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   830
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   831
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   832
 * It is not necessary to interact with these classes directly. `Circle` will point to the appropriate implemention.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   833
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   834
 * @class Circle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   835
 * @extends Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   836
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   837
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   838
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   839
     * Radius of the circle
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   840
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   841
     * @config radius
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   842
     * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   843
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   844
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   845
 * <p>Creates an ellipse shape with editable attributes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   846
 * <p>`Ellipse` instances can be created using the <a href="Graphic.html#method_addShape">`addShape`</a> method of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   847
 * <a href="Graphic.html">`Graphic`</a> class. The method's `cfg` argument contains a `type` attribute. Assigning "ellipse"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   848
 * or `Y.Ellipse` to this attribute will create a `Ellipse` instance. Required attributes for instantiating a `Ellipse` are
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   849
 * `type`, `width` and `height`. Optional attributes include:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   850
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   851
 *      <li><a href="#attr_fill">fill</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   852
 *      <li><a href="#attr_id">id</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   853
 *      <li><a href="#attr_stroke">stroke</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   854
 *      <li><a href="#attr_transform">transform</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   855
 *      <li><a href="#attr_transformOrigin">transformOrigin</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   856
 *      <li><a href="#attr_visible">visible</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   857
 *      <li><a href="#attr_x">x</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   858
 *      <li><a href="#attr_y">y</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   859
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   860
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   861
 * The below code creates an ellipse by defining the `type` attribute as "ellipse":</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   862
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   863
        var myEllipse = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   864
            type: "ellipse",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   865
            width: 20,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   866
            height: 10,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   867
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   868
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   869
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   870
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   871
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   872
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   873
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   874
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   875
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   876
 * Below, the same ellipse is created by defining the `type` attribute with a class reference:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   877
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   878
        var myEllipse = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   879
            type: Y.Ellipse,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   880
            width: 20,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   881
            height: 10,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   882
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   883
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   884
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   885
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   886
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   887
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   888
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   889
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   890
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   891
 * <p>`Ellipse` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   892
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   893
 *      <li><a href="SVGEllipse.html">`SVGEllipse`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   894
 *      <li><a href="VMLEllipse.html">`VMLEllipse`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   895
 *      <li><a href="CanvasEllipse.html">`CanvasEllipse`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   896
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   897
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   898
 * It is not necessary to interact with these classes directly. `Ellipse` will point to the appropriate implemention.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   899
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   900
 * @class Ellipse
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   901
 * @extends Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   902
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   903
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   904
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   905
 * <p>Creates an rectangle shape with editable attributes.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   906
 * <p>`Rect` instances can be created using the <a href="Graphic.html#method_addShape">`addShape`</a> method of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   907
 * <a href="Graphic.html">`Graphic`</a> class. The method's `cfg` argument contains a `type` attribute. Assigning "rect"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   908
 * or `Y.Rect` to this attribute will create a `Rect` instance. Required attributes for instantiating a `Rect` are `type`,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   909
 * `width` and `height`. Optional attributes include:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   910
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   911
 *      <li><a href="#attr_fill">fill</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   912
 *      <li><a href="#attr_id">id</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   913
 *      <li><a href="#attr_stroke">stroke</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   914
 *      <li><a href="#attr_transform">transform</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   915
 *      <li><a href="#attr_transformOrigin">transformOrigin</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   916
 *      <li><a href="#attr_visible">visible</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   917
 *      <li><a href="#attr_x">x</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   918
 *      <li><a href="#attr_y">y</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   919
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   920
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   921
 * The below code creates a rectangle by defining the `type` attribute as "rect":</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   922
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   923
        var myRect = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   924
            type: "rect",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   925
            width: 20,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   926
            height: 10,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   927
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   928
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   929
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   930
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   931
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   932
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   933
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   934
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   935
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   936
 * Below, the same rectangle is created by defining the `type` attribute with a class reference:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   937
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   938
        var myRect = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   939
            type: Y.Rect,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   940
            width: 20,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   941
            height: 10,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   942
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   943
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   944
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   945
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   946
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   947
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   948
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   949
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   950
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   951
 * <p>`Rect` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   952
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   953
 *      <li><a href="SVGRect.html">`SVGRect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   954
 *      <li><a href="VMLRect.html">`VMLRect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   955
 *      <li><a href="CanvasRect.html">`CanvasRect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   956
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   957
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   958
 * It is not necessary to interact with these classes directly. `Rect` will point to the appropriate implemention.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   959
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   960
 * @class Rect
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   961
 * @extends Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   962
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   963
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   964
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   965
 * <p>The `Path` class creates a shape through the use of drawing methods. The `Path` class has the following drawing methods available:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   966
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   967
 *      <li><a href="#method_clear">`clear`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   968
 *      <li><a href="#method_curveTo">`curveTo`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   969
 *      <li><a href="#method_drawRect">`drawRect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   970
 *      <li><a href="#method_drawRoundRect">`drawRoundRect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   971
 *      <li><a href="#method_end">`end`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   972
 *      <li><a href="#method_lineTo">`lineTo`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   973
 *      <li><a href="#method_moveTo">`moveTo`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   974
 *      <li><a href="#method_quadraticCurveTo">`quadraticCurveTo`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   975
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   976
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   977
 *  <p>Like other shapes, `Path` elements are created using the <a href="Graphic.html#method_addShape">`addShape`</a>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   978
 *  method of the <a href="Graphic.html">`Graphic`</a> class. The method's `cfg` argument contains a `type` attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   979
 *  Assigning "path" or `Y.Path` to this attribute will create a `Path` instance. After instantiation, a series of drawing
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   980
 *  operations must be performed in order to render a shape. The below code instantiates a path element by defining the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   981
 *  `type` attribute as "path":</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   982
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   983
        var myPath = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   984
            type: "path",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   985
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   986
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   987
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   988
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   989
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   990
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   991
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   992
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   993
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   994
 * Below a `Path` element with the same properties is instantiated by defining the `type` attribute with a class reference:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   995
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   996
        var myPath = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   997
            type: Y.Path,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   998
            fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
   999
                color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1000
            },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1001
            stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1002
                weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1003
                color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1004
            }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1005
        });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1006
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1007
 * After instantiation, a shape or segment needs to be drawn for an element to render. After all draw operations are performed,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1008
 * the <a href="#method_end">`end`</a> method will render the shape. The code below will draw a triangle:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1009
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1010
        myPath.moveTo(35, 5);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1011
        myPath.lineTo(65, 65);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1012
        myPath.lineTo(5, 65);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1013
        myPath.lineTo(35, 5);
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1014
        myPath.end();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1015
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1016
 * <p>`Path` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1017
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1018
 *      <li><a href="SVGPath.html">`SVGPath`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1019
 *      <li><a href="VMLPath.html">`VMLPath`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1020
 *      <li><a href="CanvasPath.html">`CanvasPath`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1021
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1022
 * It is not necessary to interact with these classes directly. `Path` will point to the appropriate implemention.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1023
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1024
 * @class Path
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1025
 * @extends Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1026
 * @uses Drawing
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1027
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1028
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1029
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1030
	 * Indicates the path used for the node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1031
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1032
	 * @config path
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1033
	 * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1034
     * @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1035
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1036
/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1037
 * `Graphic` acts a factory and container for shapes. You need at least one `Graphic` instance to create shapes for your application.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1038
 * <p>The code block below creates a `Graphic` instance and appends it to an HTMLElement with the id 'mygraphiccontainer'.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1039
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1040
        var myGraphic = new Y.Graphic({render:"#mygraphiccontainer"});
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1041
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1042
 * <p>Alternatively, you can add a `Graphic` instance to the DOM using the <a href="#method_render">`render`</a> method.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1043
        var myGraphic = new Y.Graphic();
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1044
        myGraphic.render("#mygraphiccontainer");
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1045
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1046
 * `Graphic` has the following implementations based on browser capability.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1047
 *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1048
 *      <li><a href="SVGGraphic.html">`SVGGraphic`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1049
 *      <li><a href="VMLGraphic.html">`VMLGraphic`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1050
 *      <li><a href="CanvasGraphic.html">`CanvasGraphic`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1051
 *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1052
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1053
 * It is not necessary to interact with these classes directly. `Graphic` will point to the appropriate implemention.</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1054
 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1055
 * @class Graphic
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1056
 * @constructor
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1057
 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1058
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1059
     * Whether or not to render the `Graphic` automatically after to a specified parent node after init. This can be a Node
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1060
     * instance or a CSS selector string.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1061
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1062
     * @config render
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1063
     * @type Node | String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1064
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1065
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1066
	 * Unique id for class instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1067
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1068
	 * @config id
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1069
	 * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1070
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1071
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1072
     * Key value pairs in which a shape instance is associated with its id.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1073
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1074
     *  @config shapes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1075
     *  @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1076
     *  @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1077
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1078
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1079
     *  Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1080
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1081
     *  @config contentBounds
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1082
     *  @type Object
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1083
     *  @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1084
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1085
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1086
     *  The html element that represents to coordinate system of the Graphic instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1087
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1088
     *  @config node
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1089
     *  @type HTMLElement
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1090
     *  @readOnly
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1091
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1092
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1093
	 * Indicates the width of the `Graphic`.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1094
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1095
	 * @config width
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1096
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1097
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1098
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1099
	 * Indicates the height of the `Graphic`.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1100
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1101
	 * @config height
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1102
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1103
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1104
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1105
     *  Determines the sizing of the Graphic.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1106
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1107
     *  <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1108
     *      <dt>sizeContentToGraphic</dt><dd>The Graphic's width and height attributes are, either explicitly set through the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1109
     *      <code>width</code> and <code>height</code> attributes or are determined by the dimensions of the parent element. The
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1110
     *      content contained in the Graphic will be sized to fit with in the Graphic instance's dimensions. When using this
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1111
     *      setting, the <code>preserveAspectRatio</code> attribute will determine how the contents are sized.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1112
     *      <dt>sizeGraphicToContent</dt><dd>(Also accepts a value of true) The Graphic's width and height are determined by the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1113
     *      size and positioning of the content.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1114
     *      <dt>false</dt><dd>The Graphic's width and height attributes are, either explicitly set through the <code>width</code>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1115
     *      and <code>height</code> attributes or are determined by the dimensions of the parent element. The contents of the
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1116
     *      Graphic instance are not affected by this setting.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1117
     *  </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1118
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1119
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1120
     *  @config autoSize
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1121
     *  @type Boolean | String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1122
     *  @default false
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1123
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1124
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1125
     * Determines how content is sized when <code>autoSize</code> is set to <code>sizeContentToGraphic</code>.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1126
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1127
     *  <dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1128
     *      <dt>none<dt><dd>Do not force uniform scaling. Scale the graphic content of the given element non-uniformly if necessary
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1129
     *      such that the element's bounding box exactly matches the viewport rectangle.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1130
     *      <dt>xMinYMin</dt><dd>Force uniform scaling position along the top left of the Graphic's node.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1131
     *      <dt>xMidYMin</dt><dd>Force uniform scaling horizontally centered and positioned at the top of the Graphic's node.<dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1132
     *      <dt>xMaxYMin</dt><dd>Force uniform scaling positioned horizontally from the right and vertically from the top.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1133
     *      <dt>xMinYMid</dt>Force uniform scaling positioned horizontally from the left and vertically centered.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1134
     *      <dt>xMidYMid (the default)</dt><dd>Force uniform scaling with the content centered.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1135
     *      <dt>xMaxYMid</dt><dd>Force uniform scaling positioned horizontally from the right and vertically centered.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1136
     *      <dt>xMinYMax</dt><dd>Force uniform scaling positioned horizontally from the left and vertically from the bottom.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1137
     *      <dt>xMidYMax</dt><dd>Force uniform scaling horizontally centered and position vertically from the bottom.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1138
     *      <dt>xMaxYMax</dt><dd>Force uniform scaling positioned horizontally from the right and vertically from the bottom.</dd>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1139
     *  </dl>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1140
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1141
     * @config preserveAspectRatio
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1142
     * @type String
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1143
     * @default xMidYMid
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1144
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1145
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1146
     * The contentBounds will resize to greater values but not to smaller values. (for performance)
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1147
     * When resizing the contentBounds down is desirable, set the resizeDown value to true.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1148
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1149
     * @config resizeDown
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1150
     * @type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1151
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1152
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1153
	 * Indicates the x-coordinate for the instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1154
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1155
	 * @config x
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1156
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1157
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1158
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1159
	 * Indicates the y-coordinate for the instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1160
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1161
	 * @config y
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1162
	 * @type Number
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1163
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1164
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1165
     * Indicates whether or not the instance will automatically redraw after a change is made to a shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1166
     * This property will get set to false when batching operations.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1167
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1168
     * @config autoDraw
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1169
     * @type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1170
     * @default true
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1171
     * @private
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1172
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1173
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1174
	 * Indicates whether the `Graphic` and its children are visible.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1175
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1176
	 * @config visible
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1177
	 * @type Boolean
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1178
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1179
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1180
     * Gets the current position of the graphic instance in page coordinates.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1181
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1182
     * @method getXY
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1183
     * @return Array The XY position of the shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1184
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1185
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1186
     * Adds the graphics node to the dom.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1187
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1188
     * @method render
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1189
     * @param {Node|String} parentNode node in which to render the graphics node into.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1190
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1191
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1192
     * Removes all nodes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1193
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1194
     * @method destroy
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1195
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1196
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1197
     * <p>Generates a shape instance by type. The method accepts an object that contain's the shape's
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1198
     * type and attributes to be customized. For example, the code below would create a rectangle:</p>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1199
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1200
            var myRect = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1201
                type: "rect",
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1202
                width: 40,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1203
                height: 30,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1204
                fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1205
                    color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1206
                },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1207
                stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1208
                    weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1209
                    color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1210
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1211
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1212
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1213
     * <p>The `Graphics` module includes a few basic shapes. More information on their creation
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1214
     * can be found in each shape's documentation:
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1215
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1216
     *  <ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1217
     *      <li><a href="Circle.html">`Circle`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1218
     *      <li><a href="Ellipse.html">`Ellipse`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1219
     *      <li><a href="Rect.html">`Rect`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1220
     *      <li><a href="Path.html">`Path`</a></li>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1221
     *  </ul>
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1222
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1223
     *  The `Graphics` module also allows for the creation of custom shapes. If a custom shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1224
     *  has been created, it can be instantiated with the `addShape` method as well. The attributes,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1225
     *  required and optional, would need to be defined in the custom shape.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1226
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1227
            var myCustomShape = myGraphic.addShape({
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1228
                type: Y.MyCustomShape,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1229
                width: 50,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1230
                height: 50,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1231
                fill: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1232
                    color: "#9aa"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1233
                },
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1234
                stroke: {
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1235
                    weight: 1,
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1236
                    color: "#000"
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1237
                }
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1238
            });
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1239
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1240
     * @method addShape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1241
     * @param {Object} cfg Object containing the shape's type and attributes.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1242
     * @return Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1243
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1244
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1245
     * Removes a shape instance from from the graphic instance.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1246
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1247
     * @method removeShape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1248
     * @param {Shape|String} shape The instance or id of the shape to be removed.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1249
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1250
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1251
     * Removes all shape instances from the dom.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1252
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1253
     * @method removeAllShapes
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1254
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1255
    /**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1256
     * Returns a shape based on the id of its dom node.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1257
     *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1258
     * @method getShapeById
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1259
     * @param {String} id Dom id of the shape's node attribute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1260
     * @return Shape
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1261
     */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1262
	/**
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1263
	 * Allows for creating multiple shapes in order to batch appending and redraw operations.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1264
	 *
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1265
	 * @method batch
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1266
	 * @param {Function} method Method to execute.
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1267
	 */
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1268
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1269
e16a97fb364a Use YUI 3.15
gibus
parents:
diff changeset
  1270
}, '@VERSION@', {"requires": ["node", "event-custom", "pluginhost", "matrix", "classnamemanager"]});