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

See also

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

Captures the before and after states of the series for animation. This method is typically called by the effects classes.

If you implement a custom series type, you generally do not override this method. Instead, you should override the renderData() accessor.

Parameters

Helper method to implement the interpolation effect. A custom series can call this method from its beginInterpolation() method to initialize a data structure to interpolate an arbitrary set of numeric properties over the life of the effect. You can pass that data structure to the applyInterpolation() utility method to actually modify the values when the interpolate() method is called.

Parameters

Called by the SeriesInterpolate effect to advance an interpolation. The effect calls this once per frame until the interpolation is complete. The series is responsible for using the parameters to render the interpolated values. By default, the series assumes that interpolationData is a data structure returned by the initializeInterpolationData() method, and passes it through to the applyInterpolation() method.

Parameters

Informs the series that the underlying data in the data provider has changed. This function triggers calls to the updateData(), updateMapping(), updateFilter(), and updateTransform() methods on the next call to the commitProperties() method. If any data effects are assigned to any elements of the chart, this method also triggers the show and hide effects.

Parameters

Informs the series that the filter of the data against the axes has changed and must be recalculated. Calling this method triggers calls to the updateFilter() and updateTransform() methods on the next call to the commitProperties() method. If any data effects are assigned to any elements of the chart, this method also triggers the show and hide effects.

Parameters

Informs the series that the mapping of the data into numeric values has changed and must be recalculated. Calling this function triggers calls to the updateMapping(), updateFilter(), and updateTransform() methods on the next call to the commitProperties() method. If any data effects are assigned to any elements of the chart, this method also triggers the show and hide effects.

Parameters

Informs the series that the transform of the data to screen coordinates has changed and must be recalculated. Calling this function triggers a call to the updateTransform() method on the next call to the commitProperties() method.

Parameters

Informs the series that a significant change has occured in the display of data. This triggers any ShowData and HideData effects.

Updates the Legend items when the series display name changes by dispatching a new LegendDataChanged event.

Sets the actual size of this object.

This method is mainly for use in implementing the updateDisplayList() method, which is where you compute this object's actual size based on its explicit size, parent-relative (percent) size, and measured size. You then apply this actual size to the object by calling setActualSize().

In other situations, you should be setting properties such as width, height, percentWidth, or percentHeight rather than calling this method.

Parameters

Assigns an Axis instance to a particular dimension of the chart. You typically set 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

Removes any item from the provided cache whose field property is NaN. Derived classes can call this method from their implementation of the updateFilter() method to remove any ChartItem objects that were filtered out by the axes.

Parameters

Calls the legendDataChanged() method.

Called when the underlying data that the series represents has changed and needs to be reloaded from the data provider. If you implement custom series types, you should override this method and load all data necessary to render the series out of the backing data provider. You must also be sure to call the super.updateData() method in your subclass. You do not generally call this method directly. Instead, to guarantee that your data has been updated at a given point, call the validateData() method of the Series class.

Draws the object and/or sizes and positions its children. 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 updateDisplayList() method when the component is added to a container using the addChild() method, and when the component's invalidateDisplayList() method is called.

If the component has no children, this method is where you would do programmatic drawing using methods on the component's Graphics object such as graphics.drawRect().

If the component has children, this method is where you would call the move() and setActualSize() methods on its children.

Components can do programmatic drawing even if they have children. In doing either, use the component's unscaledWidth and unscaledHeight as its bounds.

It is important to use unscaledWidth and unscaledHeight instead of the width and height properties.

Parameters

Called when the underlying data the series represents needs to be filtered against the ranges represented by the axes of the associated data transform. This can happen either because the underlying data has changed or because the range of the associated axes has changed. If you implement a custom series type, you should override this method and filter out any outlying data using the filterCache() method of the axes managed by its associated data transform. The filterCache() method converts any values that are out of range to NaN. You must be sure to call the super.updateFilter() method in your subclass. You should not generally call this method directly. Instead, if you need to guarantee that your data has been filtered at a given point, call the validateTransform() method of the Series class. You can generally assume that your updateData() and updateMapping() methods have been called prior to this method, if necessary.

Called when the underlying data the series represents needs to be mapped to numeric representations. This can happen either because the underlying data has changed or because the axes used to render the series have changed in some relevant way. If you implement a custom series, you should override this method and convert the data represented into numeric values by using the mapCache() method of the axes that are managed by its associated data transform. You must also be sure to call the super.updateMapping() method in your subclass. You should not generally call this method directly. Instead, to guarantee that your data has been mapped at a given point, call the validateData() method of the Series class. You can generally assume that your updateData() method has been called prior to this method, if necessary.

Called when the underlying data the series represents needs to be transformed from data to screen values by the axes of the associated data transform. This can happen either because the underlying data has changed, because the range of the associated axes has changed, or because the size of the area on screen has changed. If you implement a custom series type, you should override this method and transform the data using the transformCache() method of the associated data transform. You must be sure to call the super.updateTransform() method in your subclass. You should not generally call this method directly. Instead, if you need to guarantee that your data has been filtered at a given point, call the valiateTransform() method of the Series class. You can generally assume that your updateData(), updateMapping(), and updateFilter() methods have been called prior to this method, if necessary.

Calls the updateData() and updateMapping() methods of the series, if necessary. This method is called automatically by the series from the commitProperties() method, as necessary, but a derived series might call it explicitly if the generated values are needed at an explicit time. Loading and mapping data against the axes is designed to be acceptable by the axes at any time. It is safe this method explicitly at any point.

Calls the updateFilter() and updateTransform() methods of the series, if necessary. This method is called automatically by the series during the commitProperties() method, as necessary, but a derived series might call it explicitly if the generated values are needed at an explicit time. Filtering and transforming of data relies on specific values being calculated by the axes, which can in turn depend on the data that is displayed in the chart. Calling this function at the wrong time might result in extra work being done, if those values are updated.