Packagefr.kapit.elasticsearch
Classpublic class ElasticSearch
InheritanceElasticSearch Inheritance KapGroup Inheritance spark.components.Group

ElasticSearch is a Flex component that enables filtering and discovering of huge amount of data given several properties (filters). It can be considered as an information management and visualization tool. It is used specialy to browse the multi-facetted data structure in an interactive and navigable way. It handles, parses and analyses XML and CSV files and ICollectionView instances (Hierarchical). Using a custom parsing methods and filtering engine, any data (or metadata) can be clearly and properly filtered. The component shares several options for user interaction and visual customization.

Default MXML PropertymxmlContent



Public Properties
 PropertyDefined By
 InheritedanalysisPath : Object
An array used for CSV and General ICollectionView files and enables data source analysis with a given logic.
KapGroup
  animationDuration : Number = 500
ElasticSearch
 InheritedattributesDescriptor : AttributesDescriptor
It assigns to each column reference in the analysisPath its attributes.
KapGroup
  backgroundAlpha : Number
ElasticSearch
  backgroundColor : uint
ElasticSearch
  colorPolicy : String
The color Policy property is used to select the way items are colored.
ElasticSearch
 InheritedcsvDelimiter : String
CSV delimiter used for csv source parsing.
KapGroup
 InheritedcustomTreeDataDescriptor : ITreeDataDescriptor
Custom Tree Data descriptor for navigating inside data provider object.
KapGroup
  dataProvider : Object
[override] Visualizer Data provider.
ElasticSearch
  elasticSearchItemRenderer : Class
Item Renderer used for rendering the item of an ElasticFilter.
ElasticSearch
  filterLabels : Array
Array containing titles of each list, the filterLabels property should be an array and should be ordered in the same way that filterProperties are.
ElasticSearch
  filterPath : Array
[read-only] Filters content that have been already selected by the user.
ElasticSearch
  filterProperties : Array
This property is used to specify the properties that the user needs to use to parse his source data.
ElasticSearch
  filterResult : Object
[read-only]
ElasticSearch
  filtersUIMap : Dictionary
ElasticSearch
  firstColor : uint
The first color used to generate colors.
ElasticSearch
 InheritedgroupProperty : String
Property in a node data object (XML node for example) which value refers to the group dependency.The value is considered as the unique id of the group.
KapGroup
  idColumnHeader : String
The column Header of the CSV input that represents the unique Ids of the entities filtered in the compoenent (rows in the csv).
ElasticSearch
 InheritedidProperty : String
For any data item in any ICollectionView dataProvider (XML, array collection containing objects with children property), The idProperty is the property which value is considered as the unique id of the item (node, group or link).
KapGroup
  ignoreNullValues : Boolean = false
ElasticSearch
 InheritedignoreRoot : Boolean
Indicator if common root node of ICollectionView should be ignored.
KapGroup
  itemMaxHeight : Number
Maximal Height of each Filter item.
ElasticSearch
  itemMinHeight : Number
Minimal Height of each Filter item.
ElasticSearch
 InheritedkData : KData
[read-only] private
KapGroup
  labelFields : Array
Label Data fields that should be displayed on the ElasticSearchs items.
ElasticSearch
  lastColor : uint
The second color used to generate colors.
ElasticSearch
  lastModifiedFilter : ElasticFilter
[write-only]
ElasticSearch
  lastModifiedList : Group
[read-only] Last Filter entity that have been modified.
ElasticSearch
  layout : LayoutBase
[override] [write-only]
ElasticSearch
 InheritedlinkProperty : String
Property in a node data object depending to an ICollectionView dataProvider which value will be assigned to the created link.
KapGroup
 InheritedmergeDescriptor : MergeDescriptor
Descriptor defining merging tasks that must be applied on a CSV source before displaying it.
KapGroup
  nullValueString : String = null
ElasticSearch
  numFilters : uint
Number of displayed filters.
ElasticSearch
 InheritedrecordDelimiter : String
Record delimiter of CSV fields.
KapGroup
 InheritedreportingFunctions : Dictionary
