blob: f7ea69d3bd02cc4795f594602f7cba6ee23f6d3c [file] [log] [blame]
////////////////////////////////////////////////////////////////////////////////
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package mx.charts.series.items
{
import mx.charts.ChartItem;
import mx.charts.series.BarSeries;
import mx.graphics.IFill;
/**
* Represents the information required to render an item as part of a BarSeries. The BarSeries class passes these items to its itemRenderer when rendering.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public class BarSeriesItem extends ChartItem
{
include "../../../core/Version.as";
//--------------------------------------------------------------------------
//
// Constructor
//
//--------------------------------------------------------------------------
/**
* Constructor.
* @param element The owning series.
* @param data The item from the dataProvider that this ChartItem represents.
* @param index The index of the item from the series's dataProvider.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public function BarSeriesItem(element:BarSeries = null,
data:Object = null, index:uint = 0)
{
super(element, data, index);
}
//--------------------------------------------------------------------------
//
// Properties
//
//--------------------------------------------------------------------------
//----------------------------------
// fill
//----------------------------------
[Inspectable(environment="none")]
/**
* Holds the fill color of the item.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var fill:IFill;
/**
* @private
*/
mx_internal var labelText:String;
/**
* @private
*/
mx_internal var label:Object;
/**
* @private
*/
mx_internal var labelX:Number;
/**
* @private
*/
mx_internal var labelY:Number;
/**
* @private
*/
mx_internal var labelWidth:Number = 1;
/**
* @private
*/
mx_internal var labelHeight:Number = 1;
//----------------------------------
// min
//----------------------------------
[Inspectable(environment="none")]
/**
* The minimum value of this item converted into screen coordinates.
* The value of this field is <code>undefined</code> if the BarSeries is not stacked and its <code>minField</code> property is not set.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var min:Number;
//----------------------------------
// minFilter
//----------------------------------
[Inspectable(environment="none")]
/**
* The minimum value of this item, filtered against the horizontal axis of the containing chart. This value <code>NaN</code> if the value lies outside the axis's range.
* The value of this field is <code>undefined</code> if the BarSeries is not stacked and its <code>minField</code> property is not set.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var minFilter:Number;
//----------------------------------
// minNumber
//----------------------------------
[Inspectable(environment="none")]
/**
* The minimum value of this item, converted to a number by the horizontal axis of the containing chart.
* The value of this field is <code>undefined</code> if the BarSeries is not stacked and its <code>minField</code> property is not set.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var minNumber:Number;
//----------------------------------
// minValue
//----------------------------------
[Inspectable(environment="none")]
/**
* The minimum value of this item.
* The value of this field is <code>undefined</code> if the BarSeries is not stacked and its <code>minField</code> property is not set.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var minValue:Object;
//----------------------------------
// x
//----------------------------------
[Inspectable(environment="none")]
/**
* The x value of this item converted into screen coordinates.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var x:Number;
//----------------------------------
// xFilter
//----------------------------------
[Inspectable(environment="none")]
/**
* The x value of this item, filtered against the horizontal axis of the containing chart. This value is <code>NaN</code> if the value lies outside the axis's range.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var xFilter:Number;
//----------------------------------
// xNumber
//----------------------------------
[Inspectable(environment="none")]
/**
* The x value of this item, converted to a number by the horizontal axis of the containing chart.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var xNumber:Number;
//----------------------------------
// xValue
//----------------------------------
[Inspectable(environment="none")]
/**
* The x value of this item.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var xValue:Object;
//----------------------------------
// y
//----------------------------------
[Inspectable(environment="none")]
/**
* The y value of this item converted into screen coordinates.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var y:Number;
//----------------------------------
// yFilter
//----------------------------------
[Inspectable(environment="none")]
/**
* The y value of this item, filtered against the vertical axis of the containing chart. This value is <code>NaN</code> if the value lies outside the axis's range.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var yFilter:Number;
//----------------------------------
// yNumber
//----------------------------------
[Inspectable(environment="none")]
/**
* The y value of this item, converted to a number by the vertical axis of the containing chart.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var yNumber:Number;
//----------------------------------
// yValue
//----------------------------------
[Inspectable(environment="none")]
/**
* The y value of this item.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
public var yValue:Object;
//--------------------------------------------------------------------------
//
// Overridden methods
//
//--------------------------------------------------------------------------
/**
* @private
* Returns a copy of this ChartItem.
*/
override public function clone():ChartItem
{
var result:BarSeriesItem = new BarSeriesItem(BarSeries(element),item,index);
result.itemRenderer = itemRenderer;
return result;
}
}
}