docs(pivotgrid): Add PivotGrid documentation #1486
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva reviewed Jun 5, 2023
ntacheva approved these changes Jun 5, 2023
Co-authored-by: Nadezhda Tacheva <73842592+ntacheva@users.noreply.github.com>
yordan-mitev reviewed Jun 5, 2023
| | ||
| # Blazor PivotGrid Overview | ||
| | ||
| The <a href="https://www.telerik.com/blazor-ui/pivotgrid" target="_blank">Blazor PivotGrid component</a>, also known as a pivot table, is a powerful data visualization, statistics and reporting tool that allows you to perform operations and analysis over multi-dimensional pivot data. It can work with local data or a remote XMLA data such as an OLAP cube. The PivotGrid also supports filtering and sorting for the values of the row and column fields. |
There was a problem hiding this comment.
Suggested change
| The <a href="https://www.telerik.com/blazor-ui/pivotgrid" target="_blank">Blazor PivotGrid component</a>, also known as a pivot table, is a powerful data visualization, statistics and reporting tool that allows you to perform operations and analysis over multi-dimensional pivot data. It can work with local data or a remote XMLA data such as an OLAP cube. The PivotGrid also supports filtering and sorting for the values of the row and column fields. | |
| The <a href="https://www.telerik.com/blazor-ui/pivotgrid" target="_blank">Blazor PivotGrid component</a>, also known as a pivot table, is a powerful data visualization, statistics, and reporting tool that allows you to perform operations and analysis over multi-dimensional pivot data. It can work with local data or remote XMLA data, such as an OLAP cube. The PivotGrid also supports filtering and sorting for the values of the row and column fields. |
| | ||
| ## Definitions | ||
| | ||
| The PivotGrid component and this documentation use terms *row*, *column*, and *measure*. Each of these terms signifes one field in the data source: |
There was a problem hiding this comment.
Don't use italic for the terms that you introduce. If you need to make them stand out, handle them as proper nouns and capitalize them.
Suggested change
| The PivotGrid component and this documentation use terms *row*, *column*, and *measure*. Each of these terms signifes one field in the data source: | |
| The PivotGrid component and this documentation use the terms Row, Column, and Measure. Each of these terms signifies one field in the data source: |
| | ||
| The PivotGrid component and this documentation use terms *row*, *column*, and *measure*. Each of these terms signifes one field in the data source: | ||
| | ||
| * The *rows* and *columns* represent categories or date periods. |
There was a problem hiding this comment.
Suggested change
| * The *rows* and *columns* represent categories or date periods. | |
| * The Rows and Columns represent categories or date periods. |
| The PivotGrid component and this documentation use terms *row*, *column*, and *measure*. Each of these terms signifes one field in the data source: | ||
| | ||
| * The *rows* and *columns* represent categories or date periods. | ||
| * The *distinct* values of a *row* field display in *rows headers*. The number of rendered rows will match the number of distinct values of the *row* field. |
There was a problem hiding this comment.
Something doesn't sound right here as "display" lacks an object - "The distinct values of a row field display in rows headers".
Suggested change
| * The *distinct* values of a *row* field display in *rows headers*. The number of rendered rows will match the number of distinct values of the *row* field. | |
| * The distinct values of a Row field are displayed in Row Headers. The number of rendered rows will match the number of distinct values of the Row field. |
| | ||
| * The *rows* and *columns* represent categories or date periods. | ||
| * The *distinct* values of a *row* field display in *rows headers*. The number of rendered rows will match the number of distinct values of the *row* field. | ||
| * The *distinct* values of a *column* field display in *column headers*. The number of rendered columns will match the number of distinct values of the *column* field. |
There was a problem hiding this comment.
Suggested change
| * The *distinct* values of a *column* field display in *column headers*. The number of rendered columns will match the number of distinct values of the *column* field. | |
| * The distinct values of a Column field are displayed in Column Headers. The number of rendered columns will match the number of distinct values of the Column field. |
| | ||
| ## Values | ||
| | ||
| The **Values** section of the Configurator shows all fields that are currently used as measures (dimensions). |
There was a problem hiding this comment.
Suggested change
| The **Values** section of the Configurator shows all fields that are currently used as measures (dimensions). | |
| The Values section of the Configurator shows all fields that are currently used as measures (dimensions). |
| | ||
| ## Buttons | ||
| | ||
| The bottom section of the Configurator renders *Apply* and *Cancel* buttons. End users should click them after adding or removing fields to the Columns, Rows and Values sections. |
There was a problem hiding this comment.
Suggested change
| The bottom section of the Configurator renders *Apply* and *Cancel* buttons. End users should click them after adding or removing fields to the Columns, Rows and Values sections. | |
| The bottom section of the Configurator renders **Apply** and **Cancel** buttons. End users should click them after adding or removing fields to the Columns, Rows, and Values sections. |
| | ||
| The bottom section of the Configurator renders *Apply* and *Cancel* buttons. End users should click them after adding or removing fields to the Columns, Rows and Values sections. | ||
| | ||
| The following user actions do not require users to click on *Apply*: |
There was a problem hiding this comment.
Suggested change
| The following user actions do not require users to click on *Apply*: | |
| The following user actions do not require users to click **Apply**: |
| --- | ||
| title: Data Binding | ||
| page_title: PivotGrid Data Binding | ||
| description: What are the different ways to provide data to the Telerik UI for Blazor PivotGrid. Information about XMLA datasource, local data. |
There was a problem hiding this comment.
Suggested change
| description: What are the different ways to provide data to the Telerik UI for Blazor PivotGrid. Information about XMLA datasource, local data. | |
| description: Learn what are the different ways to provide data to the Telerik UI for Blazor PivotGrid. Information about XMLA datasource, local data. |
| | ||
| The PivotGrid provides nested Razor components to setup the XMLA connection. Use the `<PivotGridSettings>` tag and place one or both of the following inside it: | ||
| | ||
| * [`<PivotGridXmlaDataProviderSettings>`](#xmla-data-provider-settings) - configures the data server URL and database name |
There was a problem hiding this comment.
Use an em dash in definition lists.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
No description provided.