Skip to content

Commit 245fe9c

Browse files
author
Victory
committed
[update] docs
1 parent 5491ae8 commit 245fe9c

File tree

7 files changed

+46
-11
lines changed

7 files changed

+46
-11
lines changed

docs/api/spreadsheet_sortcells_method.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,22 @@ sortCells(cell: string, dir: number): void;
2525

2626
### Example
2727

28-
~~~jsx {5}
28+
~~~jsx {6,9}
2929
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
30-
// config parameters
30+
topSplit: 1
3131
});
3232

33+
// sorts data on the first sheet
3334
spreadsheet.sortCells("B2:B11", -1);
35+
36+
// sorts data on the Income sheet
37+
spreadsheet.sortCells("Income!B2:B11", 1);
3438
~~~
3539

40+
:::info
41+
Use the [topSplit](api/spreadsheet_topsplit_config.md) property if you need to exclude the top rows from sorting.
42+
:::
43+
3644
**Related sample:** [Spreadsheet. Initialization with multiple sheets](https://snippet.dhtmlx.com/ihtkdcoc)
3745

3846
**Related articles:** [Sorting data](working_with_ssheet.md#sorting-data)

docs/assets/sort_col.png

63.4 KB
Loading

docs/assets/sort_col_menu.png

57.1 KB
Loading

docs/assets/sort_cols.gif

3.56 MB
Loading

docs/functions.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Check the example in our [snippet tool](https://snippet.dhtmlx.com/wux2b35b).
175175
<li><i>number_s</i> - the number of successes in trials;</li>
176176
<li><i>trials</i> - the number of independent trials;</li>
177177
<li><i>probability_s</i> - the probability of success on each trial;</li>
178-
<li><i>cumulative</i> - if TRUE, then BINOM.DIST returns the cumulative distribution function; if FALSE, it returns the probability mass function.</li>
178+
<li><i>cumulative</i> - if TRUE, then BINOM.DIST returns the cumulative distribution function; if FALSE (use 0), it returns the probability mass function.</li>
179179
</ul></td>
180180
<td>Returns the individual term binomial distribution probability.</td>
181181
</tr>
@@ -942,6 +942,17 @@ Check the example in our [snippet tool](https://snippet.dhtmlx.com/wux2b35b).
942942
</ul></td>
943943
<td>Returns the Weibull distribution.</td>
944944
</tr>
945+
<tr>
946+
<td><b>WEIBULL.DIST</b><br>added in v4.3</td>
947+
<td>=WEIBULL(x, alpha, beta, cumulative), <br><br> where:
948+
<ul>
949+
<li><i>x</i> - the value at which the function must be calculated (must be ≥ 0);</li>
950+
<li><i>alpha</i> - the alpha parameter to the distribution (must be > 0);</li>
951+
<li><i>beta</i> - the beta parameter to the distribution (must be > 0);</li>
952+
<li><i>cumulative</i> - the logical (true/false) argument which defines the type of distribution to be used. If True - Weibull cumulative distribution function, if False - Weibull probability density function </li>
953+
</ul></td>
954+
<td>Returns the Weibull distribution.</td>
955+
</tr>
945956
</tbody>
946957
</table>
947958

@@ -1065,15 +1076,25 @@ Check the example in our [snippet tool](https://snippet.dhtmlx.com/wux2b35b).
10651076
</tr>
10661077
<tr>
10671078
<td><b>VLOOKUP</b><br>added in v4.3</td>
1068-
<td>=XLOOKUP(lookup_value, lookup_array, return_array, [if_not_found], [match_mode]), <br><br> where:
1079+
<td>=VLOOKUP(lookup_value, table_array, column_index_num, [range_lookup]), <br><br> where:
1080+
<ul>
1081+
<li><i>lookup_value</i> - the value to search for in the first column of a table;</li>
1082+
<li><i>table_array</i> - the table from which to retrieve a value;</li>
1083+
<li><i>column_index_num</i> - the column number in the table from which to retrieve a value;</li>
1084+
<li><i>range_lookup</i> - optional (1 by default):<br>0 - exact match, 1 - approximate match</li>
1085+
</ul></td>
1086+
<td>Looks up a value in a vertical table by matching on the first column</td>
1087+
</tr>
1088+
<tr>
1089+
<td><b>HLOOKUP</b><br>added in v4.3</td>
1090+
<td>=HLOOKUP(lookup_value, table_array, row_index, [range_lookup]), <br><br> where:
10691091
<ul>
10701092
<li><i>lookup_value</i> - the value to search for;</li>
1071-
<li><i>lookup_array</i> - the array or range to search;</li>
1072-
<li><i>return_array</i> - the array or range to return;</li>
1073-
<li><i>if_not_found</i> - optional, if a valid match is not found, returns the [if_not_found] text you supply;</li>
1074-
<li><i>match_mode</i> - optional (0 by default):<br>0 - Exact match<br>-1 - Exact match. If not found, returns the next smaller item<br>1 - Exact match. If not found, returns the next larger item</li>
1093+
<li><i>table_array</i> - the table from which to retrieve a value;</li>
1094+
<li><i>column_index_num</i> - the row number in the table from which to retrieve a value;</li>
1095+
<li><i>range_lookup</i> - optional (1 by default):<br>0 - exact match, 1 - approximate match</li>
10751096
</ul></td>
1076-
<td>Searches a range or an array, and then returns the item corresponding to the first match it finds. If no match exists, then XLOOKUP can return the closest (approximate) match.</td>
1097+
<td>Looks up a value in a horizontal table</td>
10771098
</tr>
10781099
</tbody>
10791100
</table>

docs/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: You can learn about migration in the documentation of the DHTMLX Ja
1010

1111
Version 4.3 brings a new conception of tracking and handling the actions which are performed when you change something in the spreadsheet.
1212

13-
The new [beforeAction](api/spreadsheet_beforeaction_event.md) and [afterAction](api/spreadsheet_afteraction_event.md) events will fire right before / after an action is executed and indicate which action has been performed. Thus, the new approach allows you to add the necessary logic for several actions at once via using these two events only. For instance:
13+
The new [beforeAction](api/spreadsheet_beforeaction_event.md) and [afterAction](api/spreadsheet_afteraction_event.md) events will fire right before / after an action is executed and indicate which action has been performed. Thus, the new approach allows you to add the necessary logic for several actions at once via using only these two events. For instance:
1414

1515
~~~js
1616
spreadsheet.events.on("BeforeAction", (actionName, config) => {

docs/sorting_data.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,16 @@ To sort spreadsheet data by a column, take the following steps:
1414

1515
2\. Choose *Sort* -> *Sort A to Z* or *Sort Z to A*
1616

17+
![Sort column](assets/sort_col.png)
18+
1719
or
1820

1921
1\. Select the necessary column by clicking on its header
2022

2123
2\. Go to: *Data* -> *Sort* -> *Sort A to Z* or *Sort Z to A* in the menu
2224

25+
![Sort column](assets/sort_col_menu.png)
26+
2327
## Sorting data by a range
2428

2529
To sort spreadsheet data by a separate range, take the following steps:
@@ -29,4 +33,6 @@ To sort spreadsheet data by a separate range, take the following steps:
2933
2\. Choose one of the two actions:
3034

3135
- Right-click a cell in the selected range and choose *Sort* -> *Sort A to Z* or *Sort Z to A*
32-
- Or go to: *Data* -> *Sort* -> *Sort A to Z* or *Sort Z to A* in the menu
36+
- Or go to: *Data* -> *Sort* -> *Sort A to Z* or *Sort Z to A* in the menu
37+
38+
![Sort column](assets/sort_cols.gif)

0 commit comments

Comments
 (0)