new ReportSet()
Extends
Methods
changeParameters(parameterInfo)
Changes report parameter values.
If you call this method with parameterInfo, the api will change
the report parameter values.
Parameters:
| Name | Type | Description |
|---|---|---|
parameterInfo |
Array | [ { pname: String. The parameter name. pvalue: Array. The parameter value. For most parameter type pvalue only has one element, but the multiValue parameter may have several elements. ownerID: Array. The report ID or library component ID which contains the current parameter. } ... ] |
exportTo(format, options, callback)
Exports the current report to the specified format.
If you call this method without any parameters, the api will
pop up Logi Report built-in Export dialog.
Parameters:
| Name | Type | Description |
|---|---|---|
format |
String | |
options |
Object | |
callback |
function |
filter(field, op, values)
Filters on the specified db field.
Parameters:
| Name | Type | Description |
|---|---|---|
field |
Object | |
op |
String | |
values |
Array |
- Inherited From:
getAssocDBField(dsid, callback)
Returns the associated DB field object with the specified dsid.
Parameters:
| Name | Type | Description |
|---|---|---|
dsid |
String | |
callback |
function |
- Inherited From:
getParameterInfo(callBack)
Gets all parameters information in the current report.
If you call this method with the callback function, the API will
return all parameters information in the callback function.
Parameters:
| Name | Type | Description |
|---|---|---|
callBack |
function | Here is an example of how to get parameter information in the callBack function: var callback = function(msg){ var parameterInfo = msg.result.parameterInfo // Gets parameter information. ... } |
getReports() → {Array}
Reports all com.jinfonet.api.Report in an array.
Returns:
array of com.jinfonet.api.Report
- Type
- Array
isDirty() → {Boolean}
Returns whether this report has been modified.
Returns:
- Type
- Boolean
isFilterable() → {Boolean}
Returns whether this data container supports filter function.
- Inherited From:
Returns:
- Type
- Boolean
isSortable() → {Boolean}
Returns whether this data container supports sort function.
- Inherited From:
Returns:
- Type
- Boolean
paramDialog()
Pops up the parameters dialog.
If you call this method without any parameters, the api will
pop up Logi Report built-in parameters dialog.
print(format, options, callback)
Prints the current report to the specified format.
If you call this method without any parameters, the api will
pop up Logi Report built-in Print dialog.
Parameters:
| Name | Type | Description |
|---|---|---|
format |
String | |
options |
Object | |
callback |
function |
save()
Saves the report.
saveAs()
Saves the report with or without Logi Report built-in Save As dialog.
options : {savePath:"/SampleReports/Employee Information List.cls"
,linkedCatalog:true
,saveSort:false
,catalog:"/SampleReports/SampleReports.cat"}
If no "options" or "options" does not contain savePath, the Save As dialog will pop up.
Others are optional.
callback: An optional JavaScript function. After saving the report, callcack will receive result data by parameter.
like: function(result){...}
result: A JavaScript object.
result.err: A number which could be one of the following:
0 : The report is saved successfully.
1 : The saving of the report is cancelled by the user with dialog.
2 : The report is failed to save.
result.msg: The result message.
result.data: A JavaScript object when saving the report successfully.
result.data.savePath: Saves the report to the resource path.
sort(field, order)
Sorts on the specified db field by the specified
ascending or descending order.
Parameters:
| Name | Type | Description |
|---|---|---|
field |
Object | |
order |
String |
- Inherited From: