Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
OLAPDataGrid

Package | mx.controls
Class | public class OLAPDataGrid
Inheritance | OLAPDataGrid AdvancedDataGrid AdvancedDataGridBaseEx AdvancedDataGridBase AdvancedListBase ScrollControlBase UIComponent FlexSprite flash.display.Sprite
Subclasses | PrintOLAPDataGrid

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The OLAPDataGrid control expands on the functionality of the AdvancedDataGrid control to add support for the display of the results of OLAP queries. Like all Flex data grid controls, the OLAPDataGrid control is designed to display data in a two-dimensional representation of rows and columns.

Because of the way you pass data to the OLAPDataGrid control, it has several differences from the AdvancedDataGrid control:

- Column dragging is not allowed in the OLAPDataGrid control.
- You cannot edit cells in the OLAPDataGrid control because cell data is a result of a query and does not correspond to a single data value in the OLAP cube.
- You cannot sort columns by clicking on header in the OLAPDataGrid control. Sorting is supported at the dimension level so that you can change the order of members of that dimension.

You populate an OLAPDataGrid control with data by setting its data provider to an instance of the OLAPResult class, which contains the results of an OLAP query.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:OLAPDataGrid>` tag inherits all of the tag attributes of its superclass, except for `labelField`, `iconField`, and `iconFunction`, and adds the following tag attributes:

      <mx:OLAPDataGrid
        Properties
        defaultCellString="NaN"
        headerRendererProviders="[]"
        itemRendererProviders="[]"

        Styles
        columnAxisHeaderStyleName="undefined"
        rowAxisHeaderStyleName="undefined"
      />

Default MXML Property `dataProvider`

View the examples

See also

mx.controls.AdvancedDataGrid
mx.olap.OLAPQuery
mx.olap.OLAPResult

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | allowMultipleSelection : Boolean A flag that indicates whether you can allow more than one item to be selected at the same time. | AdvancedListBase
|  | automationDelegate : Object The delegate object that handles the automation-related functionality. | UIComponent
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIComponent
|  | automationName : String Name that can be used as an identifier for this object. | UIComponent
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIComponent
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIComponent
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | UIComponent
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIComponent
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIComponent
|  | baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | UIComponent
|  | borderMetrics : EdgeMetrics [read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. | ScrollControlBase
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | UIComponent
|  | cachePolicy : String Specifies the bitmap caching policy for this object. | UIComponent
|  | className : String [read-only] The name of this instance's class, such as "Button". | UIComponent
|  | contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system. | UIComponent
|  | contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system. | UIComponent
|  | currentState : String The current view state of the component. | UIComponent
|  | cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers. | UIComponent
|  | data : Object The item in the data provider this component should render when this component is used as an item renderer or item editor. | AdvancedListBase
|  | dataProvider : Object [override] An OLAPDataGrid accepts only an IOLAPResult as dataProvider other dataProviders are simply ignored. | OLAPDataGrid
|  | dataTipField : String Name of the field in the data provider items to display as the data tip. | AdvancedListBase
|  | dataTipFunction : Function User-supplied function to run on each item to determine its dataTip. | AdvancedListBase
|  | defaultCellString : String = NaN String displayed in a cell when the data for that cell returned by the IOLAPResult instance is null or NaN. | OLAPDataGrid
|  | depth : Number Determines the order in which items inside of containers are rendered. | UIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | UIComponent
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | UIComponent
|  | document : Object A reference to the document object associated with this UIComponent. | UIComponent
|  | doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events. | UIComponent
|  | enabled : Boolean Whether the component can accept user interaction. | UIComponent
|  | enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus. | AdvancedDataGridBaseEx
|  | errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails. | UIComponent
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIComponent
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIComponent
|  | firstVisibleItem : Object The data provider element that corresponds to the item that is currently displayed in the top row of the AdvancedDataGrid control. | AdvancedDataGrid
|  | flexContextMenu : IFlexContextMenu The context menu for this UIComponent. | UIComponent
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | UIComponent
|  | focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusPane : Sprite The focus pane associated with this object. | UIComponent
|  | fontContext : IFlexModuleFactory The module factory that provides the font context for this component. | AdvancedDataGridBase
|  | groupItemRenderer : IFactory Specifies the item renderer used to display the branch nodes in the navigation tree that correspond to groups. | AdvancedDataGrid
|  | groupRowHeight : Number The height of the grouped row, in pixels. | AdvancedDataGrid
|  | hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus. | UIComponent
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | UIComponent
|  | headerHeight : Number The height of the header cell of the column, in pixels. | AdvancedDataGridBase
|  | headerRenderer : IFactory The header renderer used to display the header rows of the column. | AdvancedDataGridBase
|  | headerRendererProviders : Array Array of OLAPDataGridHeaderRendererProvider instances that specify a custom header renderer for the columns of the control. | OLAPDataGrid
|  | headerWordWrap : Boolean If true, specifies that text in the header is wrapped if it does not fit on one line. | AdvancedDataGridBase
|  | height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates. | UIComponent
|  | horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | horizontalScrollPolicy : String A property that indicates whether the horizontal scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method. | ScrollControlBase
|  | horizontalScrollPosition : Number [override] The offset into the content from the left edge. | AdvancedDataGridBaseEx
|  | iconField : String The name of the field in the data provider object that determines what to display as the icon. | AdvancedListBase
|  | iconFunction : Function A user-supplied function to run on each item to determine its icon. | AdvancedListBase
|  | id : String ID of the component. | UIComponent
|  | imeMode : String Specifies the IME (input method editor) mode. | AdvancedDataGridBaseEx
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIComponent
|  | inheritingStyles : Object The beginning of this component's chain of inheriting styles. | UIComponent
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required). | UIComponent
|  | instanceIndex : int [read-only] The index of a repeated component. | UIComponent
|  | instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document. | UIComponent
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | UIComponent
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | itemRenderer : IFactory The custom item renderer for the control. | AdvancedListBase
|  | itemRendererProviders : Array Array of OLAPDataGridItemRendererProvider instances that specify a custom item renderer for the cells of the control. | OLAPDataGrid
|  | layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings. | UIComponent
|  | left : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | listData : BaseListData When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the additional data from the list control. | AdvancedListBase
|  | liveScrolling : Boolean = true A flag that indicates whether scrolling is live as the scrollbar thumb is moved or the view is not updated until the thumb is released. | ScrollControlBase
|  | lockedRowCount : int [override] The index of the first row in the control that scrolls. | AdvancedDataGrid
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | menuSelectionMode : Boolean = false A flag that indicates whether menu-style selection should be used. | AdvancedListBase
|  | minColumnWidth : Number The minimum width of the columns, in pixels. | AdvancedDataGridBaseEx
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component. | UIComponent
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | MXMLDescriptor : Array [read-only] | UIComponent
|  | MXMLProperties : Array [read-only] | UIComponent
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIComponent
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | UIComponent
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | UIComponent
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | UIComponent
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIComponent
|  | parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance. | UIComponent
|  | parentDocument : Object [read-only] A reference to the parent document object for this UIComponent. | UIComponent
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIComponent
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIComponent
|  | postLayoutTransformOffsets : TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout. | UIComponent
|  | processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens. | UIComponent
|  | repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent. | UIComponent
|  | repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent. | UIComponent
|  | repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. | UIComponent
|  | repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent. | UIComponent
|  | resizableColumns : Boolean = true A flag that indicates whether the user can change the size of the columns. | AdvancedDataGridBaseEx
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | rotation : Number [override] | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] | UIComponent
|  | rowCount : int Number of rows to be displayed. | AdvancedListBase
|  | rowHeight : Number The height of the rows in pixels. | AdvancedListBase
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | scrollTipFunction : Function A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase
|  | selectable : Boolean A flag that indicates whether the list shows selected items as selected. | AdvancedListBase
|  | selectedCells : Array Contains an Array of cell locations as row and column indices. | AdvancedDataGrid
|  | selectedIndex : int The index in the data provider of the selected item. | AdvancedListBase
|  | selectedIndices : Array An array of indices in the data provider of the selected items. | AdvancedListBase
|  | selectedItem : Object A reference to the selected item in the data provider. | AdvancedListBase
|  | selectedItems : Array An Array of references to the selected items in the data provider. | AdvancedListBase
|  | selectionMode : String The selection mode of the control. | AdvancedDataGridBase
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | showScrollTips : Boolean = false A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged. | ScrollControlBase
|  | states : Array The view states that are defined for this component. | UIComponent
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | UIComponent
|  | styleFunction : Function [override] A callback function called while rendering each cell in the cell data area. | OLAPDataGrid
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | UIComponent
|  | styleName : Object The class style used by this component. | UIComponent
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | UIComponent
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIComponent
|  | tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor. | UIComponent
|  | toolTip : String Text to display in the ToolTip. | UIComponent
|  | top : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | transform : Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | UIComponent
|  | transformX : Number Sets the x coordinate for the transform center of the component. | UIComponent
|  | transformY : Number Sets the y coordinate for the transform center of the component. | UIComponent
|  | transformZ : Number Sets the z coordinate for the transform center of the component. | UIComponent
|  | transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs. | UIComponent
|  | treeColumn : AdvancedDataGridColumn The column in which the tree is displayed. | AdvancedDataGrid
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | value : Object [read-only] The selected item, or the data or label field of the selected item. | AdvancedListBase
|  | variableRowHeight : Boolean A flag that indicates whether the individual rows can have different height. | AdvancedListBase
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | verticalScrollPolicy : String A property that indicates whether the vertical scroll bar is always on, always off, or automatically changes based on the parameters passed to the setScrollBarProperties() method. | ScrollControlBase
|  | verticalScrollPosition : Number The offset into the content from the top edge. | ScrollControlBase
|  | viewMetrics : EdgeMetrics [read-only] An EdgeMetrics object taking into account the scroll bars, if visible. | ScrollControlBase
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | wordWrap : Boolean A flag that indicates whether text in the row should be word wrapped. | AdvancedListBase
|  | x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container. | UIComponent
|  | y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container. | UIComponent
|  | z : Number [override] | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualCollection : ICollectionView A copy of the value normally stored in the collection property used while running data changes effects. | AdvancedListBase
|  | actualIterator : IViewCursor A copy of the value normally stored in the iterator property used while running data changes effects. | AdvancedListBase
|  | anchorBookmark : CursorBookmark A bookmark to the item that is the anchor. | AdvancedListBase
|  | anchorColumnIndex : int = -1 The column index of the current anchor. | AdvancedDataGrid
|  | anchorIndex : int = -1 The offset of the item in the data provider that is the selection anchor point. | AdvancedListBase
|  | border : IFlexDisplayObject The border object. | ScrollControlBase
|  | cachedDataChangeEffect : Effect = null The effect that plays when changes occur in the data provider for the control. | AdvancedListBase
|  | caretBookmark : CursorBookmark A bookmark to the item under the caret. | AdvancedListBase
|  | caretColumnIndex : int = -1 The column name of the item under the caret. | AdvancedDataGrid
|  | caretIndex : int = -1 The offset of the item in the data provider that is at the selection caret point. | AdvancedListBase
|  | caretIndicator : Sprite The DisplayObject that contains the graphics that indicate which renderer is the caret. | AdvancedListBase
|  | caretItemRenderer : IListItemRenderer The renderer for the item under the caret. | AdvancedListBase
|  | caretUID : String The UID of the item under the caret. | AdvancedListBase
|  | cellSelectionTweens : Object A hash table of selection tweens. | AdvancedDataGrid
|  | collection : ICollectionView An ICollectionView that represents the data provider. | AdvancedListBase
|  | columnMap : Object A map of item renderers to columns. | AdvancedDataGridBase
|  | currentColNum : int Contains the index of the column for which a renderer is currently being created. | AdvancedDataGridBase
|  | currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors. | UIComponent
|  | currentItemTop : Number Contains the top position of the renderer that is currently being created. | AdvancedDataGridBase
|  | currentRowHeight : Number The height, in pixels, of the current row. | AdvancedDataGridBase
|  | currentRowNum : int Contains the index of the row for which a renderer is currently being created. | AdvancedDataGridBase
|  | dataEffectCompleted : Boolean = false A flag that indicates that the a data change effect has just completed. | AdvancedListBase
|  | dataItemWrappersByRenderer : Dictionary A dictionary mapping item renderers to the ItemWrappers used to supply their data. | AdvancedListBase
|  | defaultColumnCount : int = 4 The default number of columns to display. | AdvancedListBase
|  | defaultRowCount : int = 4 The default number of rows to display. | AdvancedListBase
|  | explicitColumnCount : int = -1 The column count requested by explicitly setting the columnCount property. | AdvancedListBase
|  | explicitColumnWidth : Number The column width requested by explicitly setting the columnWidth. | AdvancedListBase
|  | explicitRowCount : int = -1 The row count requested by explicitly setting rowCount. | AdvancedListBase
|  | explicitRowHeight : Number The row height requested by explicitly setting rowHeight. | AdvancedListBase
|  | freeItemRenderers : Array A stack of unused item renderers. | AdvancedListBase
|  | hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent
|  | headerInfos : Array An Array of AdvancedDataGridHeaderInfo instances for all columns in the control. | AdvancedDataGridBase
|  | headerRowInfo : Array An Array of ListRowInfo instances that cache header height and other information for the headers in the headerItems Array. | AdvancedDataGridBase
|  | highlightColumnIndex : int = -1 The column index of the item that is currently rolled over or under the cursor. | AdvancedDataGrid
|  | highlightIndicator : Sprite The DisplayObject that contains the graphics that indicates which renderer is highlighted. | AdvancedListBase
|  | highlightItemRenderer : IListItemRenderer The renderer that is currently rolled over or under the caret. | AdvancedListBase
|  | highlightUID : String The UID of the item that is current rolled over or under the caret. | AdvancedListBase
|  | horizontalScrollBar : ScrollBar The horizontal scroll bar. | ScrollControlBase
|  | isKeyPressed : Boolean = false Contains true if a key press is in progress. | AdvancedDataGridBaseEx
|  | itemRendererToFactoryMap : Dictionary Maps item renderers to the Factory instacne from which they have been created. | AdvancedDataGridBase
|  | itemsNeedMeasurement : Boolean = true A flag that indicates whether the columnWidth and rowHeight properties need to be calculated. | AdvancedListBase
|  | itemsSizeChanged : Boolean = false A flag that indicates that the size of the renderers may have changed. | AdvancedListBase
|  | iterator : IViewCursor The main IViewCursor instance used to fetch items from the data provider and pass the items to the renderers. | AdvancedListBase
|  | iteratorValid : Boolean = true A flag that indicates that a page fault as occurred and that the iterator's position is not valid (not positioned at the topmost item being displayed). | AdvancedListBase
|  | keySelectionPending : Boolean = false A flag that indicates if keyboard selection was interrupted by a page fault. | AdvancedListBase
|  | lastSeekPending : ListBaseSeekPending The most recent seek that caused a page fault. | AdvancedListBase
|  | listContent : AdvancedListBaseContentHolder An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics. | AdvancedListBase
|  | listItems : Array An Array of Arrays that contains the item renderer instances that render each data provider item. | AdvancedListBase
|  | maskShape : Shape The mask. | ScrollControlBase
|  | modifiedCollectionView : ModifiedCollectionView The collection view that temporarily preserves previous data provider state to facilitate running data change effects. | AdvancedListBase
|  | rendererChanged : Boolean = false A flag that indicates that the renderer changed. | AdvancedListBase
|  | rendererDescriptionMap : Dictionary Maps renders to row and column spanning info. | AdvancedDataGrid
|  | reservedItemRenderers : Object A hash map of currently unused item renderers that may be used again in the near future. | AdvancedListBase
|  | resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources. | UIComponent
|  | rowInfo : Array An array of ListRowInfo objects that cache row heights and other tracking information for the rows in the listItems property. | AdvancedListBase
|  | rowMap : Object A hash map of item renderers to their respective ListRowInfo object. | AdvancedListBase
|  | runDataEffectNextUpdate : Boolean = false A flag that indicates if a data effect should be initiated the next time the display is updated. | AdvancedListBase
|  | runningDataEffect : Boolean = false A flag indicating if a data change effect is currently running | AdvancedListBase
|  | scrollAreaChanged : Boolean A flag that the scrolling area changed due to the appearance or disappearance of scrollbars. | ScrollControlBase
|  | selectedColumnIndex : int = -1 The column of the selected cell. | AdvancedDataGrid
|  | selectedData : Object A hash table of ListBaseSelectionData objects that track which items are currently selected. | AdvancedListBase
|  | selectionIndicators : Object A hash table of selection indicators. | AdvancedListBase
|  | selectionLayer : Sprite The layer in listContent where all selection and highlight indicators are drawn. | AdvancedListBase
|  | selectionTweens : Object A hash table of selection tweens. | AdvancedListBase
|  | showCaret : Boolean A flag that indicates whether to show caret. | AdvancedListBase
|  | treeColumnIndex : int [read-only] The tree column number. | AdvancedDataGrid
|  | tween : Object The tween object that animates rows Users can add event listeners to this Object to get notified when the tween starts, updates and ends. | AdvancedDataGrid
|  | unconstrainedRenderers : Object A hash map of item renderers that are not subject to the layout algorithms of the list | AdvancedListBase
|  | unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component. | UIComponent
|  | unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList(). | UIComponent
|  | verticalScrollBar : ScrollBar The vertical scroll bar. | ScrollControlBase
|  | visibleCellRenderers : Object A hash table of data provider item renderers currently in view. | AdvancedDataGrid
|  | visibleData : Object A hash table of data provider item renderers currently in view. | AdvancedListBase
|  | visibleHeaderInfos : Array An Array of AdvancedDataGridHeaderRenderer instances that define the header item renderers for the displayable columns. | AdvancedDataGridBase
|  | wordWrapChanged : Boolean = false A flag that indicates whether the value of the wordWrap property has changed since the last time the display list was updated. | AdvancedListBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | OLAPDataGrid() Constructor. | OLAPDataGrid
|  | addDataEffectItem(item:Object):void Adds an item renderer if a data change effect is running. | AdvancedListBase
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | callLater(method:Function, args:Array = null):void Queues a function to be called later. | UIComponent
|  | clearStyle(styleProp:String):void Deletes a style property from this component instance. | UIComponent
|  | contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates. | UIComponent
|  | contentToLocal(point:Point):Point Converts a Point object from content to local coordinates. | UIComponent
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties as automation IDs that identify the child within this container. | UIComponent
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object. | UIComponent
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination. | UIComponent
|  | findString(str:String):Boolean Finds an item in the list based on a string and moves the selection to it. | AdvancedListBase
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent
|  | generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance. | UIComponent
|  | getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component. | UIComponent
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIComponent
|  | getFocus():InteractiveObject Gets the object that currently has focus. | UIComponent
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | getRendererSemanticValue(target:Object, semanticProperty:String):Object Returns the value for a particular semantic property of an item renderer, or null if that property is not defined, while a data effect is running. | AdvancedListBase
|  | getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated. | UIComponent
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | getVisibleRect(targetParent:DisplayObject = null):Rectangle Get the bounds of this object that are visible to the user on the screen. | UIComponent
|  | globalToContent(point:Point):Point Converts a Point object from global to content coordinates. | UIComponent
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient. | UIComponent
|  | indexToItemRenderer(index:int):IListItemRenderer Get an item renderer for the index of an item in the data provider, if one exists. | AdvancedListBase
|  | indicesToIndex(rowIndex:int, colIndex:int):int Computes the offset into the data provider of the item at colIndex, rowIndex. | AdvancedListBase
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIComponent
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateList():void Refresh all rows on next update. | AdvancedListBase
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | isCellItemHighlighted(data:Object, columnIndex:int):Boolean Determines if cell is highlighted. | AdvancedDataGrid
|  | isCellItemSelected(data:Object, columnIndex:int):Boolean Determines if cell is selected. | AdvancedDataGrid
|  | isItemHighlighted(data:Object):Boolean Determines if the item renderer for a data provider item is highlighted (is rolled over via the mouse or or under the caret via keyboard navigation). | AdvancedListBase
|  | isItemSelectable(data:Object):Boolean Determines if the item renderer for a data provider item is selectable. | AdvancedListBase
|  | isItemSelected(data:Object):Boolean Determines if the item renderer for a data provider item is selected. | AdvancedListBase
|  | isItemShowingCaret(data:Object):Boolean Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation. | AdvancedListBase
|  | isItemVisible(item:Object):Boolean Determines if an item is being displayed by a renderer. | AdvancedListBase
|  | itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean Determines whether a renderer contains (or owns) a display object. | AdvancedListBase
|  | itemRendererToIndex(itemRenderer:IListItemRenderer):int Returns the index of the item in the data provider of the item being rendered by this item renderer. | AdvancedListBase
|  | itemToDataTip(data:Object):String Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties. | AdvancedListBase
|  | itemToIcon(data:Object):Class Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties. | AdvancedListBase
|  | itemToItemRenderer(item:Object):IListItemRenderer Returns the item renderer for a given item in the data provider, if there is one. | AdvancedListBase
|  | itemToLabel(data:Object):String Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties. | AdvancedListBase
|  | localToContent(point:Point):Point Converts a Point object from local to content coordinates. | UIComponent
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | measureHeightOfItems(index:int = -1, count:int = 0):Number Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items. | AdvancedListBase
|  | measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureText(text:String):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureWidthOfItems(index:int = -1, count:int = 0):Number Measures a set of items from the data provider using the current item renderer and returns the maximum width found. | AdvancedListBase
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | moveFocusToHeader(columnIndex:int = -1):void Moves focus to the specified column header. | AdvancedDataGridBaseEx
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well. | UIComponent
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeDataEffectItem(item:Object):void Removes an item renderer if a data change effect is running. | AdvancedListBase
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | scrollToIndex(index:int):Boolean Ensures that the data provider item at the given index is visible. | AdvancedListBase
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component. | UIComponent
|  | setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state. | UIComponent
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setMXMLDescriptor(value:Array):void | UIComponent
|  | setMXMLProperties(value:Array):void | UIComponent
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | styleChanged(styleProp:String):void [override] Called when the value of a style property is changed. | OLAPDataGrid
|  | stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized. | UIComponent
|  | suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called. | UIComponent
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexSprite
|  | transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space. | UIComponent
|  | transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates. | UIComponent
|  | unconstrainRenderer(item:Object):void Temporarily stops an item renderer from being positioned by the control's layout algorithm. | AdvancedListBase
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements. | UIComponent
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | absoluteToDisplayColumnIndex(columnIndex:int):int Converts an absolute column index to the corresponding index in the displayed columns. | AdvancedDataGridBaseEx
|  | absoluteToVisibleColumnIndex(columnIndex:int):int Converts an absolute column index to the corresponding index in the visible columns. | AdvancedDataGridBaseEx
|  | absoluteToVisibleIndices(rowIndex:int, columnIndex:int):Object Convert an absolute row index and column index into the corresponding row index and column index of the item as it is currently displayed by the control. | AdvancedDataGridBaseEx
|  | addCellSelectionData(uid:String, columnIndex:int, selectionData:AdvancedDataGridBaseSelectionData):void Adds cell selection information to the control, as if you used the mouse to select the cell. | AdvancedDataGrid
|  | addMXMLChildren(comps:Array):void | UIComponent
|  | addToFreeItemRenderers(item:IListItemRenderer):void Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it. | AdvancedListBase
|  | adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle. | UIComponent
|  | adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void Called from the updateDisplayList() method to adjust the size and position of list content. | AdvancedListBase
|  | applyCellSelectionEffect(indicator:Sprite, uid:String, columnIndex:int, itemRenderer:IListItemRenderer):void Sets up the effect for applying the selection indicator. | AdvancedDataGrid
|  | applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform. | UIComponent
|  | applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void Sets up the effect for applying the selection indicator. | AdvancedListBase
|  | applyUserStylesForItemRenderer(givenItemRenderer:IListItemRenderer):void Applies styles from the AdvancedDatagrid control to an item renderer. | AdvancedDataGrid
|  | atLeastOneProperty(o:Object):Boolean Returns true if the Object has at least one property, which means that the dictionary has at least one key. | AdvancedDataGrid
|  | attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect. | UIComponent
|  | calculateDropIndicatorY(rowCount:Number, rowNum:int):Number Calculates the y position of the drop indicator when performing a drag-and-drop operation. | AdvancedListBase
|  | calculateRowHeight(data:Object, hh:Number, skipVisible:Boolean = false):Number Calculates the row height of columns in a row. | AdvancedDataGridBase
|  | canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped. | UIComponent
|  | childrenCreated():void Performs any final processing after child objects are created. | UIComponent
|  | clearCellSelectionData():void Clears information on cell selection. | AdvancedDataGrid
|  | clearIndicators():void [override] Removes all selection and highlight and caret indicators. | AdvancedDataGrid
|  | clearSelected(transition:Boolean = false):void Clears the set of selected items and removes all graphics depicting the selected state of those items. | AdvancedListBase
|  | clearSelectedCells(transition:Boolean = false):void Clears the selectedCells property. | AdvancedDataGrid
|  | clearSeparators():void Removes column header separators that you normally use to resize columns. | AdvancedDataGridBaseEx
|  | collectionChangeHandler(event:Event):void Handles CollectionEvents dispatched from the data provider as the data changes. | AdvancedListBase
|  | colNumToIndex(colNum:int):int Returns the index of a column as it is currently displayed. | AdvancedDataGridBaseEx
|  | commitProperties():void [override] Calculates the column width and row height and number of rows and columns based on whether properties like columnCount columnWidth, rowHeight and rowCount were explicitly set. | AdvancedListBase
|  | configureScrollBars():void Configures the ScrollBars based on the number of rows and columns and viewable rows and columns. | AdvancedListBase
|  | copyItemWithUID(item:Object):Object Makes a deep copy of the object by calling the ObjectUtil.copy() method, and replaces the copy's uid property (if present) with a new value by calling the UIDUtil.createUID() method. | AdvancedListBase
|  | copySelectedItems(useDataField:Boolean = true):Array Makes a copy of the selected items in the order they were selected. | AdvancedListBase
|  | createBorder():void Creates the border for this component. | ScrollControlBase
|  | createChildren():void [override] Create objects that are children of this ListBase, in this case the listContent object that will hold all the item renderers. | AdvancedListBase
|  | createHeaders(left:Number, top:Number):void Creates the column headers. | AdvancedDataGridBase
|  | createHeaderSeparators(n:int, seperators:Array, headerLines:UIComponent):void Creates the header separators between column headers, and populates the separators Array with the separators created. | AdvancedDataGridBaseEx
|  | createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used. | UIComponent
|  | createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory. | UIComponent
|  | createLockedRows(left:Number, top:Number, right:Number, bottom:Number):void Creates the locked rows, if necessary. | AdvancedDataGridBase
|  | dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void Helper method for dispatching a PropertyChangeEvent when a property is updated. | UIComponent
|  | displayToAbsoluteColumnIndex(columnIndex:int):int Converts the current display column index of a column to its corresponding absolute index. | AdvancedDataGridBaseEx
|  | drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void Draws the caret indicator into the given Sprite at the position, width and height specified using the color specified. | AdvancedListBase
|  | drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:AdvancedDataGridColumn):void Draws a column background for a column with the suggested color. | AdvancedDataGridBaseEx
|  | drawHeaderBackground(headerBG:UIComponent):void Draws the background of the headers into the given UIComponent. | AdvancedDataGridBaseEx
|  | drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void Draws the highlight indicator into the given Sprite at the position, width and height specified using the color specified. | AdvancedListBase
|  | drawHorizontalLine(s:Sprite, rowIndex:int, color:uint, y:Number):void Draws a line between rows. | AdvancedDataGridBaseEx
|  | drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void Draws the renderer with indicators that it is highlighted, selected, or the caret. | AdvancedListBase
|  | drawLinesAndColumnBackgrounds():void Draws lines between columns, and column backgrounds. | AdvancedDataGridBaseEx
|  | drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void Draws a row background at the position and height specified using the color specified. | AdvancedDataGridBaseEx
|  | drawRowBackgrounds():void Draws any alternating row colors, borders and backgrounds for the rows. | AdvancedListBase
|  | drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void Draws the selection indicator into the given Sprite at the position, width and height specified using the color specified. | AdvancedListBase
|  | drawSeparators():void Creates and displays the column header separators that the user normally uses to resize columns. | AdvancedDataGridBaseEx
|  | drawVerticalLine(s:Sprite, colIndex:int, color:uint, x:Number):void [override] Draws a vertical line between columns. | AdvancedDataGrid
|  | drawVisibleItem(uid:String, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void Draws the item renderer corresponding to the specified UID. | AdvancedDataGridBase
|  | findHeaderRenderer(pt:Point):IListItemRenderer [override] | AdvancedDataGrid
|  | findKey(eventCode:int):Boolean Tries to find the next item in the data provider that starts with the character in the eventCode parameter. | AdvancedListBase
|  | findRenderer(pt:Point, items:Array, info:Array, yy:Number = 0):IListItemRenderer A helper method to determine which item renderer is under the mouse. | AdvancedDataGridBaseEx
|  | finishDataChangeEffect(event:EffectEvent):void Cleans up after a data change effect has finished running by restoring the original collection and iterator and removing any cached values used by the effect. | AdvancedListBase
|  | finishKeySelection():void [override] Sets selected items based on the caretIndex and anchorIndex properties. | AdvancedDataGrid
|  | focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus. | UIComponent
|  | focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus. | UIComponent
|  | generateMXMLAttributes(data:Array):void | UIComponent
|  | generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent
|  | generateMXMLObject(document:Object, data:Array):Object | UIComponent
|  | getCellRendererInfo(row:IOLAPAxisPosition, column:IOLAPAxisPosition):OLAPDataGridItemRendererProvider Decide which renderer to use for the particular cell. | OLAPDataGrid
|  | getFormattedCellValue(label:String, row:IOLAPAxisPosition, col:IOLAPAxisPosition):String Applies the formatting associated with a particular cell to a String value. | OLAPDataGrid
|  | getHeaderRenderer(c:AdvancedDataGridColumn):IListItemRenderer Returns the header item renderer. | AdvancedDataGridBase
|  | getIndent(position:IOLAPAxisPosition, m:IOLAPMember, mIndex:int):int Returns the indent, in pixels, of the label in a renderer. | OLAPDataGrid
|  | getReservedOrFreeItemRenderer(data:Object):IListItemRenderer Retrieves an already-created item renderer not currently in use. | AdvancedListBase
|  | getRowHeight(itemData:Object = null):Number Returns the row height. | AdvancedDataGridBase
|  | getSeparator(i:int, seperators:Array, headerLines:UIComponent):UIComponent Returns the header separators between column headers, and populates the separators Array with the separators returned. | AdvancedDataGridBaseEx
|  | indexToColNum(columnIndex:int):int Returns the column number of a currently displayed column as it is currently displayed. | AdvancedDataGridBaseEx
|  | indexToColumn(index:int):int The column for the data provider item at the given index. | AdvancedListBase
|  | indexToRow(index:int):int The row for the data provider item at the given index. | AdvancedListBase
|  | initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. | UIComponent
|  | initializationComplete():void Finalizes the initialization of this component. | UIComponent
|  | initializeAccessibility():void Initializes this component's accessibility code. | UIComponent
|  | initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void Initiates a data change effect when there have been changes in the data provider. | AdvancedListBase
|  | initListData(item:Object, adgListData:AdvancedDataGridListData):void Initializes an AdvancedDataGridListData object that is used by the AdvancedDataGrid item renderer. | AdvancedDataGrid
|  | invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true). | UIComponent
|  | isCellSelectionMode():Boolean Returns true if selectedMode is SINGLE_CELL or MULTIPLE_CELLS. | AdvancedDataGridBase
|  | isColumnFullyVisible(columnIndex:int, rowIndex:int = -1):Boolean Returns true if the specified row in a column is visible. | AdvancedDataGridBaseEx
|  | isDataEditable(data:Object):Boolean Checks if editing is allowed for a group or summary row. | AdvancedDataGridBaseEx
|  | isDraggingAllowed(draggedColumn:AdvancedDataGridColumn):Boolean Checks if dragging is allowed for a particular column or not. | AdvancedDataGridBaseEx
|  | isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus. | UIComponent
|  | isRendererUnconstrained(item:Object):Boolean Returns true if an item renderer is no longer being positioned by the list's layout algorithm while a data change effect is running as a result of a call to the unconstrainRenderer() method. | AdvancedListBase
|  | isRowSelectionMode():Boolean Return true if selectedMode is SINGLE_ROW or MULTIPLE_ROWS. | AdvancedDataGridBase
|  | itemRendererToIndices(item:IListItemRenderer):Point Returns a Point instance containing the column index and row index of an item renderer. | AdvancedListBase
|  | itemToUID(data:Object):String Determines the UID for a data provider item. | AdvancedListBase
|  | keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event. | UIComponent
|  | keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event. | UIComponent
|  | layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Responds to size changes by setting the positions and sizes of this control's borders. | ScrollControlBase
|  | makeListData(data:Object, uid:String, rowNum:int, columnNum:int, column:AdvancedDataGridColumn):BaseListData Creates a new AdvancedDataGridListData instance and populates the fields based on the input data provider item. | AdvancedDataGridBase
|  | measure():void [override] Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties. | AdvancedListBase
|  | mouseClickHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_CLICK events from any mouse targets contained in the list including the renderers. | AdvancedListBase
|  | mouseDoubleClickHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any mouse targets contained in the list including the renderers. | AdvancedListBase
|  | mouseDownHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers. | AdvancedListBase
|  | mouseEventToItemRenderer(event:MouseEvent):IListItemRenderer Determines which item renderer is under the mouse. | AdvancedListBase
|  | mouseMoveHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_MOVE events from any mouse targets contained in the list including the renderers. | AdvancedListBase
|  | mouseOutHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_OUT events from any mouse targets contained in the list including the renderers. | AdvancedListBase
|  | mouseOverHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_OVER events from any mouse targets contained in the list, including the renderers. | AdvancedListBase
|  | mouseUpHandler(event:MouseEvent):void Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers. | AdvancedListBase
|  | mouseWheelHandler(event:MouseEvent):void [override] Handles mouseWheel events by changing scroll positions. | AdvancedListBase
|  | moveIndicators(uid:String, offset:int, absolute:Boolean):void [override] Moves the cell and row selection indicators up or down by the given offset as the control scrolls its display. | AdvancedDataGrid
|  | moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void Move the selection and highlight indicators horizontally. | AdvancedListBase
|  | moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void Move the selection and highlight indicators vertically. | AdvancedListBase
|  | moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void Moves the selection in a horizontal direction in response to the user selecting items using the left-arrow or right-arrow keys and modifiers such as the Shift and Ctrl keys. | AdvancedListBase
|  | moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void Moves the selection in a vertical direction in response to the user selecting items using the up-arrow or down-arrow Keys and modifiers such as the Shift and Ctrl keys. | AdvancedListBase
|  | removeCellSelectionData(uid:String, columnIndex:int):void Removes cell selection information from the control. | AdvancedDataGrid
|  | removeIndicators(uid:String):void Cleans up selection highlights and other associated graphics for a given item in the data provider. | AdvancedListBase
|  | resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way. | UIComponent
|  | roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean Determines if there is enough space in this component to display a given scrollbar. | ScrollControlBase
|  | scrollHandler(event:Event):void Default event handler for the scroll event. | ScrollControlBase
|  | scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void Adjusts the renderers in response to a change in scroll position. | AdvancedListBase
|  | scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int Returns the data provider index for the item at the first visible row and column for the given scroll positions. | AdvancedListBase
|  | scrollToViewColumn(newColumnIndex:int, columnIndex:int):void Changes the value of the horizontalScrollPosition property to make the specified column visible. | AdvancedDataGridBaseEx
|  | scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void Adjusts the renderers in response to a change in scroll position. | AdvancedListBase
|  | seekPendingFailureHandler(data:Object, info:ListBaseSeekPending):void The default failure handler when a seek fails due to a page fault. | AdvancedListBase
|  | seekPendingResultHandler(data:Object, info:ListBaseSeekPending):void The default result handler when a seek fails due to a page fault. | AdvancedListBase
|  | selectCellItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean Updates the list of selected cells, assuming that the specified item renderer was clicked by the mouse, and the keyboard modifiers are in the specified state. | AdvancedDataGrid
|  | selectColumnHeader(columnNumber:int):void Selects the specified column header. | AdvancedDataGridBaseEx
|  | selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean [override] Updates the set of selected items given that the item renderer provided was clicked by the mouse and the keyboard modifiers are in the given state. | AdvancedDataGrid
|  | setRowCount(v:int):void Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows. | AdvancedListBase
|  | setRowHeight(v:Number):void Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows. | AdvancedListBase
|  | setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in. | ScrollControlBase
|  | setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent
|  | setVisibleDataItem(uid:String, item:IListItemRenderer):void Sets the cell defined by uid to use the item renderer specified by item. | AdvancedDataGridBase
|  | stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component. | UIComponent
|  | unselectColumnHeader(columnNumber:int, completely:Boolean = false):void Deselects the specified column header. | AdvancedDataGridBaseEx
|  | updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Adds or removes item renderers if the number of displayable items changed. | AdvancedListBase
|  | updateList():void Refreshes all rows now. | AdvancedListBase
|  | visibleToAbsoluteColumnIndex(columnIndex:int):int Converts the current visible column index of a column to its corresponding absolute index. | AdvancedDataGridBaseEx

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | change | Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | AdvancedListBase
|  | columnStretch | Dispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed. | AdvancedDataGridBaseEx
|  | creationComplete | Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent
|  | currentStateChange | Dispatched after the view state has changed. | UIComponent
|  | currentStateChanging | Dispatched after the currentState property changes, but before the view state changes. | UIComponent
|  | dataChange | Dispatched when the data property changes. | AdvancedListBase
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectEnd | Dispatched after an effect ends. | UIComponent
|  | effectStart | Dispatched just before an effect starts. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | itemClick | Dispatched when the user clicks on an item in the control. | AdvancedListBase
|  | itemDoubleClick | Dispatched when the user double-clicks on an item in the control. | AdvancedListBase
|  | itemFocusIn | Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the AdvancedDataGrid control or navigates to the item using a keyboard. | AdvancedDataGridBaseEx
|  | itemFocusOut | Dispatched when an item renderer loses focus, which can occur if the user clicks another item in the AdvancedDataGrid control or clicks outside the control, or uses the keyboard to navigate to another item in the AdvancedDataGrid control or outside the control. | AdvancedDataGridBaseEx
|  | itemRollOut | Dispatched when the user rolls the mouse pointer out of an item in the control. | AdvancedListBase
|  | itemRollOver | Dispatched when the user rolls the mouse pointer over an item in the control. | AdvancedListBase
|  | mouseDownOutside | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent
|  | mouseWheelOutside | Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent
|  | move | Dispatched when the object has moved. | UIComponent
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | resize | Dispatched when the component is resized. | UIComponent
|  | scroll | Dispatched when the content is scrolled. | ScrollControlBase
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | sort | Dispatched when sorting is to be performed on the AdvancedDataGrid control. | AdvancedDataGridBaseEx
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | toolTipCreate | Dispatched by the component when it is time to create a ToolTip. | UIComponent
|  | toolTipEnd | Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent
|  | toolTipHide | Dispatched by the component when its ToolTip is about to be hidden. | UIComponent
|  | toolTipShow | Dispatched by the component when its ToolTip is about to be shown. | UIComponent
|  | toolTipShown | Dispatched by the component when its ToolTip has been shown. | UIComponent
|  | toolTipStart | Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | ScrollControlBase
|  | alternatingItemColors | Type: Array Format: Color CSS Inheritance: yes Colors for rows in an alternating pattern. | AdvancedDataGrid
|  | backgroundAlpha | Type: Number CSS Inheritance: no Theme: halo Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style. | ScrollControlBase
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: halo Background color of a component. | ScrollControlBase
|  | backgroundDisabledColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | ScrollControlBase
|  | backgroundImage | Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | ScrollControlBase
|  | backgroundSize | Type: String CSS Inheritance: no Theme: halo Scales the image specified by `backgroundImage` to different percentage sizes. | ScrollControlBase
|  | baseline | Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | borderAlpha | Type: Number CSS Inheritance: no Theme: spark Alpha of the border. | ScrollControlBase
|  | borderColor | Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | ScrollControlBase
|  | borderSides | Type: String CSS Inheritance: no Theme: halo Bounding box sides. | ScrollControlBase
|  | borderSkin | Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase
|  | borderStyle | Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase
|  | borderThickness | Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | ScrollControlBase
|  | borderVisible | Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | ScrollControlBase
|  | bottom | Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent
|  | chromeColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | ScrollControlBase
|  | color | Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase
|  | columnAxisHeaderStyleName | Type: String CSS Inheritance: no The name of a CSS style declaration for controlling aspects of the appearance of the column axis headers. The default value is `undefined`, which means it uses the value of the `headerStyleName` style. | OLAPDataGrid
|  | columnResizeSkin | Type: Class CSS Inheritance: no The class to use as the skin for a column that is being resized. | AdvancedDataGridBaseEx
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | ScrollControlBase
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | ScrollControlBase
|  | dataChangeEffect | Type: Object CSS Inheritance: no The effect used when changes occur in the control's data provider. | AdvancedListBase
|  | defaultDataGridItemEditor | Type: Class CSS Inheritance: no Name of the class of the itemEditor to be used if one is not specified for a column. | AdvancedDataGridBaseEx
|  | defaultDataGridItemRenderer | Type: Class CSS Inheritance: no Name of the class of the itemRenderer to be used if one is not specified for a column. | AdvancedDataGridBaseEx
|  | direction | Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | ScrollControlBase
|  | disabledColor | Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ScrollControlBase
|  | disabledIconColor | Type: uint Format: Color CSS Inheritance: yes The color for the icon in a disabled skin. | AdvancedDataGridBaseEx
|  | disclosureClosedIcon | Type: Class Format: EmbeddedFile CSS Inheritance: no The icon that is displayed next to a closed branch node of the navigation tree. | AdvancedDataGrid
|  | disclosureOpenIcon | Type: Class Format: EmbeddedFile CSS Inheritance: no The icon that is displayed next to an open branch node of the navigation tree. | AdvancedDataGrid
|  | dropIndicatorSkin | Type: Class CSS Inheritance: no The skin to use to indicate where a dragged item can be dropped. | AdvancedListBase
|  | dropShadowColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Color of the drop shadow. | ScrollControlBase
|  | dropShadowEnabled | Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase
|  | dropShadowVisible | Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase
|  | errorColor | Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent
|  | focusAlpha | Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | AdvancedListBase
|  | focusBlendMode | Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent
|  | focusColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | ScrollControlBase
|  | focusRoundedCorners | Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | AdvancedListBase
|  | focusSkin | Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent
|  | focusThickness | Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent
|  | fontAntiAliasType | Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields. See also flash.text.TextField flash.text.AntiAliasType | ScrollControlBase
|  | fontFamily | Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase
|  | fontGridFitType | Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField flash.text.GridFitType | ScrollControlBase
|  | fontSharpness | Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | ScrollControlBase
|  | fontSize | Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase
|  | fontStyle | Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase
|  | fontThickness | Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls. See also flash.text.TextField | ScrollControlBase
|  | fontWeight | Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase
|  | headerBackgroundSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the background of the column headers in a AdvancedDataGrid control. | AdvancedDataGridBaseEx
|  | headerColors | Type: Array Format: Color CSS Inheritance: yes An array of two colors used to draw the header background gradient. | AdvancedDataGridBaseEx
|  | headerHorizontalSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separators between column headers of different depth in a AdvancedDataGrid control. | AdvancedDataGrid
|  | headerSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between column headers in a AdvancedDataGrid control. | AdvancedDataGridBaseEx
|  | horizontalCenter | Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | horizontalGridLineColor | Type: uint Format: Color CSS Inheritance: yes The color of the horizontal grid lines. | AdvancedDataGridBaseEx
|  | horizontalGridLines | Type: Boolean CSS Inheritance: no A flag that indicates whether to show horizontal grid lines between the rows. | AdvancedDataGridBaseEx
|  | horizontalLockedSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between the locked and unlocked rows in a AdvancedDataGrid control. | AdvancedDataGridBaseEx
|  | horizontalScrollBarStyleName | Type: String CSS Inheritance: no Style name for horizontal scrollbar. | ScrollControlBase
|  | horizontalSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between rows in a AdvancedDataGrid control. | AdvancedDataGridBaseEx
|  | iconColor | Type: uint Format: Color CSS Inheritance: yes The color for the icon in a skin. | AdvancedDataGridBaseEx
|  | indentation | Type: Number CSS Inheritance: no The indentation for each node of the navigation tree, in pixels. | AdvancedDataGrid
|  | interactionMode | Type: String CSS Inheritance: yes The primary interaction mode for this component. See also mx.core.InteractionMode.MOUSE mx.core.InteractionMode.TOUCH | UIComponent
|  | kerning | Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). | ScrollControlBase
|  | layoutDirection | Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also MXFTEText.css mx.core.ILayoutDirectionElement mx.core.LayoutDirection | UIComponent
|  | leading | Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ScrollControlBase
|  | left | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent
|  | letterSpacing | Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ScrollControlBase
|  | locale | Type: String CSS Inheritance: yes The locale of the text displayed by this component. | ScrollControlBase
|  | paddingBottom | Type: Number Format: Length CSS Inheritance: no The number of pixels between the bottom of the row and the bottom of the renderer in the row. | AdvancedListBase
|  | paddingLeft | Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's left border and the left edge of its content area. | AdvancedDataGrid
|  | paddingRight | Type: Number Format: Length CSS Inheritance: no Number of pixels between the control's right border and the right edge of its content area. | AdvancedDataGrid
|  | paddingTop | Type: Number Format: Length CSS Inheritance: no The number of pixels between the top of the row and the top of the renderer in the row. | AdvancedListBase
|  | right | Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent
|  | rollOverColor | Type: uint Format: Color CSS Inheritance: yes The color of the row background when the user rolls over the row. | AdvancedDataGridBaseEx
|  | rowAxisHeaderStyleName | Type: String CSS Inheritance: no The name of a CSS style declaration for controlling aspects of the appearance of the row axis headers. The default value is `undefined`, which means it uses the value of the `headerStyleName` style. | OLAPDataGrid
|  | selectionColor | Type: uint Format: Color CSS Inheritance: yes The color of the background for the row when the user selects an item renderer in the row. | AdvancedDataGridBaseEx
|  | selectionDisabledColor | Type: uint Format: Color CSS Inheritance: yes The disabled color of a list item. | AdvancedDataGrid
|  | selectionDuration | Type: Number Format: Time CSS Inheritance: no The duration of the selection effect. | AdvancedListBase
|  | selectionEasingFunction | Type: Function CSS Inheritance: no Reference to an `easingFunction` function used for controlling programmatic tweening. | AdvancedDataGrid
|  | shadowDirection | Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | ScrollControlBase
|  | shadowDistance | Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | ScrollControlBase
|  | showErrorSkin | Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent
|  | stretchCursor | Type: Class CSS Inheritance: no The class to use as the skin for the cursor that indicates that a column can be resized. | AdvancedDataGridBaseEx
|  | symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | ScrollControlBase
|  | textAlign | Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase
|  | textDecoration | Type: String CSS Inheritance: yes Determines whether the text is underlined. | ScrollControlBase
|  | textFieldClass | Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | ScrollControlBase
|  | textIndent | Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | ScrollControlBase
|  | textRollOverColor | Type: uint Format: Color CSS Inheritance: yes Color of the text when the user rolls over a row. | AdvancedDataGrid
|  | textSelectedColor | Type: uint Format: Color CSS Inheritance: yes Color of the text when the user selects a row. | AdvancedDataGrid
|  | themeColor | Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent
|  | top | Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent
|  | useRollOver | Type: Boolean CSS Inheritance: no A flag that controls whether items are highlighted as the mouse rolls over them. | AdvancedListBase
|  | verticalAlign | Type: String CSS Inheritance: no The vertical alignment of a renderer in a row. | AdvancedListBase
|  | verticalCenter | Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | verticalGridLineColor | Type: uint Format: Color CSS Inheritance: yes The color of the vertical grid lines. | AdvancedDataGridBaseEx
|  | verticalGridLines | Type: Boolean CSS Inheritance: no A flag that indicates whether to show vertical grid lines between the columns. | AdvancedDataGridBaseEx
|  | verticalLockedSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separator between the locked and unlocked columns in a AdvancedDataGrid control. | AdvancedDataGridBaseEx
|  | verticalScrollBarStyleName | Type: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase
|  | verticalSeparatorSkin | Type: Class CSS Inheritance: no The class to use as the skin that defines the appearance of the separators between columns in a AdvancedDataGrid control. | AdvancedDataGridBaseEx

Effects
Hide Inherited Effects
Show Inherited Effects

| Effect | Description | Defined By
--- | --- | --- | ---
|  | addedEffect | Triggering Event: added Played when the component is added as a child to a Container. | UIComponent
|  | creationCompleteEffect | Triggering Event: creationComplete Played when the component is created. | UIComponent
|  | focusInEffect | Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent
|  | focusOutEffect | Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent
|  | hideEffect | Triggering Event: hide Played when the component becomes invisible. | UIComponent
|  | mouseDownEffect | Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent
|  | mouseUpEffect | Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent
|  | moveEffect | Triggering Event: move Played when the component is moved. | UIComponent
|  | removedEffect | Triggering Event: removed Played when the component is removed from a Container. | UIComponent
|  | resizeEffect | Triggering Event: resize Played when the component is resized. | UIComponent
|  | rollOutEffect | Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent
|  | rollOverEffect | Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent
|  | showEffect | Triggering Event: show Played when the component becomes visible. | UIComponent

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | COLUMN_AXIS : int = 0 [static] A constant that corresponds to the column axis. | OLAPDataGrid
|  | DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property. | UIComponent
|  | DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property. | UIComponent
|  | DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property. | UIComponent
|  | DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property. | UIComponent
|  | DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property. | UIComponent
|  | HEADER_ICON_PART : String = headerIconPart [static] Indicates that the mouse is over the header part of the header. | AdvancedDataGrid
|  | HEADER_TEXT_PART : String = headerTextPart [static] Indicates mouse is over the text part of the header. | AdvancedDataGrid
|  | MULTIPLE_CELLS : String = multipleCells [static] Constant definition for the selectionMode property to allow the selection of multiple cells. | AdvancedDataGridBase
|  | MULTIPLE_ROWS : String = multipleRows [static] Constant definition for the selectionMode property to allow the selection of multiple rows. | AdvancedDataGridBase
|  | NONE : String = none [static] Constant definition for the selectionMode property. | AdvancedDataGridBase
|  | OLAP_DIMENSION : int = 3 [static] A constant that corresponds to a member of an axis. | OLAPDataGrid
|  | OLAP_HIERARCHY : int = 2 [static] A constant that corresponds to a member of an axis. | OLAPDataGrid
|  | OLAP_LEVEL : int = 1 [static] A constant that corresponds to a level of an axis. | OLAPDataGrid
|  | OLAP_MEMBER : int = 0 [static] A constant that corresponds to a member of an axis. | OLAPDataGrid
|  | ROW_AXIS : int = 1 [static] A constant that corresponds to the row axis. | OLAPDataGrid
|  | SINGLE_CELL : String = singleCell [static] Constant definition for the selectionMode property to allow the selection of a single cell. | AdvancedDataGridBase
|  | SINGLE_ROW : String = singleRow [static] Constant definition for the selectionMode property to allow the selection of a single row. | AdvancedDataGridBase
|  | SLICER_AXIS : int = 2 [static] A constant that corresponds to the slicer axis. | OLAPDataGrid

Property Detail

dataProvider | property

`dataProvider:Object`[override]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

An OLAPDataGrid accepts only an IOLAPResult as dataProvider other dataProviders are simply ignored. One can set dataProvider to null, to reset the control.

Implementation
`public function get dataProvider():Object`
`public function set dataProvider(value:Object):void`

defaultCellString | property |

`public var defaultCellString:String = NaN`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

String displayed in a cell when the data for that cell returned by the IOLAPResult instance is null or NaN.

The default value is `"NaN"`.

headerRendererProviders | property |

`headerRendererProviders:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Array of OLAPDataGridHeaderRendererProvider instances that specify a custom header renderer for the columns of the control. You can use several header renderer providers to specify custom header renderers for different columns the control.

