Skip to content

Commit

Permalink
[update] how_to_start, headershape, tableshape, add-field, whats_new …
Browse files Browse the repository at this point in the history
…updated
  • Loading branch information
tbshag2 committed Jun 5, 2024
1 parent afe3dce commit d3b66f1
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/api/config/headershape-property.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ headerShape?: {

### Parameters

- `collapsible` - (optional) if set to **true**, dimension groups in the pivot table are collapsible; it's set to **false** by default
- `collapsible` - (optional) if set to **true**, dimension groups in the table are collapsible; it's set to **false** by default
- `vertical` - (optional) if set to **true**, changes the text orientation in all headers from horizontal to vertical; the default value is **false**
- `template` - (optional) defines the format of text in headers; by default, for the fields applied as rows the value of the `label` parameter is displayed and for the fields applied as values the label and method are shown (e.g., *Oil(count)*); the function takes the field id, label and the method or predicate id (if any) and returns the processed value (the default template is as follows:
~~~js
Expand Down
4 changes: 2 additions & 2 deletions docs/api/config/tableshape-property.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ tableShape?: {
operation: string
) => any;
},
totalRow?: boolean | "sumOnly",
totalColumn?: boolean | "sumOnly",
totalRow?: boolean,
totalColumn?: boolean,
marks?: {
[cssClass: string]: ((v: any, columnData: any, rowData: any) => boolean)
| "max"
Expand Down
8 changes: 4 additions & 4 deletions docs/api/events/add-field-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: You can learn about the add-field event in the documentation of the

### Description

@short: Fires when a new field is added
@short: Fires when a new field is added to the rows, columns or values area

### Usage

Expand All @@ -30,9 +30,9 @@ The callback of the action takes an object with the following parameters:
- `field` - (required) a new auto-generated field id
- `method` - (optional) defines a method for data aggregation (if not specified, a default method is set); a method can be one of the following:
- it's required for the **values** area, it's one of the data operation types:
- for numbers: min, max, sum, count
- for text values: count
- for date value: min, max, count
- for numbers: min, max, sum, count, counta, countunique, average, median, product, var, vapr, stdev, stdevp
- for text values: count, countunique, counta
- for date value: min, max, count, counta
- it's optional for the **rows** and **columns** areas, it's a default data predicate with one of the next values: year, month, day, hour, minute. If it's a custom predicate, the id is specified for the **predicate** property.

### Example
Expand Down
7 changes: 5 additions & 2 deletions docs/how-to-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: You can explore how to start working with DHTMLX Pivot in the docum

This clear and comprehensive tutorial will guide your through the steps you need to take in order to get a full-functional Pivot on a page.

image to be added!!!
![pivot-main](/assets/pivot-main.png)

## Step 1. Including source files

Expand Down Expand Up @@ -112,4 +112,7 @@ config: {

## What's next

That's all. Just three simple steps and you have a handy tool for visualizing and managing the workflow. Now you can start working with your tasks or keep exploring the inner world of JavaScript Pivot.
That's all. Just three simple steps and you have a handy tool for visualizing and managing the workflow. Now you can start working with your tasks or keep exploring the inner world of JavaScript Pivot:

- [Guides](/category/guides) pages provide instructions about installation, loading data, styling, and other helpful tips to go smoothly with the Pivot configuration
- [API reference](/api/overview/main-overview) gives description of the Pivot functionality
35 changes: 34 additions & 1 deletion docs/news/whats_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,37 @@ Released on Month Day, 2024

### Initial functionality

...
- **Configuring table structure**:
- defining rows, columns, and values by applying the **config** property
- adding, deleting, reordering fields
- updating the current config
- the rendering feature that allows altering the final table configuration on the fly or prevent the rendering of the table altogether.
- **Showing and hiding the configuration panel**
- **Configuring the look and behavior of columns**:
- the sorting feature
- 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**:
- 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**:
- applying templates to a cell
- marking cells
- configuring the sizes: rowHeight, headerHeight, footerHeight, colWidth
- the table tree mode
- generating the total column and footer
- hiding the duplicate values in the table view
- fixing columns from the left making them static while scrolling
- **Working with data**:
- loading data
- importing 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)
Binary file added static/assets/pivot-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d3b66f1

Please sign in to comment.