| Package | at.datacollection |
| Class | public class DataItemOverlay |
| Inheritance | DataItemOverlay  DataItemGeneric |
| Property | Defined by | ||
|---|---|---|---|
 | bookEnd : BookEndRow
The Book End for this data collection element per the IDataItem implementation
| DataItemGeneric | |
| bookEndTime : Date
Internal variable to store the Book End date for this item.
| DataItemGeneric | |
| bookStart : BookStartRow
The Book Start for this data collection element per the IDataItem implementation
| DataItemGeneric | |
| bookStartTime : Date
Internal variable to store the Book Start date for this item.
| DataItemGeneric | |
| dataWorkerOptions : uint
An unsigned integer (uint) that disables various elements of the data collection to be stored into the database
| DataItemGeneric | |
| endEvent : String
The event that will dispatch signaling the end of data collection of the generic item.
| DataItemGeneric | |
| friendlyName : String
A human readable name for your generic item
| DataItemGeneric | |
| itemType : String [read-only]
| DataItemOverlay | ||
| properties : Array
An array of string that correlate to public properties of the Target object.
| DataItemGeneric | |
| removeOnEndEvent : Boolean
A boolean to tell the data item worker to remove it from it's internal list once it has been pushed to the database.
| DataItemGeneric | |
| startEvent : String
The event that will dispatch signaling the beginning of data collection
| DataItemGeneric | |
| target : *
This will be the object responsible for providing values for the properties and dispatching the begin and end data collection events.
| DataItemGeneric | |
| uniqueID : String
The uniqueID that was provided in the Data Item Description.
| DataItemOverlay | ||
| Method | Defined by | ||
|---|---|---|---|
|
DataItemOverlay(dataWorkerOptions:uint, uniqueID:String = null)
This method enables the data collection of a single Overlay Window.
| DataItemOverlay | ||
|
addBookEndSlotData(args:Array):void
Pushes an array of data to be stored into the data collection database.
| DataItemGeneric | |
|
addBookEndSlotDataSingle(args:Array):void
Similar to the addBookEndSlotData it will add data to the data slots, however, it will store an unlimited amount to the database.
| DataItemGeneric | |
|
addBookStartSlotData(args:Array):void
Pushes an array of data to be stored into the DataCollection database.
| DataItemGeneric | |
|
addBookStartSlotDataSingle(args:Array):void
Similar to the addBookStartSlotData it will add data to the data slots, however, it will store an unlimited amount to the database.
| DataItemGeneric | |
| itemType | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesitemType:String [read-only]Implementation
public function get itemType():String
| uniqueID | property |
uniqueID:String [read-write]The uniqueID that was provided in the Data Item Description.
Implementation public function get uniqueID():String
public function set uniqueID(value:String):void
| DataItemOverlay | () | constructor |
public function DataItemOverlay(dataWorkerOptions:uint, uniqueID:String = null)This method enables the data collection of a single Overlay Window. When the Overlay Window is created it needs to be supplied with the optional parameter uniqueID. The uniqueID will be the value that the Data Item Worker will use to begin and end data collection of the Overlay Window. NOTE: If all overlay data collection is already enabled. Individual overlay requests will be ignored.
ParametersdataWorkerOptions:uint |
|
uniqueID:String (default = null) |
var ow:OverlayWindow = OverlayModule.createOverlay("file.swf",500,"TestOverlay",null,"TestOverlayUniqueID");
DataCollectionModule.addDataCollectionItem(new DataItemOverlay(DataWorkerOptions.USE_DEFAULTS,"TestOverlayUniqueID"));