Reporting functions used to compute a data field from an array of data fields generated after CSV parsing or advanced XML treatment.
KapGroup
  showToolTip : Boolean
Indicates if toolTips should be shown on the items.
ElasticSearch
 InheritedtypesDescriptor : Dictionary
Column types descriptor.
KapGroup
  useDefaultHeight : Boolean
the useDefaultHeight property is used to display an ElasticSearch whose items have the sameheight.
ElasticSearch
 InheritedwithHeaders : Boolean
Indicator if the CSV data provider first row are headers or not.
KapGroup
Protected Properties
 PropertyDefined By
 Inherited_analysisPath : Array
private
KapGroup
 Inherited_attributesDescriptor : AttributesDescriptor
private
KapGroup
 Inherited_csvDelimiter : String = ;
private
KapGroup
 Inherited_customTreeDataDescriptor : ITreeDataDescriptor
private
KapGroup
 Inherited_dataProvider : Object
private
KapGroup
 Inherited_dataProviderChanged : Boolean
private
KapGroup
 Inherited_dataProviderType : int
private
KapGroup
 Inherited_groupProperty : String
private
KapGroup
 Inherited_idProperty : String
private
KapGroup
 Inherited_ignoreRoot : Boolean
private
KapGroup
 Inherited_kData : KData
KapGroup
 Inherited_linkProperty : String
private
KapGroup
 Inherited_mergeDescriptor : MergeDescriptor
private
KapGroup
 Inherited_recordDelimiter : String
private
KapGroup
 Inherited_reportingFunctions : Dictionary
private
KapGroup
 Inherited_reportingFunctionsChanged : Boolean
private
KapGroup
 Inherited_typesDescriptor : Dictionary
private
KapGroup
 Inherited_useMultiLink : Boolean = true
private
KapGroup
 Inherited_withHeaders : Boolean = true
private
KapGroup
Public Methods
 MethodDefined By
  
constructor
ElasticSearch
 Inherited
addElement(element:IVisualElement):IVisualElement
[override]
KapGroup
 Inherited
addElementAt(element:IVisualElement, index:int):IVisualElement
[override]
KapGroup
  
addFilter(filterProperty:String, filterLabel:String):void
Adds a new Filter to the Elastic Lists if it doesn't yet exists.
ElasticSearch
  
ElasticSearch
  
getStyle(styleProp:String):*
[override]
ElasticSearch
  
manageSelection(filter:ElasticFilter, select:Boolean = true):void
ElasticSearch
  
removeFilter(filterProperty:String):void
Removes a Filter.
ElasticSearch
  
resetState(async:Boolean = true):void
ElasticSearch
 Inherited
setElementIndex(element:IVisualElement, index:int):void
[override]
KapGroup
  
setStyle(styleProp:String, newValue:*):void
[override]
ElasticSearch
  
styleChanged(styleProp:String):void
[override]
ElasticSearch
Protected Methods
 MethodDefined By
  
[override]
ElasticSearch
  
[override]
ElasticSearch
 Inherited
loadKData():void
Generate a common data descriptor from the dataProvider and other data manipulation options.
KapGroup
  
measure():void
[override]
ElasticSearch
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override]
ElasticSearch
Events
 Event Summary Defined By
  Indicates that a filter selection has changed.ElasticSearch
  Indicates that all filters have left from an all selected state to partially selected state.ElasticSearch
  Indicates that all filters has been selected and set.ElasticSearch
Styles
 Style Description Defined By
  
filterListBorderAlpha
Type: Number Format: Color CSS Inheritance: no
Filters List border alpha.
ElasticSearch
  
filterListBorderColor
Type: uint Format: Color CSS Inheritance: no
Filters List border color.
ElasticSearch
  
filterListBorderThickeness
Type: uint Format: Color CSS Inheritance: no
Filters List border thickeness.
ElasticSearch
  
filterListFillAlphas
Type: Array Format: Color CSS Inheritance: no
Filters List gradient fill alphas.
ElasticSearch
  
filterListFillColors
Type: Array Format: Color CSS Inheritance: no
Filters List gradient fill colors.
ElasticSearch
  
