first commit

com/yahoo/astra/fl/charts/series/ISeries.as

@@ -0,0 +1,86 @@
+/*
+Copyright (c) 2009 Yahoo! Inc.  All rights reserved.  
+The copyrights embodied in the content of this file are licensed under the BSD (revised) open source license
+*/
+package com.yahoo.astra.fl.charts.series
+{
+	import com.yahoo.astra.fl.charts.Chart;
+	import com.yahoo.astra.fl.charts.IChart;
+	
+	import flash.events.IEventDispatcher;
+	
+	//--------------------------------------
+	//  Events
+	//--------------------------------------
+
+	/**
+	 * Dispatched when the data property for an ISeries changes.
+	 */
+	[Event(name="dataChange", type="flash.events.Event")]
+	
+	/**
+	 * A renderer for a series displayed on a chart.
+	 * 
+	 * <p>Important: Must be a subclass of DisplayObject</p>
+	 * 
+	 * @see flash.display.DisplayObject
+	 * @author Josh Tynjala
+	 */
+	public interface ISeries extends IEventDispatcher
+	{
+		
+	//--------------------------------------
+	//  Properties
+	//--------------------------------------
+		
+		/**
+		 * The chart in which this series appears.
+		 */
+		function get chart():Object;
+		
+		/**
+		 * @private
+		 */
+		function set chart(value:Object):void;
+		
+		/**
+		 * The data provider for this series. Accepts <code>Array</code> or <code>XMLList</code> objects.
+		 */
+		function get dataProvider():Object;
+		
+		/**
+		 * @private
+		 */
+		function set dataProvider(value:Object):void;
+		
+		/**
+		 * The name of the series as it appears to the user.
+		 */
+		function get displayName():String;
+		
+		/**
+		 * @private
+		 */
+		function set displayName(value:String):void;
+		
+		/**
+		 * The number of items in the series.
+		 */
+		function get length():int;
+		
+	//--------------------------------------
+	//  Methods
+	//--------------------------------------
+		
+		/**
+		 * Creates a copy of the ISeries object.
+		 * 
+		 * @return a new ISeries object
+		 */
+		function clone():ISeries;
+		
+		function itemRendererToIndex(renderer:ISeriesItemRenderer):int;
+		
+		function itemToItemRenderer(item:Object):ISeriesItemRenderer;
+	}
+}