mx.controls.olapDataGridClasses

# OLAPDataGridItemRendererProvider - AS3 Flex

Package | mx.controls.olapDataGridClasses
Class | public class OLAPDataGridItemRendererProvider
Inheritance | OLAPDataGridItemRendererProvider OLAPDataGridRendererProvider Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

An OLAPDataGridItemRendererProvider instance lets you specify a formatter for the items in the OLAPDataGrid control.

Related API Elements

mx.controls.OLAPDataGrid
mx.formatters.Formatter

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | formatter : Formatter An instance of the Formatter class, or of a subclass of the Formatter class, applied to the text to of the associated IOLAPElement. | OLAPDataGridItemRendererProvider
|  | renderer : IFactory The renderer object used for customizing the OLAPDataGrid control. | OLAPDataGridRendererProvider
|  | styleName : String The name of a CSS style declaration for controlling the appearance of the cell. | OLAPDataGridRendererProvider
|  | type : int Specifies whether the renderer is applied to a dimension (OLAPDataGrid.OLAP_DIMENSION), hierarchy(OLAPDataGrid.OLAP_HIERARCHY), level(OLAPDataGrid.OLAP_LEVEL), or member (OLAPDataGrid.OLAP_MEMBER) of an axis. | OLAPDataGridRendererProvider
|  | uniqueName : String The unique name of the IOLAPElement to which the renderer is applied. | OLAPDataGridRendererProvider

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### formatter

property

`public var formatter:Formatter`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

An instance of the Formatter class, or of a subclass of the Formatter class, applied to the text to of the associated IOLAPElement.

For example, you apply a CurrencyFormatter formatter to an OLAPDataGrid control, as the following example shows:

          <mx:CurrencyFormatter id="usdFormatter" precision="2"
              currencySymbol="$" decimalSeparatorFrom="."
              decimalSeparatorTo="." useNegativeSign="true"
              useThousandsSeparator="true" alignSymbol="left"/>

          ...

          <mx:OLAPDataGrid id="myOLAPDG"
              width="100%" height="100%">

              <mx:itemRendererProviders>
                  <mx:OLAPDataGridItemRendererProvider
                      uniqueName="[QuarterDim].[Quarter]"
                      type="{OLAPDataGrid.OLAP_HIERARCHY}"
                      formatter="{usdFormatter}"/>
              </mx:itemRendererProviders>
          </mx:OLAPDataGrid>

In this example, the `uniqueName` and `type` properties specify that Quarter is a hierarchy of the QuarterDim dimension.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00