Skip to content

Commit 03db1ce

Browse files
committed
[update] props updated
1 parent 7e5a3b4 commit 03db1ce

19 files changed

+49
-42
lines changed

docs/api/events/add-field-event.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ const widget = new pivot.Pivot("#pivot", {
4848
columns: [],
4949
values: [
5050
{
51-
id: "title",
51+
field: "title",
5252
method: "count",
5353
},
5454
{
55-
id: "score",
55+
field: "score",
5656
method: "max",
5757
},
5858
],
@@ -68,3 +68,5 @@ widget.api.intercept("add-field", (ev) => {
6868
}
6969
});
7070
~~~
71+
72+
**Related articles**: [api.intercept()](/api/internal/intercept-method)

docs/api/events/apply-filter-event.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The callback of the action takes an object with the following parameters:
2828
- for text values: equal, notEqual, contains, notContains, beginsWith, notBeginsWith, endsWith, notEndsWith
2929
- for numeric values: greater: less, greaterOrEqual, lessOrEqual, equal, notEqual, contains, notContains
3030
- for date types: greater, less, greaterOrEqual, lessOrEqual, equal, notEqual, between, notBetween
31-
- `value` - (optional) the value to filter by
32-
- `includes` - (optional) an array of values to be displayed from those that are already filtered; available for text and date values
31+
- `value` - (required) the value to filter by
32+
- `includes` - (required) an array of values to be displayed from those that are already filtered; available for text and date values
3333

3434
### Example
3535

@@ -42,11 +42,11 @@ const widget = new pivot.Pivot("#pivot", {
4242
columns: [],
4343
values: [
4444
{
45-
id: "title",
45+
field: "title",
4646
method: "count",
4747
},
4848
{
49-
id: "score",
49+
field: "score",
5050
method: "max",
5151
},
5252
],
@@ -58,6 +58,4 @@ widget.api.on("apply-filter", (ev) => {
5858
});
5959
~~~
6060

61-
---
62-
6361
**Related articles**: [api.on()](/api/internal/on-method)

docs/api/events/delete-field-event.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ const table = new pivot.Pivot("#root", {
3939
columns: [],
4040
values: [
4141
{
42-
id: "title",
42+
field: "title",
4343
method: "count",
4444
},
4545
{
46-
id: "score",
46+
field: "score",
4747
method: "max",
4848
},
4949
],

docs/api/events/open-filter-event.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ const widget = new pivot.Pivot("#pivot", {
4343
columns: [],
4444
values: [
4545
{
46-
id: "title",
46+
field: "title",
4747
method: "count",
4848
},
4949
{
50-
id: "score",
50+
field: "score",
5151
method: "max",
5252
},
5353
],
@@ -75,11 +75,11 @@ const widget = new pivot.Pivot("#pivot", {
7575
columns: [],
7676
values: [
7777
{
78-
id: "title",
78+
field: "title",
7979
method: "count",
8080
},
8181
{
82-
id: "score",
82+
field: "score",
8383
method: "max",
8484
},
8585
],

docs/api/events/render-table-event.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ const widget = new pivot.Pivot("#pivot", {
6868
columns: [],
6969
values: [
7070
{
71-
id: "title",
71+
field: "title",
7272
method: "count",
7373
},
7474
{
75-
id: "score",
75+
field: "score",
7676
method: "max",
7777
},
7878
],

docs/api/events/reorder-fields-event.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ const widget = new pivot.Pivot("#pivot", {
4141
columns: [],
4242
values: [
4343
{
44-
id: "title",
44+
field: "title",
4545
method: "count",
4646
},
4747
{
48-
id: "score",
48+
field: "score",
4949
method: "max",
5050
},
5151
],
@@ -56,3 +56,5 @@ widget.api.on("move-field", (ev) => {
5656
console.log("The id of the reordered field:", ev.id);
5757
});
5858
~~~
59+
60+
**Related articles**: [api.on()](/api/internal/on-method)

docs/api/events/show-config-panel-event.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ const widget = new pivot.Pivot("#pivot", {
3535
columns: [],
3636
values: [
3737
{
38-
id: "title",
38+
field: "title",
3939
method: "count",
4040
},
4141
{
42-
id: "score",
42+
field: "score",
4343
method: "max",
4444
},
4545
],

docs/api/events/update-config-event.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,5 @@ widget.api.intercept("update-config", (config) => {
7878
console.log("Config has changed", config);
7979
});
8080
~~~
81+
82+
**Related articles**: [api.intercept()](/api/internal/intercept-method)

docs/api/events/update-value-event.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ const widget = new pivot.Pivot("#pivot", {
4444
columns: [],
4545
values: [
4646
{
47-
id: "title",
47+
field: "title",
4848
method: "count",
4949
},
5050
{
51-
id: "score",
51+
field: "score",
5252
method: "max",
5353
},
5454
],
@@ -59,3 +59,5 @@ widget.api.on("update-field", (ev) => {
5959
console.log("The id of the field that was updated:", ev.id);
6060
});
6161
~~~
62+
63+
**Related articles**: [api.on()](/api/internal/on-method)

docs/api/internal/exec-method.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ const table = new pivot.Pivot("#root", {
4646
columns: [],
4747
values: [
4848
{
49-
id: "title",
49+
field: "title",
5050
method: "count",
5151
},
5252
{
53-
id: "score",
53+
field: "score",
5454
method: "max",
5555
},
5656
],

0 commit comments

Comments
 (0)