FilterPanel¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Panel for Filters
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| Panel | addPanelNextToMe(position, configuration) | DividerPanel | Adds a new panel adjacent to this panel by creating a divider portlet. The divider portlet is returned. |
| Panel | bringToFront() | Object | Makes this panel visible and bring its containing window to the front. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns commandUid (String) on success, otherwise null. |
| Panel | callCommand(applicationId, cmdId, arguments) | String | Calls the given command. Returns the commandUid (String) for this command call or null on failure. |
| Panel | callRelationship(relationshipName) | Boolean | Reruns the relationship targeting this panel based on name. Returns true on success. |
| Panel | callRelationshipId(relationshipId) | Boolean | Reruns the relationship targeting this panel based on id. Returns true on success. |
| Panel | clearUserSelection() | Object | Clears the user's selection. |
| Panel | close() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient. |
| Panel | deletePanel() | Object | Removes this transient panel. Note this will throw an error if the target panel is not transient |
| Panel | exportConfig() | Map | Exports this panel's configuration to a map. |
| Panel | exportConfig(includeRelationships, includeDatamodels) | Map | Exports this panel's configuration to a map, with the options to include external relationships and external datamodels. |
| Panel | exportConfigIncludeExternalRelationships() | Map | Exports this panels configuration with external relationships |
| Panel | exportUserPreferences() | Map | Exports this panel's user preferences to a map. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| FilterPanel | getColorExpression() | String | Returns the color expression |
| Panel | getCurrentRelationship() | Relationship | Returns the Relationship object currently applied to this panel. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| FilterPanel | getDatamodel() | Datamodel | Returns the underlyting datamodel used by the filter. |
| Panel | getDatamodels() | Object | Returns a set of datamodels that were used in this panel. |
| Panel | getDownstreamMode() | String | Returns status of send data downstream to realtime panels. The statuses are OFF or SELECTED_OR_ALL. |
| FilterPanel | getFilterType() | String | Returns the type of filter to be used. Expected return values: checkboxes |
| FilterPanel | getFormatExpression() | String | Returns the format expression |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| FilterPanel | getFormulaForLinkedDatamodel(datamodelId) | String | Returns the formula used by the linked datamodel specified by the datamodelId. Null if datamodelId does not exist. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| Panel | getId() | String | Returns this panel's ID (as defined in settings). |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| Panel | getLayout() | Layout | Returns layout that owns this panel. |
| FilterPanel | getLinkedDatamodels() | Set | Returns a set of linked datamodels used by the filter. Returns an empty collection if no linked datamodels are present. |
| Panel | getLocation() | Rectangle | Returns a Rectangle object that stores the location of this panel relative to the upper left corner of the browser, not including the 3Forge header. |
| FilterPanel | getMaximumCheckboxes() | Integer | Returns the maximum number of checkboxes the filter panel can have. Null if filter does not use checkbox(es). |
| FilterPanel | getMaximumOptions() | Integer | Returns the maximum number of options the filter panel can have. Null if filter does not use checkbox(es) or radios. |
| Panel | getMenu() | MenuItem | Returns this panel's root custom context menu. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| Panel | getParent() | Panel | Returns the parent panel of this panel. |
| FilterPanel | getSelectedRows() | List | Returns a list of selected rows resulting from the filter. Empty list if nothing is selected. |
| FilterPanel | getSortExpression() | String | Returns the sort expression |
| Panel | getStyle(styleKey) | String | Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found. |
| Panel | getStyle(styleKey, index) | String | Returns the value for a particular style given the style code at the specified position. The style code can be obtained by clicking on the style name. Returns Null if key not found, returns the first value in the list if position is out of bound. |
| Panel | getStyleNumber(styleKey) | Number | Returns the numeric value associated with the supplied style key in this portlets style. Null if key not found, or value is not a number. Ex: using this method for text align will return null as its values are not numeric. |
| Panel | getStyleSet() | StyleSet | Returns the StyleSet for this panel. |
| FilterPanel | getTitle() | String | Returns the name of the filter panel. |
| Panel | getType() | String | Returns the type of this panel, either: html, div_v, div_h, tabs, or one of the AMI visualization types. |
| Panel | getUid() | String | Returns this panel's ami-generated ID. |
| Panel | getValue(key) | Object | Returns the value associated with key from this portlet's attributes. Returns null if key does not exist. |
| Panel | getWindow() | Window | Returns the window that owns this panel. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| FilterPanel | isAutoApplyFilter() | Boolean | Indicates whether filter will be applied eveytime there is a change on the input (i.e. checkboxes, dropdown etc.) |
| FilterPanel | isClearOnRequery() | Boolean | Returns the boolean status of the ClearOnRequery flag. If set to true, the filter and its result set will be cleared on requery, vice versa. |
| Panel | isPoppedOut() | Boolean | Returns true if this panel is popped out. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| Panel | isUndocked() | Boolean | Returns true if this panel is undocked. |
| Panel | isVisible() | Boolean | Returns true if this panel is visible. |
| Panel | minimize() | Object | Minimizes the window, same as calling getWindow().minimize(). |
| FilterPanel | setColorExpression(formula) | Boolean | Sets the color expression of the filter with the given string. |
| Panel | setDownstreamMode(mode) | String | Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL. |
| FilterPanel | setFilterType(type) | Boolean | Sets the display type of the filter panel with the given value |
| FilterPanel | setFormatExpression(formatExpression) | Boolean | Sets the format expression |
| FilterPanel | setMaximumOptions(max) | Boolean | Sets the maximum number of checkboxes or radios. This only applies for checkboxes, multi_checkboxes, and radios. |
| FilterPanel | setSortExpression(sortExpression) | Boolean | Sets the sort expression of the filter panel with the given string. |
| Panel | setTitle(title) | Boolean | Sets the title of the panel with the given value |
| Panel | setValue(key, value) | Boolean | Adds the key value pair to this portlet's attributes and return true if successful. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
addPanelNextToMe(position,configuration)¶
DividerPanel Panel::addPanelNextToMe(String position, Map configuration)
Description¶
Adds a new panel adjacent to this panel by creating a divider portlet. The divider portlet is returned.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| position | String | Must be either:LEFT,ABOVE,RIGHT,BELOW |
| configuration | Map | if null a blank portlet is created |
bringToFront()¶
Description¶
Makes this panel visible and bring its containing window to the front.
callCommand(applicationId,cmdId,arguments)¶
String Panel::callCommand(String applicationId, String cmdId, Map arguments)
Description¶
Calls the given command. Returns commandUid (String) on success, otherwise null.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| applicationId | String | |
| cmdId | String | |
| arguments | Map |
callCommand(applicationId,cmdId,arguments)¶
String Panel::callCommand(String applicationId, String cmdId, String arguments)
Description¶
Calls the given command. Returns the commandUid (String) for this command call or null on failure.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| applicationId | String | |
| cmdId | String | |
| arguments | String | comma delimited list of key=value arguments |
callRelationship(relationshipName)¶
Boolean Panel::callRelationship(String relationshipName)
Description¶
Reruns the relationship targeting this panel based on name. Returns true on success.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| relationshipName | String | name of Relationship |
callRelationshipId(relationshipId)¶
Boolean Panel::callRelationshipId(String relationshipId)
Description¶
Reruns the relationship targeting this panel based on id. Returns true on success.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| relationshipId | String | Id of Relationship |
clearUserSelection()¶
Object Panel::clearUserSelection()
Description¶
Clears the user's selection.
close()¶
Description¶
Removes this transient panel. Note this will throw an error if the target panel is not transient.
deletePanel()¶
Description¶
Removes this transient panel. Note this will throw an error if the target panel is not transient
exportConfig()¶
Description¶
Exports this panel's configuration to a map.
exportConfig(includeRelationships,includeDatamodels)¶
Map Panel::exportConfig(Boolean includeRelationships, Boolean includeDatamodels)
Description¶
Exports this panel's configuration to a map, with the options to include external relationships and external datamodels.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| includeRelationships | Boolean | include external relationships |
| includeDatamodels | Boolean | include external datamodels |
exportConfigIncludeExternalRelationships()¶
Map Panel::exportConfigIncludeExternalRelationships()
Description¶
Exports this panels configuration with external relationships
exportUserPreferences()¶
Map Panel::exportUserPreferences()
Description¶
Exports this panel's user preferences to a map.
getCallback(callbackName)¶
Callback DashboardResource::getCallback(String callbackName)
Description¶
Returns a callback by name
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
getCallbacks()¶
Map DashboardResource::getCallbacks()
Description¶
Returns a map of all callback definitions.
getChildren()¶
List DashboardResource::getChildren()
Description¶
Returns a list of the child dashboard resources.
getClassName()¶
Description¶
Returns the string name of this object's class type.
getColorExpression()¶
String FilterPanel::getColorExpression()
Description¶
Returns the color expression
getCurrentRelationship()¶
Relationship Panel::getCurrentRelationship()
Description¶
Returns the Relationship object currently applied to this panel.
getDRI()¶
String DashboardResource::getDRI()
Description¶
Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
getDashboardResourceType()¶
String DashboardResource::getDashboardResourceType()
Description¶
Returns the Dashboard Resource Type as a string
getDatamodel()¶
Datamodel FilterPanel::getDatamodel()
Description¶
Returns the underlyting datamodel used by the filter.
getDatamodels()¶
Description¶
Returns a set of datamodels that were used in this panel.
getDownstreamMode()¶
String Panel::getDownstreamMode()
Description¶
Returns status of send data downstream to realtime panels. The statuses are OFF or SELECTED_OR_ALL.
getFilterType()¶
String FilterPanel::getFilterType()
Description¶
Returns the type of filter to be used. Expected return values: checkboxes|dropdown|range|range_slider|search
getFormatExpression()¶
String FilterPanel::getFormatExpression()
Description¶
Returns the format expression
getFormula(formulaName)¶
Formula DashboardResource::getFormula(String formulaName)
Description¶
Returns a Formula given the formula name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formulaName | String | name of the formula to return |
getFormulaForLinkedDatamodel(datamodelId)¶
String FilterPanel::getFormulaForLinkedDatamodel(String datamodelId)
Description¶
Returns the formula used by the linked datamodel specified by the datamodelId. Null if datamodelId does not exist.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| datamodelId | String | id for the linked datamodel, ex: Country |
getFormulaNames()¶
Set DashboardResource::getFormulaNames()
Description¶
Returns a set of the names of all formulas for this object.
getFormulas()¶
Map DashboardResource::getFormulas()
Description¶
Returns a map of all available formulas for this object. The key is the formula name.
getId()¶
Description¶
Returns this panel's ID (as defined in settings).
getLRI()¶
String DashboardResource::getLRI()
Description¶
Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
getLayout()¶
Description¶
Returns layout that owns this panel.
getLinkedDatamodels()¶
Set FilterPanel::getLinkedDatamodels()
Description¶
Returns a set of linked datamodels used by the filter. Returns an empty collection if no linked datamodels are present.
getLocation()¶
Rectangle Panel::getLocation()
Description¶
Returns a Rectangle object that stores the location of this panel relative to the upper left corner of the browser, not including the 3Forge header.
getMaximumCheckboxes()¶
Integer FilterPanel::getMaximumCheckboxes()
Description¶
Returns the maximum number of checkboxes the filter panel can have. Null if filter does not use checkbox(es).
getMaximumOptions()¶
Integer FilterPanel::getMaximumOptions()
Description¶
Returns the maximum number of options the filter panel can have. Null if filter does not use checkbox(es) or radios.
getMenu()¶
Description¶
Returns this panel's root custom context menu.
getOwner()¶
DashboardResource DashboardResource::getOwner()
Description¶
Returns the DashboardResource that owns this object.
getParent()¶
Description¶
Returns the parent panel of this panel.
getSelectedRows()¶
List FilterPanel::getSelectedRows()
Description¶
Returns a list of selected rows resulting from the filter. Empty list if nothing is selected.
getSortExpression()¶
String FilterPanel::getSortExpression()
Description¶
Returns the sort expression
getStyle(styleKey)¶
String Panel::getStyle(String styleKey)
Description¶
Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| styleKey | String | the key associated with this portlet's style |
getStyle(styleKey,index)¶
String Panel::getStyle(String styleKey, Number index)
Description¶
Returns the value for a particular style given the style code at the specified position. The style code can be obtained by clicking on the style name. Returns Null if key not found, returns the first value in the list if position is out of bound.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| styleKey | String | the key associated with this portlet's style |
| index | Number | If the style is a list, which element in the list to return |
getStyleNumber(styleKey)¶
Number Panel::getStyleNumber(String styleKey)
Description¶
Returns the numeric value associated with the supplied style key in this portlets style. Null if key not found, or value is not a number. Ex: using this method for text align will return null as its values are not numeric.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| styleKey | String | the key associated with this portlet's style |
getStyleSet()¶
Description¶
Returns the StyleSet for this panel.
getTitle()¶
String FilterPanel::getTitle()
Description¶
Returns the name of the filter panel.
getType()¶
Description¶
Returns the type of this panel, either: html, div_v, div_h, tabs, or one of the AMI visualization types.
getUid()¶
Description¶
Returns this panel's ami-generated ID.
getValue(key)¶
Object Panel::getValue(String key)
Description¶
Returns the value associated with key from this portlet's attributes. Returns null if key does not exist.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | String |
getWindow()¶
Description¶
Returns the window that owns this panel.
invokeCallback(callbackName,args)¶
Object DashboardResource::invokeCallback(String callbackName, Object ... args)
Description¶
Executes the specified callback definition and returns the result from the callback.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
| args | Object ... | arguments |
isAutoApplyFilter()¶
Boolean FilterPanel::isAutoApplyFilter()
Description¶
Indicates whether filter will be applied eveytime there is a change on the input (i.e. checkboxes, dropdown etc.)
isClearOnRequery()¶
Boolean FilterPanel::isClearOnRequery()
Description¶
Returns the boolean status of the ClearOnRequery flag. If set to true, the filter and its result set will be cleared on requery, vice versa.
isPoppedOut()¶
Description¶
Returns true if this panel is popped out.
isTransient()¶
Boolean DashboardResource::isTransient()
Description¶
Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
isUndocked()¶
Description¶
Returns true if this panel is undocked.
isVisible()¶
Description¶
Returns true if this panel is visible.
minimize()¶
Description¶
Minimizes the window, same as calling getWindow().minimize().
setColorExpression(formula)¶
Boolean FilterPanel::setColorExpression(String formula)
Description¶
Sets the color expression of the filter with the given string.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formula | String | color expression in format of ("\"formula\"") |
setDownstreamMode(mode)¶
String Panel::setDownstreamMode(String mode)
Description¶
Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| mode | String |
setFilterType(type)¶
Boolean FilterPanel::setFilterType(String type)
Description¶
Sets the display type of the filter panel with the given value
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| type | String | display type. Accepted input: checkboxes, radios, multicheckbox, slider, search, range, dropdown. Default is checkboxes. |
setFormatExpression(formatExpression)¶
Boolean FilterPanel::setFormatExpression(String formatExpression)
Description¶
Sets the format expression
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formatExpression | String | format expression |
setMaximumOptions(max)¶
Boolean FilterPanel::setMaximumOptions(Integer max)
Description¶
Sets the maximum number of checkboxes or radios. This only applies for checkboxes, multi_checkboxes, and radios.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| max | Integer | maximum options |
setSortExpression(sortExpression)¶
Boolean FilterPanel::setSortExpression(String sortExpression)
Description¶
Sets the sort expression of the filter panel with the given string.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| sortExpression | String | sort expression |
setTitle(title)¶
Boolean Panel::setTitle(String title)
Description¶
Sets the title of the panel with the given value
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| title | String |
setValue(key,value)¶
Boolean Panel::setValue(String key, Object value)
Description¶
Adds the key value pair to this portlet's attributes and return true if successful.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | String | |
| value | Object |
toJson()¶
Description¶
Returns a json representation of this object.