filterListFontColor
Type: uint Format: Color CSS Inheritance: no
Font color Filters List text.
ElasticSearch
  
filterListFontFamily
Type: String CSS Inheritance: no
Font family Filters List text.
ElasticSearch
  
filterListFontSize
Type: uint CSS Inheritance: no
Font size Filters List text.
ElasticSearch
  
filterListFontWeight
Type: String CSS Inheritance: no
Font weight Filters List text. Possible values are bold or normal.
ElasticSearch
  
filterListGap
Type: int Format: Length CSS Inheritance: no
Gap between Filter lists.
ElasticSearch
  
filterListHorizontalOffset
Type: uint CSS Inheritance: no
Horizontal offset of Filters List.
ElasticSearch
  
filterListSize
Type: uint Format: Length CSS Inheritance: no
Filter list size.
ElasticSearch
  
filterListVerticalOffset
Type: uint CSS Inheritance: no
Vertical offset of Filters List.
ElasticSearch
  
filterSkinClass
Type: Class
ElasticSearch
  
filterTitleBorderAlpha
Type: Number Format: Color CSS Inheritance: no
Filters Title border alpha.
ElasticSearch
  
filterTitleBorderColor
Type: uint Format: Color CSS Inheritance: no
Filters Title border color.
ElasticSearch
  
filterTitleBorderThickness
Type: uint Format: Color CSS Inheritance: no
Filters Title border thickeness.
ElasticSearch
  
filterTitleFillAlphas
Type: Array Format: Color CSS Inheritance: no
Filters Title gradient fill alphas.
ElasticSearch
  
filterTitleFillColors
Type: Array Format: Color CSS Inheritance: no
Filters Title gradient fill colors.
ElasticSearch
  
filterTitleFontColor
Type: uint Format: Color CSS Inheritance: no
Font color Filters Title text.
ElasticSearch
  
filterTitleFontFamily
Type: String CSS Inheritance: no
Font family Filters Title text.
ElasticSearch
  
filterTitleFontSize
Type: uint CSS Inheritance: no
Font size Filters Title text.
ElasticSearch
  
filterTitleFontWeight
Type: String CSS Inheritance: no
Font weight Filters Title text. Possible values are bold or normal
ElasticSearch
  
filterTitleHeight
Type: uint CSS Inheritance: no
Height of Filters Title.
ElasticSearch
  
filterTitleHorizontalOffset
Type: uint CSS Inheritance: no
Horizonatl offset Filters Title.
ElasticSearch
  
filterTitleTextAlign
Type: String CSS Inheritance: no
Horizontal Text Align of Filters Title. Values are center, right and left.
ElasticSearch
  
filterTitleVerticalOffset
Type: uint CSS Inheritance: no
Vertical offset Filters Title.
ElasticSearch
  
filterTitleVerticalTextAlign
Type: String CSS Inheritance: no
Vertical Text Align of Filters Title. Values are middle, top and bottom.
ElasticSearch
  
itemBackgroundAlpha
Type: Number Format: Color CSS Inheritance: no
Filter list items alpha.
ElasticSearch
  
itemReducedColor
Type: uint Format: Color CSS Inheritance: yes
Filter list items color at reduced state.
ElasticSearch
  
itemReducedSize
Type: uint CSS Inheritance: no
Filter list items height at reduce state.
ElasticSearch
  
itemRollOverColor
Type: uint Format: Color CSS Inheritance: yes
Filter list items color at Roll Over.
ElasticSearch
  
itemSelectionColor
Type: uint Format: Color CSS Inheritance: yes
Filter list items color at Selection.
ElasticSearch
  
itemSelectionSize
Type: uint CSS Inheritance: no
Filter list items height at selection.
ElasticSearch
  
itemSize
Type: uint CSS Inheritance: no
Filter list items uniform height. This style is only consumed in case where defautSize policy is selected.
ElasticSearch
Public Constants
 ConstantDefined By
 InheritedBICHROMATIC_COLORING : String = bichromatic