Implementation
`public function get headerRendererProviders():Array`
`public function set headerRendererProviders(value:Array):void`

itemRendererProviders | property |

`itemRendererProviders:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Array of OLAPDataGridItemRendererProvider instances that specify a custom item renderer for the cells of the control. You can use several renderer providers to specify custom item renderers used for different locations in the control.

Implementation
`public function get itemRendererProviders():Array`
`public function set itemRendererProviders(value:Array):void`

styleFunction | property |

`styleFunction:Function`[override]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A callback function called while rendering each cell in the cell data area. The signature of the callback function is:

    function myStyleFunction(row:IOLAPAxisPosition, column:IOLAPAxisPosition, value:Number):Object

where `row` is the IOLAPAxisPosition associated with this cell on row axis, `column` is the IOLAPAxisPosition associated with this cell on column axis and `value` is the cell value.

The return value should be a Object with styles as properties. For example: `{ color:0xFF0000, fontWeight:"bold" }`.

In case when the value in the cell is NaN, the function is called with NaN as the last argument

Implementation
`public function get styleFunction():Function`
`public function set styleFunction(value:Function):void`
Constructor Detail

OLAPDataGrid | () | Constructor

`public function OLAPDataGrid()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Method Detail

getCellRendererInfo | () | method

`protected function getCellRendererInfo(row:IOLAPAxisPosition, column:IOLAPAxisPosition):OLAPDataGridItemRendererProvider`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Decide which renderer to use for the particular cell. A cell falls at the intersection of a position on row as well as column axis, thus it can fall in rules defined by the `itemRendererProviders` property for both axis. This method gives row axis a priority and searches for the the right value of the `itemRendererProviders` property to be used for the renderer.

