Skip to content

Commit 09f6add

Browse files
authored
Merge pull request #87 from DHTMLX/spreadsheet/doc/DHX-5299
Spreadsheet/doc/dhx 5299
2 parents 78bf61e + 76774e7 commit 09f6add

543 files changed

Lines changed: 9168 additions & 801 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/accessibility.md‎

Lines changed: 449 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/accessibility_conformance_report.md‎

Lines changed: 220 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/angular_integration.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: Integration with Angular
33
title: Angular Integration
4-
description: You can learn about the Angular integration of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
4+
description: Use DHTMLX Spreadsheet in an Angular application. Create a project, add Spreadsheet as an Angular component, load data and handle events.
55
---
66

77
# Integration with Angular
@@ -234,6 +234,10 @@ ngOnDestroy() {
234234
}
235235
~~~
236236

237+
:::info
238+
The `destructor()` method removes the event handlers attached with `spreadsheet.events.on()`. When a new Spreadsheet instance is created, for example, when the component is created again, attach the handlers to the new instance.
239+
:::
240+
237241
### Step 3. Adding Spreadsheet into the app
238242

239243
To add the `SpreadsheetComponent` component into the app, open the *src/app/app.component.ts* file and replace the default code with the following one:

‎docs/api/api_overview.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_label: API overview
33
title: API Overview
4-
description: You can check an API overview of the DHTMLX JavaScript Spreadsheet library in the documentation. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.
4+
description: Overview of the DHTMLX Spreadsheet API, covering the constructor, methods, events, properties, and the sheet manager, selection, event bus and export modules.
55
---
66

77
# API overview
@@ -27,6 +27,7 @@ Parameters:
2727
| [](api/spreadsheet_addcolumn_method.md) | @getshort(api/spreadsheet_addcolumn_method.md) |
2828
| [](api/spreadsheet_addformula_method.md) | @getshort(api/spreadsheet_addformula_method.md) |
2929
| [](api/spreadsheet_addrow_method.md) | @getshort(api/spreadsheet_addrow_method.md) |
30+
| [](api/spreadsheet_announce_method.md) | @getshort(api/spreadsheet_announce_method.md) |
3031
| [](api/spreadsheet_clear_method.md) | @getshort(api/spreadsheet_clear_method.md) |
3132
| [](api/spreadsheet_deletecolumn_method.md) | @getshort(api/spreadsheet_deletecolumn_method.md) |
3233
| [](api/spreadsheet_deleterow_method.md) | @getshort(api/spreadsheet_deleterow_method.md) |
@@ -99,6 +100,7 @@ Parameters:
99100
| [](api/spreadsheet_multisheets_config.md) | @getshort(api/spreadsheet_multisheets_config.md) |
100101
| [](api/spreadsheet_readonly_config.md) | @getshort(api/spreadsheet_readonly_config.md) |
101102
| [](api/spreadsheet_rowscount_config.md) | @getshort(api/spreadsheet_rowscount_config.md) |
103+
| [](api/spreadsheet_selection_config.md) | @getshort(api/spreadsheet_selection_config.md) |
102104
| [](api/spreadsheet_toolbarblocks_config.md) | @getshort(api/spreadsheet_toolbarblocks_config.md) |
103105

104106

@@ -118,8 +120,11 @@ Parameters:
118120

119121
| Name | Description |
120122
| :--------------------------------------------- | :---------------------------------------------------- |
123+
| [](api/selection_disable_method.md) | @getshort(api/selection_disable_method.md) |
124+
| [](api/selection_enable_method.md) | @getshort(api/selection_enable_method.md) |
121125
| [](api/selection_getfocusedcell_method.md) | @getshort(api/selection_getfocusedcell_method.md) |
122126
| [](api/selection_getselectedcell_method.md) | @getshort(api/selection_getselectedcell_method.md) |
127+
| [](api/selection_isdisabled_method.md) | @getshort(api/selection_isdisabled_method.md) |
123128
| [](api/selection_removeselectedcell_method.md) | @getshort(api/selection_removeselectedcell_method.md) |
124129
| [](api/selection_setfocusedcell_method.md) | @getshort(api/selection_setfocusedcell_method.md) |
125130
| [](api/selection_setselectedcell_method.md) | @getshort(api/selection_setselectedcell_method.md) |

‎docs/api/eventsbus_detach_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ detach(name: string): void;
2323
### Example
2424

2525
~~~jsx {10}
26-
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
26+
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
2727
// config parameters
2828
});
2929
spreadsheet.parse(data);

‎docs/api/eventsbus_fire_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The method returns `false` if some of the event handlers return `false`. Otherwi
3232
### Example
3333

3434
~~~jsx {10}
35-
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
35+
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
3636
// config parameters
3737
});
3838
spreadsheet.parse(data);

‎docs/api/eventsbus_on_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ on(name: string, callback: function): void;
2424
### Example
2525

2626
~~~jsx {6-8}
27-
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
27+
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
2828
// config parameters
2929
});
3030
spreadsheet.parse(data);

‎docs/api/export_json_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ json(): void;
1919
### Example
2020

2121
~~~jsx {7}
22-
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
22+
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
2323
// config parameters
2424
});
2525
spreadsheet.parse(data);

‎docs/api/export_xlsx_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ xlsx(name:string): void;
2323
### Example
2424

2525
~~~jsx {7,10}
26-
const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
26+
const spreadsheet = new dhx.Spreadsheet("spreadsheet_container", {
2727
// config parameters
2828
});
2929
spreadsheet.parse(data);

‎docs/api/overview/actions_overview.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ spreadsheet.events.on("beforeColumnAdd", function(cell){
6767
| **merge** | The action is executed when merging a range of cells |
6868
| **removeCellStyles** | The action is executed when clearing styles of a cell |
6969
| **renameSheet** | The action is executed when renaming a sheet |
70-
| **resizeCol** | The action is executed when resizing a column |
71-
| **resizeRow** | The action is executed when resizing a row |
70+
| **resizeCol** | The action is executed when resizing a column by dragging its border or with the *Column width* command |
71+
| **resizeRow** | The action is executed when resizing a row by dragging its border or with the *Row height* command |
7272
| **setCellFormat** | The action is executed when changing the format of a cell |
7373
| **setCellValue** | The action is executed when changing or removing the value of a cell |
7474
| **setValidation** | The action is executed when setting data validation for a cell |
@@ -78,6 +78,13 @@ spreadsheet.events.on("beforeColumnAdd", function(cell){
7878
| **toggleFreeze** | The action is executed when freezing/unfreezing columns/rows |
7979
| **unmerge** | The action is executed when splitting cells |
8080

81+
:::note
82+
In the `config` object of the [`beforeAction`](api/spreadsheet_beforeaction_event.md) and [`afterAction`](api/spreadsheet_afteraction_event.md) events, the **resizeCol** and **resizeRow** actions pass:
83+
84+
- `cell` - the cell or range of cells whose columns or rows are resized
85+
- `val` - the new width or height in pixels. It is set only for the *Column width* and *Row height* commands, not for resizing by dragging
86+
:::
87+
8188
**Change log:**
8289

8390
- The **toggleFreeze** and **toggleVisibility** actions were added in v5.2

0 commit comments

Comments
 (0)