Skip to content

Commit

Permalink
[update] props updated
Browse files Browse the repository at this point in the history
  • Loading branch information
tbshag2 committed Jun 21, 2024
1 parent 7e5a3b4 commit 03db1ce
Show file tree
Hide file tree
Showing 19 changed files with 49 additions and 42 deletions.
6 changes: 4 additions & 2 deletions docs/api/events/add-field-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand All @@ -68,3 +68,5 @@ widget.api.intercept("add-field", (ev) => {
}
});
~~~

**Related articles**: [api.intercept()](/api/internal/intercept-method)
10 changes: 4 additions & 6 deletions docs/api/events/apply-filter-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The callback of the action takes an object with the following parameters:
- for text values: equal, notEqual, contains, notContains, beginsWith, notBeginsWith, endsWith, notEndsWith
- for numeric values: greater: less, greaterOrEqual, lessOrEqual, equal, notEqual, contains, notContains
- for date types: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, between, notBetween
- `value` - (optional) the value to filter by
- `includes` - (optional) an array of values to be displayed from those that are already filtered; available for text and date values
- `value` - (required) the value to filter by
- `includes` - (required) an array of values to be displayed from those that are already filtered; available for text and date values

### Example

Expand All @@ -42,11 +42,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand All @@ -58,6 +58,4 @@ widget.api.on("apply-filter", (ev) => {
});
~~~

---

**Related articles**: [api.on()](/api/internal/on-method)
4 changes: 2 additions & 2 deletions docs/api/events/delete-field-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ const table = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
8 changes: 4 additions & 4 deletions docs/api/events/open-filter-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down Expand Up @@ -75,11 +75,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/events/render-table-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
6 changes: 4 additions & 2 deletions docs/api/events/reorder-fields-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand All @@ -56,3 +56,5 @@ widget.api.on("move-field", (ev) => {
console.log("The id of the reordered field:", ev.id);
});
~~~

**Related articles**: [api.on()](/api/internal/on-method)
4 changes: 2 additions & 2 deletions docs/api/events/show-config-panel-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
2 changes: 2 additions & 0 deletions docs/api/events/update-config-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,5 @@ widget.api.intercept("update-config", (config) => {
console.log("Config has changed", config);
});
~~~

**Related articles**: [api.intercept()](/api/internal/intercept-method)
6 changes: 4 additions & 2 deletions docs/api/events/update-value-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ const widget = new pivot.Pivot("#pivot", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand All @@ -59,3 +59,5 @@ widget.api.on("update-field", (ev) => {
console.log("The id of the field that was updated:", ev.id);
});
~~~

**Related articles**: [api.on()](/api/internal/on-method)
4 changes: 2 additions & 2 deletions docs/api/internal/exec-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ const table = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/internal/getreactivestate-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ const table = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/internal/getstate-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ const table = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/internal/getstores-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ const table = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/internal/intercept-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ consttable = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/internal/on-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ const table = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
4 changes: 2 additions & 2 deletions docs/api/methods/setconfig-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ const widget = new pivot.Pivot("#root", {
columns: [],
values: [
{
id: "title",
field: "title",
method: "count",
},
{
id: "score",
field: "score",
method: "max",
},
],
Expand Down
1 change: 1 addition & 0 deletions docs/api/overview/properties-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ To configure the **Pivot**, refer to the [Configuration](../../../guides/configu
| -------------------------------------------------- | ------------------------------------------------ |
| [](../config/columnshape-property.md) | @getshort(../config/columnshape-property.md) |
| [](../config/config-property.md) | @getshort(../config/config-property.md) |
| [](../config/configpanel-property.md) | @getshort(../config/configpanel-property.md) |
| [](../config/data-property.md) | @getshort(../config/data-property.md) |
| [](../config/fields-property.md) | @getshort(../config/fields-property.md) |
| [](../config/headershape-property.md) | @getshort(../config/headershape-property.md) |
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ To change the order of rows in the table, drag an item to the desired position.
![rows-priority](assets/rows-priority.png)


#### Filters
### Filters

Filters appear as drop-down lists for each field:
Filters appear as drop-down lists for each field in all areas:

![filters](assets/filters.png)

Expand Down
8 changes: 4 additions & 4 deletions docs/news/whats_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Released on Month Day, 2024
- configuring the width
- setting autowidth with the ability to set maxRows to be processed for the autoWidth calculation
- the firstOnly feature when each field of the same data is analyzed only once to calculate the column width (by default)
- **Configuring the look of headers**:
- **Configuring the look and behavior of headers**:
- applying a template to the text in headers
- changing text orientation
- making dimension groups in the table collapsible
- **Configuring the look of the Pivot table**:
- **Configuring the look of the table**:
- applying templates to a cell
- marking cells
- configuring the sizes: rowHeight, headerHeight, footerHeight, colWidth
Expand All @@ -39,12 +39,12 @@ Released on Month Day, 2024
- fixing columns from the left making them static while scrolling
- **Working with data**:
- loading data
- importing data from CSV to JSON
- converting data from CSV to JSON
- exporting data to the xlsx or csv format
- sorting data
- adding and applying filters
- limiting loaded data
- applying and customizing maths methods
- processing data with predicates
- **Localization** and setting date format
- **Styling** (cell style, scroll style, ability to customize the Material theme)
- **Styling** (cell style, header template, scroll style, ability to customize the Material theme)

0 comments on commit 03db1ce

Please sign in to comment.