Parameters

| `row:IOLAPAxisPosition` — The position of the cell in a row axis.
| `column:IOLAPAxisPosition` — The position of the cell in a column axis.

Returns

| `OLAPDataGridItemRendererProvider` — The item renderer to use for the cell at the intersection of the row and column axis.

getFormattedCellValue | () | method |

`protected function getFormattedCellValue(label:String, row:IOLAPAxisPosition, col:IOLAPAxisPosition):String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Applies the formatting associated with a particular cell to a String value. A cell falls at the intersection of a position on row as well as column axis.

Parameters

| `label:String` — The String value to be formatted.
| `row:IOLAPAxisPosition` — The position of the cell in a row axis with an associated formatter.
| `col:IOLAPAxisPosition` — The position of the cell in a column axis with an associated formatter.

Returns

| `String` — The formatted value of `label`, or `label` if the cell does not exist or the cell does not have a formatter applied to it.

getIndent | () | method |

`protected function getIndent(position:IOLAPAxisPosition, m:IOLAPMember, mIndex:int):int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns the indent, in pixels, of the label in a renderer.

Parameters

| `position:IOLAPAxisPosition` — The position of the renderer on the axis.
| `m:IOLAPMember` — The member of the dimension to which the indent is requested.
| `mIndex:int` — The index of `m` in `position.members`.

