User Interface APIs
The user interface system definition for cv.api class (cv.api.ui). Contains all user interface related API calls.
Constructor
new ui()
User interface definition for cv.api class. Contains all user interface related API calls.
Methods
disableFilterPanel(removeFlag)
Removes filter panel, filter panel toggle arrow, the filter count, and the filter toggle button on the main tool bar. This API function is additionally available via the URL parameter 'disableFilterPanel'.
getMode() : string
Returns the mode of the current report's representation.
listGembarIds() : Array
Returns an array which contains the IDs of the fields.
listVizIds() : Array
Returns an array which contains the IDs of the visualization types.
removeFieldLayout(removeFlag)
Removes the layout panel and the toolbar's button for opening and closing the panel. This API function is additionally available via the URL parameter 'removeFieldLayout'. This function only works in EDIT mode.
removeFieldList(removeFlag)
Removes field list panel and the toolbar's button for opening and closing the panel. This API function is additionally available via the URL parameter 'removeFieldList'. This function only works in EDIT mode.
removeHeaderBar(removeFlag)
Removes the header bar, including the filter panel, report title, and spinner loading bar with the Cancel button. In VIEW mode this function will also remove the View Report Format toggle. This API function is additionally available via the URL parameter 'removeHeaderBar'.
removeMainToolbar(removeFlag)
Removes the main toolbar panel which contains buttons to control the report. This API function is additionally available via the URL parameter 'removeMainToolbar'. This function only works in EDIT mode.
removeRedoButton(removeFlag)
Removes the Redo button from the main toolbar. This API function is additionally available via the URL parameter 'removeRedoButton'. This function only works in EDIT mode.
removeReportActions(removeFlag)
Removes the action button while in view mode. This API function is additionally available via the URL parameter 'removeReportActions'. This function only works in VIEW mode.
removeUndoButton(removeFlag)
Removes the Undo button from the main toolbar. This API function is additionally available via the URL parameter 'removeUndoButton'. This function only works in EDIT mode.
setFieldListView(view)
Sorts the data source fields based on the view. This API function is additionally available via the URL parameter 'fieldListView'. This function only works in EDIT mode.
showFieldLayout(makeVisible)
Enables the user to toggle whether the field layout panel is visible. This api function is additionally available via the URL parameter 'showFieldLayout'. This function only works in EDIT mode.
showFieldList(makeVisible)
Enables the user to toggle whether the field list panel is visible. This API function is additionally available via the URL parameter 'showFieldList'. This function only works in EDIT mode.
showFilterPanel(makeVisible)
Enables the user to toggle whether the filter panel is visible or hidden. This API function is additionally available via the URL parameter 'showFilterPanel'
showRepositoryButtons(makeVisible)
Enables the user to toggle whether the repository buttons in the main toolbar are visible. This API function is additionally available via the URL parameter 'showRepositoryButtons'. This function only works in EDIT mode.
Constructor Details
new ui()
UI definition for cv.api class.- Source
## Methods Details
disableFilterPanel(removeFlag)
Removes filter panel, filter panel toggle arrow, the filter count, and the filter toggle button on the main tool bar. This API function is additionally available via the URL parameter 'disableFilterPanel'.- Source
javascript/scripts/cv_api_ui.js, line 302
Parameters
Example
cv.api.ui.disableFilterPanel();
http://sample.url.com?disableFilterPanel=true
Name
Default Value
Summary
`removeFlag : boolean
string`
getMode() : string
Returns the mode of the current report's representation.- Source
javascript/scripts/cv_api_ui.js, line 107
Returns
Example
cv.api.ui.getMode(); ```
Name
Description
string
current mode. Possible values are "EDIT" or "VIEW".
listGembarIds() : Array
Returns an array which contains the IDs of the fields.- Source
javascript/scripts/cv_api_ui.js, line 219
Returns
Example
cv.api.ui.listGembarIds();
// Return Value: ["rows", "columns", "measures"]
Name
Description
Array
The field's IDs.
listVizIds() : Array
Returns an array which contains the IDs of the visualization types.- Source
javascript/scripts/cv_api_ui.js, line 188
Returns
Example
cv.api.ui.listVizIds();
// Return Value: [ // "pivot", "ccc_bar", "ccc_barstacked", "ccc_barnormalized", "ccc_horzbar", "ccc_horzbarstacked", // "ccc_horzbarnormalized", "ccc_pie", "ccc_line", "ccc_area", "ccc_scatter", "ccc_barline", "ccc_heatgrid", // "ccc_sunburst", "open_layers" // ]
Name
Description
Array
The visualization types' IDs.
removeFieldLayout(removeFlag)
Removes the layout panel and the toolbar's button for opening and closing the panel. This API function is additionally available via the URL parameter 'removeFieldLayout'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 359
Parameters
Example
cv.api.ui.removeFieldLayout();
http://sample.url.com?removeFieldLayout=true
Name
Default Value
Summary
`removeFlag : boolean
string`
removeFieldList(removeFlag)
Removes field list panel and the toolbar's button for opening and closing the panel. This API function is additionally available via the URL parameter 'removeFieldList'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 243
Parameters
Example
cv.api.ui.removeFieldList();
http://sample.url.com?removeFieldList=true
Name
Default Value
Summary
`removeFlag : boolean
string`
removeHeaderBar(removeFlag)
Removes the header bar, including the filter panel, report title, and spinner loading bar with the Cancel button. In VIEW mode this function will also remove the View Report Format toggle. This API function is additionally available via the URL parameter 'removeHeaderBar'.- Source
javascript/scripts/cv_api_ui.js, line 269
Parameters
Example
cv.api.ui.removeHeaderBar();
http://sample.url.com?removeHeaderBar=true
Name
Default Value
Summary
`removeFlag : boolean
string`
removeMainToolbar(removeFlag)
Removes the main toolbar panel which contains buttons to control the report. This API function is additionally available via the URL parameter 'removeMainToolbar'. This function only works in EDIT mode.
Source
javascript/scripts/cv_api_ui.js, line 418
Parameters
Example
cv.api.ui.removeMainToolbar();
http://sample.url.com?removeMainToolbar=true
Name
Default Value
Summary
`removeFlag : boolean
string`
removeRedoButton(removeFlag)
Removes the Redo button from the main toolbar. This API function is additionally available via the URL parameter 'removeRedoButton'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 392
Parameters
Example
cv.api.ui.removeRedoButton();
http://sample.url.com?removeRedoButton=true
Name
Default Value
Summary
`removeFlag : boolean
string`
removeReportActions(removeFlag)
Removes the action button while in view mode. This API function is additionally available via the URL parameter 'removeReportActions'. This function only works in VIEW mode.- Source
javascript/scripts/cv_api_ui.js, line 514
Parameters
Example
cv.api.ui.removeReportActions();
http://sample.url.com?removeReportActions=true
Name
Default Value
Summary
`removeFlag : boolean
string`
removeUndoButton(removeFlag)
Removes the Undo button from the main toolbar. This API function is additionally available via the URL parameter 'removeUndoButton'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 333
Parameters
Example
cv.api.ui.removeUndoButton();
http://sample.url.com?removeUndoButton=true
Name
Default Value
Summary
`removeFlag : boolean
string`
setFieldListView(view)
Sorts the data source fields based on the view. This API function is additionally available via the URL parameter 'fieldListView'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 443
Parameters
Example
cv.api.ui.setFieldListView("CATEGORY")
http://sample.url.com?fieldListView=CATEGORY
Name
Default Value
Summary
view : string
The value upon which the field list will be sorted. Acceptable values include: CATEGORY,SCHEMA,TYPE,NAME
showFieldLayout(makeVisible)
Enables the user to toggle whether the field layout panel is visible. This api function is additionally available via the URL parameter 'showFieldLayout'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 127
Parameters
Example
cv.api.ui.showFieldLayout("true");
http://sample.url.com?showFieldLayout=true
Name
Default Value
Summary
`makeVisible : boolean
string`
showFieldList(makeVisible)
Enables the user to toggle whether the field list panel is visible. This API function is additionally available via the URL parameter 'showFieldList'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 545
Parameters
Example
cv.api.ui.showFieldList("true");
http://sample.url.com?showFieldList=true
Name
Default Value
Summary
`makeVisible : boolean
string`
showFilterPanel(makeVisible)
Enables the user to toggle whether the filter panel is visible or hidden. This API function is additionally available via the URL parameter 'showFilterPanel'- Source
javascript/scripts/cv_api_ui.js, line 158
Parameters
Example
cv.api.ui.showFilterPanel("true");
http://sample.url.com?showFilterPanel=true
Name
Default Value
Summary
`makeVisible : boolean
string`
showRepositoryButtons(makeVisible)
Enables the user to toggle whether the repository buttons in the main toolbar are visible. This API function is additionally available via the URL parameter 'showRepositoryButtons'. This function only works in EDIT mode.- Source
javascript/scripts/cv_api_ui.js, line 481
Parameters
Example
cv.api.ui.showRepositoryButtons("true");
http://sample.url.com?showRepositoryButtons=true
Name
Default Value
Summary
`makeVisible : boolean
string`
Last updated
Was this helpful?