Class sap.apf.ui.representations.representationInterfaceModule: sap/apf/ui/representations/representationInterface

Called on representation by binding when a representation type is set. Intention is to trigger transfer of selections that might exist on a representation (source) that is replaced by the "new" representation (target) to be set. Therefore the target representation receives a reference pointing to the source representation. In order to check whether selection transfer is possible the target representation initiates a negotiation process with the source representations (3-way-handshake). If a common method can be determined between target and source representation the selection will be exchanged.

This method uses the serialization information from serialized data and sets the selection to representation based on mode and selection string returned.

Returns the alternate representation of current step (i.e. list representation for the charts)

Returns data for representation type

This method has to be implemented so that binding can determine which method has to be used for the filter retrieval from a representations.

This method holds the logic to draw the content to be shown on main representation area.

Returns meta data for representation type

The method returns the constructor arguments which will be used to create toggle representation.

This method holds the logic to draw the content to be printed.

Additionally to parameters being set in the request configuration and filter values that are derived from the path logic, a request can be enriched with additional options such as $top, $skip and $orderby.

Dependent on the actual options a representation may require for a request, an object containing the correspondent properties may be returned by this method.
In case no additional options are required an empty object should be returned.

The supported optional properties of the return object are:

• paging: An object containing optional properties
  • top for OData system query option $top
    A numeric value is expected
  • skip for query string option $skip
    A numeric value is expected
  • inlineCount for OData system query option $inlineCount
    A boolean value 'true' is expected if inline count is requested
• orderby for OData system query option $orderby: Values could be of type
  • string that holds a property name (in this case the default sort order 'ascending' is applied)
  • object with properties:
    • 'property' A string containing the property name is expected.
    • 'descending' A boolean value 'true' is expected, if descending sort order is required for the property. If omitted default sort order 'ascending' is applied.
  • array holding objects with properties 'property' and 'descending' as described above.

{ paging : {
		top : 10,
		skip : 30,
		inlineCount : true
 },
 orderby : [ 
		{ property : "nameProperty1",
		}, {
		property : "nameProperty2",
		descending : true
		}
 ]
}

This is the basic method with which the step can detect data selected in the chart.

This method holds the logic to draw the content to be shown on thumbnail area.

This method holds the logic to draw the content to be shown as tooltip for a thumbnail. It will be shown inside a tooltip Popup when the thumbnail content overflows the thumbnail container area with a gradient effect to indicate that it is overflowing.

This method holds the logic to remove all selection from the chart. It also updates the step.

This method returns the selection for serialization. This is required for the Persisting selection of current representation. It includes selection mode and selections.

The binding sets the data (received from the request) that has to be visualized. The array aDataResponse is shared between all representations of a step and the binding. When lines are moved, deleted or changed, you modify the visualization of the original data! When displaying the data, one can determine which record is selected by aSelectedIndices.