Returns

| `int` — The indent, in pixels, of the label in a renderer.

styleChanged | () | method |

`override public function styleChanged(styleProp:String):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called when the value of a style property is changed.

Parameters

| `styleProp:String` — The name of the style property that changed.

Constant Detail

COLUMN_AXIS | Constant

`public static const COLUMN_AXIS:int = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to the column axis.

OLAP_DIMENSION | Constant |

`public static const OLAP_DIMENSION:int = 3`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to a member of an axis.

OLAP_HIERARCHY | Constant |

`public static const OLAP_HIERARCHY:int = 2`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to a member of an axis.

OLAP_LEVEL | Constant |

`public static const OLAP_LEVEL:int = 1`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to a level of an axis.

OLAP_MEMBER | Constant |

`public static const OLAP_MEMBER:int = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to a member of an axis.

ROW_AXIS | Constant |

`public static const ROW_AXIS:int = 1`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to the row axis.

SLICER_AXIS | Constant |

`public static const SLICER_AXIS:int = 2`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

A constant that corresponds to the slicer axis.

Examples
OLAPDataGridExample.mxml

    <?xml version="1.0"?>
    <!--

      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.

    -->
    <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx"
            creationComplete="creationCompleteHandler();">

        <fx:Script>
          <![CDATA[
            import mx.rpc.AsyncResponder;
            import mx.rpc.AsyncToken;
            import mx.olap.OLAPQuery;
            import mx.olap.OLAPSet;
            import mx.olap.IOLAPQuery;
            import mx.olap.IOLAPQueryAxis;
            import mx.olap.IOLAPCube;
            import mx.olap.OLAPResult;
            import mx.events.CubeEvent;
            import mx.controls.Alert;
            import mx.collections.ArrayCollection;

            //
            // Format of Objects in the ArrayCollection:
            //
            //  data:Object = {
            //    customer:"AAA",
            //    product:"ColdFusion",
            //    quarter:"Q1"
            //    revenue: "100.00"
            //  }
            //

            [Bindable]
            private var flatData:ArrayCollection = new ArrayCollection(
            [
             {customer:"AAA", product:"ColdFusion", quarter:"Q1", revenue:210, cost:25},
             {customer:"AAA", product:"Flex", quarter:"Q2", revenue:210, cost:25},
             {customer:"AAA", product:"Dreamweaver", quarter:"Q3", revenue:250, cost:125},
             {customer:"AAA", product:"Flash", quarter:"Q4", revenue:430, cost:75},

             {customer:"BBB", product:"ColdFusion", quarter:"Q2", revenue:125, cost:20},
             {customer:"BBB", product:"Flex", quarter:"Q3", revenue:210, cost:20},
             {customer:"BBB", product:"Dreamweaver", quarter:"Q4", revenue:320, cost:120},
             {customer:"BBB", product:"Flash", quarter:"Q1", revenue:280, cost:70},

             {customer:"CCC", product:"ColdFusion", quarter:"Q3", revenue:375, cost:120},
             {customer:"CCC", product:"Flex", quarter:"Q4", revenue:430, cost:120},
             {customer:"CCC", product:"Dreamweaver", quarter:"Q1", revenue:470, cost:220},
             {customer:"CCC", product:"Flash", quarter:"Q2", revenue:570, cost:170},

             {customer:"AAA", product:"ColdFusion", quarter:"Q4", revenue:215, cost:90},
             {customer:"AAA", product:"Flex", quarter:"Q1", revenue:210, cost:90},
             {customer:"AAA", product:"Dreamweaver", quarter:"Q2", revenue:175, cost:190},
             {customer:"AAA", product:"Flash", quarter:"Q3", revenue:670, cost:75},

             {customer:"BBB", product:"ColdFusion", quarter:"Q1", revenue:175, cost:20},
             {customer:"BBB", product:"Flex", quarter:"Q2", revenue:210, cost:20},
             {customer:"BBB", product:"Dreamweaver",quarter:"Q3", revenue:120, cost:120},
             {customer:"BBB", product:"Flash", quarter:"Q4", revenue:310, cost:70},

             {customer:"CCC", product:"ColdFusion", quarter:"Q1", revenue:385, cost:120},
             {customer:"CCC", product:"Flex", quarter:"Q2", revenue:340, cost:120},
             {customer:"CCC", product:"Dreamweaver", quarter:"Q3", revenue:470, cost:220},
             {customer:"CCC", product:"Flash", quarter:"Q4", revenue:270, cost:170},

             {customer:"AAA", product:"ColdFusion", quarter:"Q1", revenue:100, cost:25},
             {customer:"AAA", product:"Flex", quarter:"Q2", revenue:150, cost:25},
             {customer:"AAA", product:"Dreamweaver", quarter:"Q3", revenue:200, cost:125},
             {customer:"AAA", product:"Flash", quarter:"Q4", revenue:300, cost:75},

             {customer:"BBB", product:"ColdFusion", quarter:"Q2", revenue:175, cost:20},
             {customer:"BBB", product:"Flex", quarter:"Q3", revenue:100, cost:20},
             {customer:"BBB", product:"Dreamweaver", quarter:"Q4", revenue:270, cost:120},
             {customer:"BBB", product:"Flash", quarter:"Q1", revenue:370, cost:70},

             {customer:"CCC", product:"ColdFusion", quarter:"Q3", revenue:410, cost:120},
             {customer:"CCC", product:"Flex", quarter:"Q4", revenue:300, cost:320},
             {customer:"CCC", product:"Dreamweaver", quarter:"Q1", revenue:510, cost:220},
             {customer:"CCC", product:"Flash", quarter:"Q2", revenue:620, cost:170},

             {customer:"AAA", product:"ColdFusion", quarter:"Q4", revenue:215, cost:90},
             {customer:"AAA", product:"Flex", quarter:"Q1", revenue:210, cost:90},
             {customer:"AAA", product:"Dreamweaver", quarter:"Q2", revenue:175, cost:190},
             {customer:"AAA", product:"Flash", quarter:"Q3", revenue:420, cost:75},

             {customer:"BBB", product:"ColdFusion", quarter:"Q1", revenue:240, cost:20},
             {customer:"BBB", product:"Flex", quarter:"Q2", revenue:100, cost:20},
             {customer:"BBB", product:"Dreamweaver", quarter:"Q3", revenue:270, cost:120},
             {customer:"BBB", product:"Flash", quarter:"Q4", revenue:370, cost:70},

             {customer:"CCC", product:"ColdFusion", quarter:"Q1", revenue:375, cost:120},
             {customer:"CCC", product:"Flex", quarter:"Q2", revenue:420, cost:120},
             {customer:"CCC", product:"Dreamweaver", quarter:"Q3", revenue:680, cost:220},
             {customer:"CCC", product:"Flash", quarter:"Q4", revenue:570, cost:170}
            ]);

            private function creationCompleteHandler():void {
                // You must initialize the cube before you
                // can execute a query on it.
                myMXMLCube.refresh();
            }

            // Create the OLAP query.
            private function getQuery(cube:IOLAPCube):IOLAPQuery {
                // Create an instance of OLAPQuery to represent the query.
                var query:OLAPQuery = new OLAPQuery;

                // Get the row axis from the query instance.
                var rowQueryAxis:IOLAPQueryAxis =
                    query.getAxis(OLAPQuery.ROW_AXIS);
                // Create an OLAPSet instance to configure the axis.
                var productSet:OLAPSet = new OLAPSet;
                // Add the Product to the row to aggregate data
                // by the Product dimension.
                productSet.addElements(
                    cube.findDimension("ProductDim").findAttribute("Product").children);
                // Add the OLAPSet instance to the axis.
                rowQueryAxis.addSet(productSet);

                // Get the column axis from the query instance, and configure it
                // to aggregate the columns by the Quarter dimension.
                var colQueryAxis:IOLAPQueryAxis =
                    query.getAxis(OLAPQuery.COLUMN_AXIS);
                var quarterSet:OLAPSet= new OLAPSet;
                quarterSet.addElements(
                    cube.findDimension("QuarterDim").findAttribute("Quarter").children);
                colQueryAxis.addSet(quarterSet);

                return query;
            }

            // Event handler to execute the OLAP query
            // after the cube completes initialization.
            private function runQuery(event:CubeEvent):void {
                // Get cube.
                var cube:IOLAPCube = IOLAPCube(event.currentTarget);
                // Create a query instance.
                var query:IOLAPQuery = getQuery(cube);
                // Execute the query.
                var token:AsyncToken = cube.execute(query);
                // Setup handlers for the query results.
                token.addResponder(new AsyncResponder(showResult, showFault));
            }

            // Handle a query fault.
            private function showFault(result:Object, token:Object):void {
                Alert.show("Error in query.");
            }

            // Handle a successful query by passing the query results to
            // the OLAPDataGrid control..
            private function showResult(result:Object, token:Object):void {
                if (!result) {
                    Alert.show("No results from query.");
                    return;
                }
                myOLAPDG.dataProvider= result as OLAPResult;
            }
          ]]>
        </fx:Script>

        <fx:Declarations>
            <mx:OLAPCube name="FlatSchemaCube"
                dataProvider="{flatData}"
                id="myMXMLCube"
                complete="runQuery(event);">

                <mx:OLAPDimension name="CustomerDim">
                    <mx:OLAPAttribute name="Customer" dataField="customer"/>
                    <mx:OLAPHierarchy name="CustomerHier" hasAll="true">
                        <mx:OLAPLevel attributeName="Customer"/>
                    </mx:OLAPHierarchy>
                </mx:OLAPDimension>

                <mx:OLAPDimension name="ProductDim">
                    <mx:OLAPAttribute name="Product" dataField="product"/>
                    <mx:OLAPHierarchy name="ProductHier" hasAll="true">
                        <mx:OLAPLevel attributeName="Product"/>
                    </mx:OLAPHierarchy>
                </mx:OLAPDimension>

                <mx:OLAPDimension name="QuarterDim">
                    <mx:OLAPAttribute name="Quarter" dataField="quarter"/>
                    <mx:OLAPHierarchy name="QuarterHier" hasAll="true">
                        <mx:OLAPLevel attributeName="Quarter"/>
                    </mx:OLAPHierarchy>
                </mx:OLAPDimension>

                <mx:OLAPMeasure name="Revenue"
                    dataField="revenue"
                    aggregator="SUM"/>
            </mx:OLAPCube>
        </fx:Declarations>

        <mx:Panel title="OLAPCube Control Example"
            height="75%" width="75%" layout="horizontal"
            paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">

            <mx:OLAPDataGrid id="myOLAPDG" width="100%" height="100%"/>
        </mx:Panel>
    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00