From 430453c0330abafe18de2019be2682c4effb78b0 Mon Sep 17 00:00:00 2001 From: tbshag2 Date: Wed, 12 Jun 2024 15:52:53 +0300 Subject: [PATCH] [update] guides updated --- docs/api/config/columnshape-property.md | 1 + docs/api/methods/gettable-method.md | 4 ++-- docs/api/methods/setconfig-method.md | 6 +++--- docs/api/methods/setlocale-method.md | 4 ++-- docs/api/methods/showconfigpanel-method.md | 4 ++-- docs/guides/configuration.md | 14 ++------------ docs/guides/localization.md | 2 +- docs/guides/stylization.md | 5 ----- docs/guides/working-with-data.md | 4 ++-- 9 files changed, 15 insertions(+), 29 deletions(-) diff --git a/docs/api/config/columnshape-property.md b/docs/api/config/columnshape-property.md index b127291..295c0f0 100644 --- a/docs/api/config/columnshape-property.md +++ b/docs/api/config/columnshape-property.md @@ -75,3 +75,4 @@ const pivotWidget = new pivot.Pivot("#pivot", { }, }); ~~~ + diff --git a/docs/api/methods/gettable-method.md b/docs/api/methods/gettable-method.md index e5b2f04..76c7b19 100644 --- a/docs/api/methods/gettable-method.md +++ b/docs/api/methods/gettable-method.md @@ -40,11 +40,11 @@ const widget = new pivot.Pivot("#root", { columns: [], values: [ { - id: "title", + field: "title", method: "count", }, { - id: "score", + field: "score", method: "max", }, ], diff --git a/docs/api/methods/setconfig-method.md b/docs/api/methods/setconfig-method.md index b3c8ab7..4af49ba 100644 --- a/docs/api/methods/setconfig-method.md +++ b/docs/api/methods/setconfig-method.md @@ -54,15 +54,15 @@ widget.setConfig({ columns: [], values: [ { - id: "title", + field: "title", method: "count", }, { - id: "score", + field: "score", method: "max", }, { - id: "type", + field: "type", method: "count", }, ], diff --git a/docs/api/methods/setlocale-method.md b/docs/api/methods/setlocale-method.md index 83f4e3a..c147f7c 100644 --- a/docs/api/methods/setlocale-method.md +++ b/docs/api/methods/setlocale-method.md @@ -33,11 +33,11 @@ const widget = new pivot.Pivot("#root", { columns: [], values: [ { - id: "title", + field: "title", method: "count", }, { - id: "score", + field: "score", method: "max", }, ], diff --git a/docs/api/methods/showconfigpanel-method.md b/docs/api/methods/showconfigpanel-method.md index c3bbf5c..c444e83 100644 --- a/docs/api/methods/showconfigpanel-method.md +++ b/docs/api/methods/showconfigpanel-method.md @@ -36,11 +36,11 @@ const widget = new pivot.Pivot("#root", { columns: [], values: [ { - id: "title", + field: "title", method: "count", }, { - id: "score", + field: "score", method: "max", }, ], diff --git a/docs/guides/configuration.md b/docs/guides/configuration.md index 1007564..53d7c16 100644 --- a/docs/guides/configuration.md +++ b/docs/guides/configuration.md @@ -220,10 +220,6 @@ To specify the parent row, put its name first in the `rows` array of the [`confi const widget = new pivot.Pivot("#pivot", { tableShape: { tree: true, - templates: { - rank: (v) => v, - members: (v) => v, - }, }, fields, data: dataset, @@ -257,7 +253,7 @@ const widget = new pivot.Pivot("#pivot", { ### Expanding/collapsing all rows -To expand/collapse all rows, the tree mode should be enabled via the `tableShape` property and you should use the [`render-table`](/api/events/render-table-event) event that allows changing configuration settings, namely, making data rows expanded or collapsed (via the `row.open` parameter of the tableConfig object). +To expand/collapse all rows, the tree mode should be enabled via the [`tableShape`](/api/config/tableshape-property) property and you should use the [`render-table`](/api/events/render-table-event) event that allows changing configuration settings, namely, making data rows expanded or collapsed (via the `row.open` parameter of the `tableConfig` object). The example below shows how to expand/collapse all data rows with the button click in the table tree mode. @@ -463,13 +459,7 @@ The Pivot widget provides the next condition types for filtering: - for numeric values: greater: less, greaterOrEqual, lessOrEqual, equal, notEqual, contains, notContains - for date types: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, between, notBetween -The widget also allows you to apply the **include** filtering rule to the data already filtered by one of the conditions. - -Fields with the additional filter are marked with a special sign in GUI: - -img to be changed - -![filtering](/assets/filtering.png) +The widget also allows you to apply the **include** filtering rule to the data already filtered by one of the conditions. Fields with the additional filter are marked with a special sign in GUI (please, see [Filters](/docs/index)) #### Default filters diff --git a/docs/guides/localization.md b/docs/guides/localization.md index eed4313..0a9d2f7 100644 --- a/docs/guides/localization.md +++ b/docs/guides/localization.md @@ -156,4 +156,4 @@ new pivot.Pivot({ In this snippet you can see how to switch between several locales: - TODO!!! + diff --git a/docs/guides/stylization.md b/docs/guides/stylization.md index 1299453..e189356 100644 --- a/docs/guides/stylization.md +++ b/docs/guides/stylization.md @@ -85,11 +85,6 @@ The example below demonstrates how to customize Material theme that is applied t ~~~ -In this snippet you can see how to apply a custom style to Pivot - - TODO!!! - - ## Scroll style You can also apply a custom style to the scroll bar of Pivot. For this, you can use the `.wx-styled-scroll` CSS class. Before using it, check compatibility with the modern browsers [here](https://caniuse.com/css-scrollbar). diff --git a/docs/guides/working-with-data.md b/docs/guides/working-with-data.md index e7a2880..adf044d 100644 --- a/docs/guides/working-with-data.md +++ b/docs/guides/working-with-data.md @@ -728,6 +728,6 @@ const widget = new pivot.Pivot("#pivot", { ## Example -In this snippet you can see how to use Pivot API for working with data: +In this snippet you can see how to apply maths operations: - TODO!!! +