|
1 | 1 | # Spreadsheet component |
2 | 2 |
|
3 | 3 | > [!WARNING] |
4 | | -> **Important: LICENSE** This component is not distributed under the same permissive MIT license as the rest of SQLpage, but rather under the [GNU AGPL v3 license](./LICENSE). |
| 4 | +> **Important legal notice** This component is not distributed under the same permissive MIT license as the rest of SQLpage, but rather under the [GNU AGPL v3 license](./LICENSE). |
5 | 5 | > This means that you can either: |
6 | 6 | > - use the component in a project that is itself open source under the AGPL license, for free, or |
7 | | -> - use the component in a project that is not open source, for commercial use, but in this case you **must** buy a license for the component from us: [email protected] |
| 7 | +> - use it in a commercial, closed source, setting by **buying a 600€ yearly license** for the component from us: [email protected] |
8 | 8 |
|
9 | 9 | The spreadsheet component generates an online editable spreadsheet similar to Google Sheets or Excel, the contents of which are loaded from the results of your SQL query. |
10 | 10 | It has the ability to edit cell data by posting their contents to another SQLpage. |
11 | 11 |
|
12 | | -## Top-level properties |
| 12 | +## Screenshot |
13 | 13 |
|
14 | | -- **update\_link**: the name of another sql file, to which cell contents will be posted on update. The sql file will receive the variables :x and :y (position of the cell that was updated), :value (the new textual contents of the cell) and :id if an id was assigned to the cell from the row-level properties. |
| 14 | + |
| 15 | +## Documentation |
| 16 | +### Top-level properties |
| 17 | + |
| 18 | +- **update\_link**: the name of another sql file, to which cell contents will be posted on update. The sql file will receive the variables: |
| 19 | + - `:x` and `:y` (position of the cell that was updated), |
| 20 | + - `:value` (the new textual contents of the cell), and |
| 21 | + - `:id` if an id was assigned to the cell from the row-level properties. |
15 | 22 | - **freeze\_x**: the number of columns to freeze on the left side |
16 | 23 | - **freeze\_y**: the number of rows to freeze on the top side |
17 | 24 |
|
18 | | -## Row-Level properties |
| 25 | +### Row-Level properties |
19 | 26 |
|
20 | | -- **X:** the value of the x-axis (horizontal cell number) **\- primary key** |
21 | | -- **Y:** the value of the y-axis (vertical cell number) **\- primary key** |
22 | | -- **Value:** the value of the cell |
23 | | -- **bold**: If present, the cell text is bold |
24 | | -- **italic**: If present, the cell text is italic |
25 | | -- **color**: cell background color |
26 | | -- **center**: If present, the cell text is centered. |
27 | | -- **right**: If present, the cell text is right-aligned |
28 | | -- **number\_format**: format the number according to the specified number format. Uses [excel number format codes](https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68). |
29 | | -- **id**: If present, the cell has this unique identifier that will be passed to the update\_link sql file. **\- primary key** |
| 27 | +- **x** the value of the x-axis (horizontal cell number) |
| 28 | +- **y** the value of the y-axis (vertical cell number) |
| 29 | +- **value** the value of the cell |
| 30 | +- **bold** If present, the cell text is bold |
| 31 | +- **italic** If present, the cell text is italic |
| 32 | +- **color** cell background color |
| 33 | +- **center** If present, the cell text is centered |
| 34 | +- **right** If present, the cell text is right-aligned |
| 35 | +- **number\_format** format the number according to the specified number format. Uses [excel number format codes](https://support.microsoft.com/en-us/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68). |
| 36 | +- **id** If present, the cell has this unique identifier that will be passed to the update\_link sql file. |
0 commit comments