Constructor
new AppFactory()
Methods
getApp(entryId) → {Object}
Returns the Logi Report application with the specified ID.
Parameters:
| Name |
Type |
Description |
entryId |
String
|
The DOM element ID. |
Returns:
Null or an instance of Logi Report application.
-
Type
-
Object
runDashboard(server, resExt, entryId) → {Object}
Runs Logi Report Dashboard in a DOM element whose ID is the parameter entryId.
Parameters:
| Name |
Type |
Description |
server |
Object
|
The server parameter object includes
the URL of running a report on Logi Report Server, authorization information, UI preference and other customized
information passed to Logi Report Server especially single sign on (SSO) authentication
and authorization.
Properties
| Name |
Type |
Description |
url |
String
|
The URL to run dashboards on Logi Report Server. |
user |
String
|
The user name who runs dashboards. |
pass |
String
|
The password of the user. |
jrd_prefer |
Object
|
The jrd_prefer JSON object is used to
control the UI of Logi Report application.
Properties
| Name |
Type |
Description |
dashboard |
Object
|
The dashboard object is used to
control the UI of JDashboard.
Properties
| Name |
Type |
Description |
viewMode |
Object
|
The viewMode object
is used to control the UI of the view mode of JDashboard.
Properties
| Name |
Type |
Description |
toolbar |
Boolean
|
Specifies whether to show the toolbar or not in the view mode.
true means to show the toolbar; false to hide it. |
taskbar |
Boolean
|
Specifies whether to show the task bar or not in the view mode.
true means to show the task bar; false to hide it. |
tstyle |
Integer
|
Specifies the way of showing the component title bar in the view mode.
0: Always Show, 1: Never Show, 3: Show When Mouse Over |
bstyle |
Integer
|
Specifies the way of showing the icons on the component title bar in the view mode.
0: Always Show, 1: Never Show, 3: Show When Mouse Over |
|
editMode |
Object
|
The editMode object
is used to control the UI of the edit mode of JDashboard.
Properties
| Name |
Type |
Description |
toolbar |
Boolean
|
Specifies whether to show the toolbar or not in the edit mode.
true to show the toolbar; false to hide it. |
taskbar |
Boolean
|
Specifies whether to show the task bar or not in the edit mode.
true to show the task bar; false to hide it. |
tstyle |
Integer
|
Specifies the way of showing the component title bar in the edit mode.
0: Always Show, 1: Never Show, 3: Show When Mouse Over |
bstyle |
Integer
|
Specifies the way of showing the icons on the component title bar in the edit mode
0: Always Show, 1: Never Show, 3: Show When Mouse Over
For example, open a dashboard with view mode without the toolbar and task bar,
always show the component title bar and never show the icons on the component title bar.
jrd_prefer:{
dashboard:{
viewMode:{
toolbar: false,
taskbar: false,
tstyle: 0,
bstyle: 1
}
}
} |
|
|
|
|
resExt |
Object
|
Properties
| Name |
Type |
Description |
reslst |
Array
|
The array of dashboard resources. Every dashboard resource
is an object having a "name" property which is a dashboard's full path name in the server
resource tree. |
active |
Integer
|
Indicates which dashboard is activated. |
|
entryId |
String
|
The DOM elements's ID attribute. |
Returns:
The instance of com.jinfonet.api.DashboardApp.
-
Type
-
Object
runReport(server, rptRes, catRes, params, entryId) → {Object}
Runs Logi Report Page Reports or Web Reports in a DOM element
whose ID is the parameter entryId.
Parameters:
| Name |
Type |
Description |
server |
Object
|
The server parameter object includes
the URL for running a report on Logi Report Server, authorization information, UI preference and other customized
information passed to Logi Report Server especially single sign on (SSO) authentication
and authorization.
Properties
| Name |
Type |
Description |
url |
String
|
The URL for running reports on Logi Report Server. |
user |
String
|
The user name who runs reports. |
pass |
String
|
The password of the user. |
jrd_prefer |
Object
|
The jrd_prefer object is used to
control the UI of report application.
Properties
| Name |
Type |
Description |
webreport |
Object
|
The webreport object
is used to control the UI of Web Report Studio.
Properties
| Name |
Type |
Description |
viewMode |
Object
|
Properties
| Name |
Type |
Description |
hasToolbar |
Boolean
|
Specifies whether to show
the toolbar or not in the View Mode. |
hasSideArea |
Boolean
|
Specifies whether to show
the Resources panel or not in the View Mode. |
|
editMode |
Object
|
Properties
| Name |
Type |
Description |
hasToolbar |
Boolean
|
Specifies whether to show
the toolbar or not in the Edit Mode. |
hasVToolbar |
Boolean
|
Specifies whether to show
the visualization toolbar or not in the Edit Mode. |
hasSideArea |
Boolean
|
Specifies whether to show
the Resources panel in the Edit Mode. |
hasInspector |
Boolean
|
Specifies whether to show
the Inspector in the Edit Mode. |
|
|
pagereport |
Object
|
The pagereport object
is used to control the UI of Page Report Studio.
Properties
| Name |
Type |
Description |
feature_UserInfoBar |
Boolean
|
Specifies whether to show
the user information bar in Page Report Studio. |
feature_ToolBar |
Boolean
|
Specifies whether to show the
toolbar in Page Report Studio. |
feature_Toolbox |
Boolean
|
Specifies whether to show the
Resource View panel. |
feature_DSOTree |
Boolean
|
Specifies whether to show the
business view data resource tree in the Resource View panel. |
feature_TOCTree |
Boolean
|
Specifies whether to show the
TOC Browser panel. |
feature_PopupMenu |
Boolean
|
Specifies whether to enable
the context menu of reports. |
feature_ADHOC |
Boolean
|
Specifies whether to enable adhoc
actions, such as moving, resizing etc. on components. |
|
|
|
rptRes |
Object
|
Properties
| Name |
Type |
Description |
name |
String
|
The report's full name in the server resource tree. |
|
catRes |
Object
|
Properties
| Name |
Type |
Description |
name |
String
|
The catalog's full name in the server resource tree. |
|
params |
Object
|
The parameters of the report. |
entryId |
String
|
The DOM element's ID attribute. |
Returns:
The instance of com.jinfonet.api.ReportApp
-
Type
-
Object
Examples
Open a web report in the View Mode with neither toolbar nor left panels.
jrd_prefer{
webreport:{
viewMode:{
hasToolbar: false,
hasSideArea: false
}
}
}
Open a page report without the toolbar, left panels and other UI elements.
jrd_prefer{
pagereport:{
feature_UserInfoBar: false,
feature_ToolBar: false,
feature_Toolbox: false,
feature_DSOTree: false,
feature_TOCTree: false,
feature_PopupMenu: false,
feature_ADHOC: false
}
}