Flexmonster class

Inheritance

Constructors

Flexmonster({String? height, String? width, bool? toolbar, String? licenseKey, dynamic report, dynamic global, dynamic accessibility, dynamic shareReportConnection, Key? key})

Properties

controller → Completer<WebViewController>
final
eventHandlers ↔ Map<String, List<Function>>
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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 uniqueName) → 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.
collapseCell(String axisName, List<String> tuple, [String? measureName]) → Future<void>
Collapses a specific node on the grid and charts.
collapseData(String uniqueName) → 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.
drillDownCell(String axisName, List<String> tuple, String? measureName, String memberName) → Future<void>
Drills down a specific hierarchy level on the grid and charts.
drillUpCell(String axisName, List<String> tuple, String? measureName, String memberName) → Future<void>
Drills up a specific hierarchy level on the grid and charts.
expandAllData([bool withAllChildren = true]) → Future<void>
expandCell(String axisName, List<String> tuple, [String? measureName]) → Future<void>
Expands a specific node on the grid and charts.
expandData(String uniqueName) → 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 uniqueName) → Future
Returns the FilterObject for the specified hierarchy.
getFlatSort() → Future
Returns an array of objects defining the sorting on the flat grid. Note that the getFlatSort method is available only for reports based on "csv", "json", and "api" data source types.
getFormat(String measureName, [String? aggregation]) → 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 uniqueName) → Future<String>
Returns the sort type which is applied to the hierarchy.
getTableSizes() → Future
Returns table sizes that are set for the component via UI or the setTableSizes() method.
load(String url, [Map<String, String>? requestHeaders]) → 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.
openCalculatedValueEditor([String? uniqueName]) → Future<void>
Opens the calculated value pop-up window editor. Calling openCalculatedValueEditor results in opening an empty editor for creating a new value. It is also possible to open this editor for editing or deleting an existing calculated value. Note that this API call has no callbackHandler parameter in Flutter.
openFieldsList() → Future<void>
This API call opens the Field list.
openFilter(String hierarchyUniqueName) → Future<void>
This API call opens the filter pop-up window for the specified hierarchy.
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 measureName) → 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 query) → 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.
scrollToColumn(int columnIndex) → Future<void>
Scrolls the grid to the specified column.
scrollToRow(int rowIndex) → Future<void>
Scrolls the grid to the specified row.
setFilter(String uniqueName, dynamic filter) → Future<void>
Sets the filter for the specified hierarchy.
setFlatSort(Map<String, String> flatSort) → Future<void>
Sorts columns in the flat view. Note that the setFlatSort method is available only for reports based on "csv", "json", and "api" data source types.
setFormat(dynamic format, [String? measureName, String? aggregation]) → Future<void>
Sets a default number format or the number format for the specified measure.
To apply a default format to all measures, leave the measureName and aggregation parameters undefined.
To apply a format only to a specific measure, specify the measureName and aggregation parameters. Learn more in this guide: Number formatting.
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 uniqueName, String sortType) → Future<void>
Sets the sort type to the specified hierarchy. Learn more about sorting in this guide: Custom sorting.
setTableSizes(dynamic tableSizes) → Future<void>
Sets table sizes for the component. Use this method to set table sizes without updating the report. When called, the setTableSizes() method overwrites previously set table sizes.
shareReport([dynamic options]) → Future<void>
Saves the current report to Flexmonster Data Server and provides a link to the saved report.
To save a report, Flexmonster creates an XMLHttpRequest and sends it to the Data Server as a POST request. The request is sent to <url>/save, where url is the Data Server’s URL (e.g., http://localhost:9500).
For more details on report sharing, see this guide: Share the report.
showCharts([String type = "column", bool multiple = false]) → Future<void>
Switches to the charts view and shows the chart of the specified type. The following chart types are supported: "column", "bar_h", "line", "scatter", "pie", "stacked_column" and "column_line". After showCharts() API call options.viewType property in the report will be "charts".
showGrid() → Future<void>
Switches to the grid view. After showGrid() API call options.viewType property in report will be "grid".
showGridAndCharts([String type = "column", String position = "bottom", bool multiple = false]) → Future<void>
Switches to the grid and charts view and shows the chart of the specified type. The following chart types are supported: "column", "bar_h", "line", "scatter", "pie", "stacked_column" and "column_line". After showCharts() API call options.viewType property in the report will be "grid_charts".
sortValues(String axisName, String type, [List<String>? tuple, dynamic measure]) → 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 connectionParameters, [dynamic options]) → Future<void>
Helps to update data for the report without cleaning the report. Only the dataSource is updated, whereas the slice, all defined options, number and conditional formatting, the scroll position stay the same. For all data sources, updateData allows connecting to a new data source. For a JSON data source, it is also possible to update only some part of the data.
version() → Future<String>
Returns version of the Flexmonster JavaScript library.

Operators

operator ==(Object other) → bool
The equality operator.
inherited