Series  - AS3 Flex

Specifies a method that returns the value that should be used for positioning the current chart item in the series. If this property is set, the return value of the custom data function takes precedence over the other related properties, such as xField and yField for AreaSeries, BarSeries, BubbleSeries, ColumnSeries, LineSeries, and PlotSeries. For BubbleSeries, the return value takes precedence over the radiusField property. For PieSeries, the return value takes precedence over the field property.

The custom dataFunction for a series has the following signature:

     function_name (series:Series, item:Object, fieldName:String):Object { ... }
     

You typically use the dataFunction property to access fields in a data provider that are not scalar values, but are instead nested in the data provider. For example, the following data requires a data function to access the fields for a chart's data provider:

      {month: "Aug", close: {High:45.87,Low:12.2}, open:25.19}
      

The following example returns a value from this data provider:

     public function myDataFunction(series:Series, item:Object, fieldName:String):Object {
          if (fieldName == 'yValue')
              return(item.close.High);
          else if (fieldName == "xValue")
              return(item.month);
          else
              return null;
     }     
     

Array of chart items for which data tips are to be shown non-interactively on the chart.

The DataTransform object that the element is associated with. A DataTransform object represents an association between a set of elements and a set of axis objects used to transform those elements from data space to screen coordinates and back. A chart element uses its associated DataTransform object to calculate how to render its data.

The name of the series, for display to the user. This property is used to represent the series in user-visible labels, such as data tips.

If filterFuction or filterDataValues is set, filterData is ignored. true if the series filters its data before displaying. If a series renders data that contains missing values (such as null, undefined, or NaN), or renders values that are outside the range of the chart axes, this property should be set to true (the default). If you know that all of the data in the series is valid, you can set this to false to improve performance.

If filterFuction is set, filterDataValues and filterData are ignored. If filterDataValues property is set to none, series will not filter its data before displaying. If filterDataValues is set to nulls, series filters data like null, undefined, or NaN before displaying. If this property is set to outsideRange, series filters its data like null, undefined, or NaN and also the values that are outside the range of the chart axes. If you know that all of the data in the series is valid, you can set this to none to improve performance.

Specifies a method that returns the array of chart items in the series that are to be displayed. If this property is set, the return value of the custom filter function takes precedence over the filterDataValues and filterData properties. But if it returns null, then filterDataValues and filterData will be prefered in that order.

The custom filterFunction has the following signature:

     function_name (cache:Array):Array { ... }
     

     public function myFilterFunction(cache:Array):Array {
          var filteredCache:Array=[];
          var n:int = cache.length;  
          for(var i:int = 0; i < n; i++)
          {
              var item:ColumnSeriesItem = ColumnSeriesItem(cache[i]);
              if(item.yNumber > 0 && item.yNumber < 700)
              {
                  filteredCache.push(item);
              }
          }
          return filteredCache;
     }
     

If you specify a custom filter function for your chart series and you want to filter null values or values outside the range of axes, you must manually filter them using the custom filter function. filterDataValues or filterData cannot be used.

Determines whether data tips appear when users interact with chart data on the screen. Set to false to prevent the series from showing data tips or generating hit data.

The default value is true.

Gets all the items that are there in the series after filtering.

Individual series determine the list of items that are to be returned.

An Array of LegendData instances that describe the items that should show up in a legend representing this series. Derived series classes override this getter and return legend data that is specific to their styles and data representation method. Although most series types return only a single LegendData instance, some series types, such as PieSeries and StackedSeries, return multiple instances representing individual items in the Array, or multiple ways of rendering data.

Stores the information necessary to render this series.

Specifies whether a series is selectable or not.

The default value is true.

Index of the selected item in the data provider of the series. If multiple items are selected, then this property refers to the most recently selected item.

An Array of indexes of the selected items in the data provider of the series.

The chart item that is selected in the series. If multiple items are selected, then this property refers to the most recently selected item.

An Array of chart items that are selected in the series.

A render data structure passed in by a running transtion. When a series effect is set to play on a series, it first captures the current state of the series by asking for its render data. The transition modifies the render data to create the desired effect and passes the structure back to the series for display. If the transitionRenderData property is a value other than null, a series uses its contents to update its display.

Constructor.

Called by the SeriesInterpolate effect to initiate an interpolation effect. The effect passes in the source and destination data for the series to interpolate between. The effect passes the return value of this method repeatedly to the interpolate() method of the series to advance the animation for the duration of the effect. The series calculates the data it needs to perform the interpolation and returns it in this method.

Parameters

Caches the values stored in the measureName property from the original dataProvider items in the chart item's fieldName property. If the the value of the measureName property is null or the empty string, this method assumes the original data provider items are raw values and caches them instead.

Parameters

Caches the values stored in the measureName property from the original dataProvider items in the chart item's fieldName property. If the measureName property is null or the empty string, this method stores the index of the items in the fieldName property instead.

Parameters

Caches the values stored in the measureName property from the original dataProvider items in the chart item's fieldName property.

Parameters

Called by the chart to allow associated elements to claim style selectors from its chartSeriesStyles Array. Each chart has an associated set of selectors that are implicitly assigned to contained elements that require them. Implementing this function gives an element a chance to 'claim' elements out of that set, as necessary. An element that requires N style selectors claims the values from styles[firstAvailable] to styles[firstAvailable + N - 1].

Parameters

Processes the properties set on the component. This is an advanced method that you might override when creating a subclass of UIComponent.

You do not call this method directly. Flex calls the commitProperties() method when you use the addChild() method to add a component to a container, or when you call the invalidateProperties() method of the component. Calls to the commitProperties() method occur before calls to the measure() method. This lets you set property values that might be used by the measure() method.

Some components have properties that affect the number or kinds of child objects that they need to create, or have properties that interact with each other, such as the horizontalScrollPolicy and horizontalScrollPosition properties. It is often best at startup time to process all of these properties at one time to avoid duplicating work.

This is used if you do not set a custom function as the filterFunction for the series. Individual series should overwrite this.

Parameters

The default handler for the dragStart event.

Parameters

Called by the SeriesInterpolate effect to end an interpolation effect. The effect uses this method to complete the interpolation and clean up any temporary state associated with the effect.

Parameters

Extracts the minimum value, maximum value, and, optionally, the minimum interval from an Array of ChartItem objects. Derived classes can call this method from their implementations of the describeData() method to fill in the details of the DataDescription structure.

Parameters

Extracts the minimum value, maximum value, and, optionally, the minimum interval from an Array of ChartItem objects. Derived classes can call this method from their implementations of the describeData() method to fill in the details of the DataDescription structure.

Parameters

You typically retrieve the Axis instance directly through a named property (such as for a Cartesian-based series horizontalAxis, verticalAxis, or radiusAxis).

This is a low-level accessor.

Parameters

Fills in the elementBounds, bounds, and visibleBounds properties of a renderData structure that is generated by this series. Effect classes call this method to fill in these fields for use in implementing various effect types. Derived classes should implement this method to generate the bounds of the items of the series only when requested.

Parameters

Gets all the items that are in a rectangular region for the series. Call this function to determine what items are in a particular rectangular region in that series.

Individual series determine whether their chart item is under the region. The point should be in the global coordinate space.

Parameters

Related API Elements

Fills in missing values in an interpolation structure. When a series calls the initializeInterpolationData() method, it passes in Arrays of source and destination values for the interpolation. If either of those two Arrays is incomplete, the series must provide "appropriate" placeholder values for the interpolation. How those placeholder values are determined is specific to the series type. Series extenders should override this method to provide those placeholder values.

Parameters