JavaScript API
Last updated
Last updated
Placing the SheetView component on a Visualforce page globally exposes the MsmxSheet
JavaScript object in the page. By making an API call from this object, it is possible to dynamically control Sheet's behavior and rendering.
This API sets the application parameters for the Sheet application. Application parameters can be specified as references when specifying filter values. If the reference for the appropriate parameter is set in the filter, the reference is replaced with the value of the parameter and the sheet display is automatically refreshed.
In the filters for text type or ID type field, and advanced filters, the values of application parameters can be specified as reference and used as filter values. See for more information.
params - (required) Pass application parameter names and its values in Key-Value pairs.
options - (optional) Option parameters. With the forceLoad
option property you can force the data refresh
Update application parameter values set in the Sheet Application. The difference with setApplicationParameter
is that it replaces only the value of specified parameters and others will be remained as previous.
params - (required) Pass application parameter names and its values in Key-Value pairs.
options - (optional) Option parameters. With the forceLoad
option property you can force the data refresh
Set a listner function to subscribe events fired from the sheet in the component of msmxSheet:SheetView
.
compId - (required) Target component ID (specified in id attribute of msmxSheet:SheetView
component tag)
path - (required) Concatenation of Book ID and Sheet ID with "/"
event - (required) Event name to subscribe
listener - (required) Listener function which will be notified by the event
Unset listener functions to unsubscribe events fired from the sheet in the component of msmxSheet:SheetView
.
compId - (required) Target component ID (specified in id attribute of msmxSheet:SheetView
component tag)
path - (required) Concatenation of Book ID and Sheet ID with "/"
event - (required) Event name to subscribe
listener - (optional) Listener function registered in subscription. If omit this all listeneres for the event will be unsubscribed.
Event which will be notified when the selection of records has changed.
records - List of records selected
Event which will be notified when the records are loaded.
records - List of records loaded
Event which will be notified when a cell in the sheet is focused (for example by clicking).
cell - Stores information about the focused cell
recordId - The ID of the record shown in focused cell
colIndex - Column index position of the cell
rowIndex - Row index position of the cell (in all pages)
value - The raw value of the item displayed in the cell