[static]
KapGroup
  COLOR_POLICY_BICHROMATIC : String = bichromatic
[static] Colors are generated by mixing firstColor and secondColor.
ElasticSearch
  COLOR_POLICY_MONOCHROMATIC : String = monochromatic
[static] Colors are generated by mixing firstColor and black.
ElasticSearch
  COLOR_POLICY_SPECTRUM : String = spectrum
[static] Colors are generated using basic colors.
ElasticSearch
 InheritedDEFAULT_COLORING : String = none
[static]
KapGroup
  MAX_HEIGHT : Number = 50
[static] Default Max Height.
ElasticSearch
  MIN_HEIGHT : Number = 20
[static] Default Min Height.
ElasticSearch
 InheritedMONOCHROMATIC_COLORING : String = monochromatic
[static]
KapGroup
 InheritedUNIFORM_COLORING : String = uniform
[static]
KapGroup
Property Detail
animationDurationproperty
public var animationDuration:Number = 500

backgroundAlphaproperty 
backgroundAlpha:Number


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorproperty 
backgroundColor:uint


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
colorPolicyproperty 
colorPolicy:String

The color Policy property is used to select the way items are colored. There are three different policies: Spectrum, Bichromatic,Monochromatic. The color of each will be computed using its weight (occurence) and the first and last color.


Implementation
    public function get colorPolicy():String
    public function set colorPolicy(value:String):void
dataProviderproperty 
dataProvider:Object[override]

Visualizer Data provider. It can be a :


Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void
elasticSearchItemRendererproperty 
elasticSearchItemRenderer:Class

Item Renderer used for rendering the item of an ElasticFilter. If not not, it will be used instead of the DefaultItemRender


Implementation
    public function get elasticSearchItemRenderer():Class
    public function set elasticSearchItemRenderer(value:Class):void
filterLabelsproperty 
filterLabels:Array

Array containing titles of each list, the filterLabels property should be an array and should be ordered in the same way that filterProperties are.


Implementation
    public function get filterLabels():Array
    public function set filterLabels(value:Array):void
filterPathproperty 
filterPath:Array  [read-only]

Filters content that have been already selected by the user.


Implementation
    public function get filterPath():Array
filterPropertiesproperty 
filterProperties:Array

This property is used to specify the properties that the user needs to use to parse his source data. the filter Property should be an array When the data source is an XML format, the user should add at before any property.


Implementation
    public function get filterProperties():Array
    public function set filterProperties(value:Array):void
filterResultproperty 
filterResult:Object  [read-only]


Implementation
    public function get filterResult():Object
filtersUIMapproperty 
public var filtersUIMap:Dictionary

firstColorproperty 
firstColor:uint

The first color used to generate colors. It is consumed when colorPolicy is monochromatic or bichromatic.


Implementation
    public function get firstColor():uint
    public function set firstColor(value:uint):void
idColumnHeaderproperty 
idColumnHeader:String

The column Header of the CSV input that represents the unique Ids of the entities filtered in the compoenent (rows in the csv). This property can be used only for CSV String. When using a CSV data source, this property must be set in order to let the Elastic List parser do proper and correct filtering.

This property can be used as the source for data binding.


Implementation
    public function get idColumnHeader():String
    public function set idColumnHeader(value:String):void
ignoreNullValuesproperty 
public var ignoreNullValues:Boolean = false

itemMaxHeightproperty 
itemMaxHeight:Number

Maximal Height of each Filter item. It refers to the height of the item with the maximum occurrence. The height of the other item will be proportional to this height, the minHeiht and its weight


Implementation
    public function get itemMaxHeight():Number
    public function set itemMaxHeight(value:Number):void
itemMinHeightproperty 
itemMinHeight:Number

Minimal Height of each Filter item. It refers to the height of the item with the maximum occurrence. The height of the other item will be proportional to this height, the maxHeiht and its weight


Implementation
    public function get itemMinHeight():Number
    public function set itemMinHeight(value:Number):void
labelFieldsproperty 
labelFields:Array

Label Data fields that should be displayed on the ElasticSearchs items.


