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