{ "type": "class", | |
"qname": "mx.charts.effects.SeriesEffect", | |
"baseClassname": "mx.effects.TweenEffect" | |
, | |
"description": "The base class for chart effects. <p>The <code><mx:SeriesEffect></code> tag inherits the tag attributes of its superclass, and adds the following tag attributes:</p> <pre>\\n <mx:<i>tagname</i>\\n <strong>Properties</strong>\\n elementOffset="20"\\n minimumElementDuration="0"\\n offset="0"\\n type="show|hide <i>(Default value is set by chart)</i>"\\n >\\n </pre>", | |
"tags": [ | |
{ "tagName": "mxml", | |
"values": []}, | |
{ "tagName": "playerversion", | |
"values": ["Flash 9", "AIR 1.1"]}, | |
{ "tagName": "productversion", | |
"values": ["Flex 3"]}, | |
{ "tagName": "langversion", | |
"values": ["3.0"]} ], | |
"members": [ | |
{ "type": "method", | |
"qname": "mx.charts.effects.SeriesEffect", | |
"namespace": "", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Constructor.", | |
"tags": [ | |
{ "tagName": "param", | |
"values": ["target The target of the effect."]}, | |
{ "tagName": "playerversion", | |
"values": ["Flash 9", "AIR 1.1"]}, | |
{ "tagName": "productversion", | |
"values": ["Flex 3"]}, | |
{ "tagName": "langversion", | |
"values": ["3.0"]} ], | |
"return": "", | |
"params": [{ "name": "target", "type": "Object"}]} | |
, | |
{ "type": "accessor", | |
"access": "read-write", | |
"return": "Number", | |
"qname": "elementOffset", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Specifies the amount of time, in milliseconds, that Flex delays the start of the effect on each element in the series. <p>Set <code>elementOffset</code> to <code>0</code> to affect all elements of the series at the same time. They start the effect at the same time and end it at the same time.</p> <p>Set <code>elementOffset</code> to a positive integer (such as <code>30</code>) to stagger the effect on each element by that amount of time. For example, with a slide effect, the first element slides in immediately, then the next element begins 30 milliseconds later, and so on. The amount of time for the effect to execute is the same for each element, but the overall duration of the effect is longer.</p> <p>Set <code>elementOffset</code> to a negative value to have the effect begin from the last element and move backwards through the list.</p> <p>The default is <code>20</code>.</p>", | |
"tags": [ | |
{ "tagName": "playerversion", | |
"values": ["Flash 9", "AIR 1.1"]}, | |
{ "tagName": "productversion", | |
"values": ["Flex 3"]}, | |
{ "tagName": "langversion", | |
"values": ["3.0"]} ]}, | |
{ "type": "accessor", | |
"access": "read-write", | |
"return": "Number", | |
"qname": "minimumElementDuration", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Specifies the amount of time, in milliseconds, that an individual element should take to complete the effect. <p>Charts with a variable number of data points in the series cannot reliably create smooth effects with only the <code>duration</code> property. For example, an effect with a <code>duration</code> of <code>1000</code> and an <code>elementOffset</code> of <code>100</code> takes 900 milliseconds per element to complete an effect if you have two elements in the series. This is because the start of each effect is offset by 100 and each effect finishes in 1000 milliseconds.</p> <p>If there are four elements in the series, each element takes 700 milliseconds to complete (the last effect starts 300 milliseconds after the first and must be completed within 1000 milliseconds). With 10 elements, each element has only 100 milliseconds</p> to complete the effect. <p>The <code>minimumElementDuration</code> value sets a minimal duration for each element. No element of the series takes less than this amount of time (in milliseconds) to execute the effect, regardless of the number of elements in the series and the value of the <code>duration</code> property. As a result, it is possible for an effect to take longer than a specified <code>duration</code> if at least two of the following three properties are specified: <code>duration</code>, <code>offset</code>, and <code>minimumElementDuration</code>.</p> <p>The default is <code>0</code>.</p>", | |
"tags": [ | |
{ "tagName": "playerversion", | |
"values": ["Flash 9", "AIR 1.1"]}, | |
{ "tagName": "productversion", | |
"values": ["Flex 3"]}, | |
{ "tagName": "langversion", | |
"values": ["3.0"]} ]}, | |
{ "type": "accessor", | |
"access": "read-write", | |
"return": "Number", | |
"qname": "offset", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "Specifies the amount of time, in milliseconds, that Flex delays the effect. <p>Use this property to stagger effects on multiple series.</p> <p>The default is <code>0</code>.</p>", | |
"tags": [ | |
{ "tagName": "playerversion", | |
"values": ["Flash 9", "AIR 1.1"]}, | |
{ "tagName": "productversion", | |
"values": ["Flex 3"]}, | |
{ "tagName": "langversion", | |
"values": ["3.0"]} ]}, | |
{ "type": "accessor", | |
"access": "read-write", | |
"return": "String", | |
"qname": "type", | |
"namespace": "public", | |
"bindable": [], | |
"details": [], | |
"deprecated": {}, | |
"description": "The type of transition this effect is being used for. Some series effects define different behavior based on whether they are being used during the show or hide portion of a chart transition. The SeriesSlide effect, for example, slides elements from their position off screen when this property is set to <code>hide</code>, and on screen when this property is set to <code>show</code>. This property is set by the chart, based on whether the effect as assigned to the ShowDataEffect or HideDataEffect style.", | |
"tags": [ | |
{ "tagName": "playerversion", | |
"values": ["Flash 9", "AIR 1.1"]}, | |
{ "tagName": "productversion", | |
"values": ["Flex 3"]}, | |
{ "tagName": "langversion", | |
"values": ["3.0"]} ]}] | |
} |