WebDataRocks class
Methods
addCalculatedMeasure (dynamic measure → Future <void >
This API call adds a calculated measure.
addCondition (dynamic condition → Future <void >
Adds a conditional formatting rule for cell values to format them with specific styles if the condition for the cell value is met.
build (BuildContext context → Widget
Describes the part of the user interface represented by this widget.
override
clear ()
→ Future <void >
Clears the component’s data and view.
clearFilter (String hierarchyName → Future <void >
Clears the filter which was applied previously to the specified hierarchy.
closeFieldsList ()
→ Future <void >
This API call closes the Field list.
collapseAllData ()
→ Future <void >
Collapses all nodes and drills up (starting from v2.1) all levels of all hierarchies in the slice on the grid and on charts.\n
All expanded/drilled down nodes will be collapsed/drilled up on the grid and on charts.
collapseData (String hierarchyName → Future <void >
Collapses all nodes of the specified hierarchy. Please note, this method works only for CSV and JSON data sources.
connectTo (dynamic dataSource → Future <void >
Clears the filter which was applied previously to the specified hierarchy.
createElement ()
→ StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren ()
→ List <DiagnosticsNode
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
debugFillProperties (DiagnosticPropertiesBuilder properties → void
Add additional properties associated with the node.
inherited
dispose ()
→ Future <void >
Prepares the pivot table instance to be deleted with the browser’s garbage collection.
expandAllData ([bool withAllChildren = true → Future <void >
expandData (String hierarchyName → Future <void >
Expands all nodes of the specified hierarchy.
Please note, this method works only for CSV and JSON data sources.
getAllConditions ()
→ Future
Returns a list of conditional formatting rules of the report.
You may need this API call to edit existing conditional formatting rules.
getAllHierarchies ()
→ Future
Returns a list of all available hierarchies.
getAllMeasures ()
→ Future
Returns a list of all available measures.
getCell (int rowIdx , int colIdx → Future
Returns information about the cell by row and column indexes.
getColumns ()
→ Future
Returns a list of hierarchies selected in the report slice for columns.
getCondition (String id → Future
Returns a conditional formatting rule by id. You may need this API call to edit the existing conditional formatting rule.
getFilter (String hierarchyName → Future
Returns the FilterObject for the specified hierarchy.
getFilterProperties (String hierarchyName → Future
The getFilterProperties API call.
getFormat (String measureName → Future
Returns the default number format or the number format for the specified measure.
getMeasures ()
→ Future
Returns a list of the selected measures in the report.
getMembers (String uniqueName , [String ?memberName → Future
Returns a list of members for the specified hierarchy.
Note that this API call has no callbackHandler parameter in Flutter.
getOptions ()
→ Future
Returns OptionsObject with component’s options.
getReport ()
→ Future
This API call returns report JSON object as string
getReportFilters ()
→ Future
Returns a list of hierarchies selected in the report slice for report filters.
getRows ()
→ Future
Returns a list of hierarchies selected in the report slice for rows.
getSelectedCell ()
→ Future
Returns information about the selected cell/cells.
getSort (String hierarchyName → Future <String
Returns the sort type which is applied to the hierarchy.
load (String url → Future <void >
Loads the report file from the specified URL.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off (String eventName , [Function ?function → dynamic
Sets a Dart function for the specified event.
on (String eventName , Function function → void
Sets a Dart function for the specified event.
open ()
→ Future <void >
Opens local report file. Use this API call to open the report JSON file from the local file system.
openFieldsList ()
→ Future <void >
This API call opens the Field list.
refresh ()
→ Future <void >
This API call allows you to control redrawing of the component when you use the following API calls:
addCondition(), removeAllConditions(), removeCondition(), setFormat(), setOptions()
removeAllCalculatedMeasures ()
→ Future <void >
Removes all calculated measures.
Note that the removeAllCalculatedMeasures method is available only for reports based on "csv", "json", and "api" data source types.
removeAllConditions ()
→ Future <void >
Removes all conditional formatting rules.
Use refresh() API call after to redraw the component and see changes.
removeCalculatedMeasure (String uniqueName → Future <void >
Removes the calculated measure by the measure’s unique name.
Note that the removeCalculatedMeasure method is available only for reports based on "json", "csv", and "api" data source types.
removeCondition (String id → Future <void >
Removes the conditional formatting rule by id.
Use refresh() API call after to redraw the component and see changes.
removeSelection ()
→ Future <void >
Removes a selection from cells on the grid.
runQuery (dynamic slice → Future <void >
Runs a query with specified rows, columns, measures and reportFilters from the SliceObject and displays the result data.
Use this method to rearrange hierarchies on the axes or to compose a new report based on the current data source.
setBottomX (String hierarchyName , int num , String measureName → Future <void >
The setBottomX API call.
setFilter (String hierarchyName , List <String items , [bool ?negation → Future <void >
Sets the filter for the specified hierarchy.
setFormat (dynamic format , String measureName → Future <void >
Sets a default number format or the number format for the specified measure.
Use refresh() API call after setting a format to redraw the component and see changes.
setOptions (dynamic options → Future <void >
Sets the component’s options.
Use refresh() API call after to redraw the component and see changes.
setReport (dynamic report → Future <void >
Sets a report to be displayed in the component.
Use this method to load and show previously saved reports.
setSort (String hierarchyName , String sortName , [List <String ?customSorting → Future <void >
Sets the sort type to the specified hierarchy.
setTopX (String hierarchyName , int num , String measureName → Future <void >
The setTopX API call.
sortValues (String axisName , String type , List <double tuple , String measureName → Future <void >
Sorts values in a specific row or column.
toDiagnosticsNode ({String ?name , DiagnosticsTreeStyle ?style → DiagnosticsNode
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep .
inherited
toString ({DiagnosticLevel minLevel = DiagnosticLevel.info → String
A string representation of this object.
inherited
toStringDeep ({String prefixLineOne = '' , String ?prefixOtherLines , DiagnosticLevel minLevel = DiagnosticLevel.debug → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow ({String joiner = ', ' , DiagnosticLevel minLevel = DiagnosticLevel.debug → String
Returns a one-line detailed description of the object.
inherited
toStringShort ()
→ String
A short, textual description of this widget.
inherited
updateData (dynamic object , [dynamic options → Future <void >
Connects to a new data source whereas filtering, sorting, etc. remain the same.
version ()
→ Future <String
Returns version of the WebDataRocks JavaScript library.
flutter_webdatarocks 1.4.6 