Implementation
    public function get labelFields():Array
    public function set labelFields(value:Array):void
lastColorproperty 
lastColor:uint

The second color used to generate colors. It is consumed when colorPolicy is bichromatic.


Implementation
    public function get lastColor():uint
    public function set lastColor(value:uint):void
lastModifiedFilterproperty 
lastModifiedFilter:ElasticFilter  [write-only]


Implementation
    public function set lastModifiedFilter(value:ElasticFilter):void
lastModifiedListproperty 
lastModifiedList:Group  [read-only]

Last Filter entity that have been modified.


Implementation
    public function get lastModifiedList():Group
layoutproperty 
layout:LayoutBase  [write-only] [override]


Implementation
    public function set layout(value:LayoutBase):void
nullValueStringproperty 
public var nullValueString:String = null

numFiltersproperty 
numFilters:uint

Number of displayed filters.


Implementation
    public function get numFilters():uint
    public function set numFilters(value:uint):void
showToolTipproperty 
showToolTip:Boolean

Indicates if toolTips should be shown on the items. When set to true , it will be displayed.

The default value is false..


Implementation
    public function get showToolTip():Boolean
    public function set showToolTip(value:Boolean):void
useDefaultHeightproperty 
useDefaultHeight:Boolean

the useDefaultHeight property is used to display an ElasticSearch whose items have the sameheight. The default value of this property is false. when set it to true the user will not be able to customize the display This Property is usefull when having an enormous data source.


Implementation
    public function get useDefaultHeight():Boolean
    public function set useDefaultHeight(value:Boolean):void
Constructor Detail
ElasticSearch()Constructor
public function ElasticSearch()

constructor

Method Detail
addFilter()method
public function addFilter(filterProperty:String, filterLabel:String):void

Adds a new Filter to the Elastic Lists if it doesn't yet exists.

Parameters

filterProperty:String — Filter property.
 
filterLabel:String — Filter Label.

commitProperties()method 
override protected function commitProperties():void

createChildren()method 
override protected function createChildren():void

forceListsUpdate()method 
public function forceListsUpdate():void

getStyle()method 
override public function getStyle(styleProp:String):*

Parameters

styleProp:String

Returns
*
manageSelection()method 
public function manageSelection(filter:ElasticFilter, select:Boolean = true):void

Parameters

filter:ElasticFilter
 
select:Boolean (default = true)

measure()method 
override protected function measure():void

removeFilter()method 
public function removeFilter(filterProperty:String):void

Removes a Filter.

Parameters

filterProperty:String

resetState()method 
public function resetState(async:Boolean = true):void

Parameters

async:Boolean (default = true)

setStyle()method 
override public function setStyle(styleProp:String, newValue:*):void

Parameters

styleProp:String
 
newValue:*

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

Parameters

styleProp:String

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

unscaledWidth:Number
 
unscaledHeight:Number

Event Detail
change Event
Event Object Type: fr.kapit.elasticsearch.event.ElasticSearchEvent

Indicates that a filter selection has changed.

filterBroken Event  
Event Object Type: fr.kapit.elasticsearch.event.ElasticSearchEvent

Indicates that all filters have left from an all selected state to partially selected state.

filterFinished Event  
Event Object Type: fr.kapit.elasticsearch.event.ElasticSearchEvent

Indicates that all filters has been selected and set.

Constant Detail
COLOR_POLICY_BICHROMATICConstant
public static const COLOR_POLICY_BICHROMATIC:String = bichromatic

Colors are generated by mixing firstColor and secondColor.

COLOR_POLICY_MONOCHROMATICConstant 
public static const COLOR_POLICY_MONOCHROMATIC:String = monochromatic

Colors are generated by mixing firstColor and black.

COLOR_POLICY_SPECTRUMConstant 
public static const COLOR_POLICY_SPECTRUM:String = spectrum

Colors are generated using basic colors.

MAX_HEIGHTConstant 
public static const MAX_HEIGHT:Number = 50

Default Max Height.

MIN_HEIGHTConstant 
public static const MIN_HEIGHT:Number = 20

Default Min Height.