Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@yoonieaj
yoonieaj committed Jun 28, 2024
1 parent 0250101 commit 972e23f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/docs/99-api/modules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ The format of the array of objects must adhere to the description provided in Me

#### Parameters

| Name | Type | Description |
| :-------------- | :---- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objects` | `any` | The array of objects to be drawn: this could be passed as an actual JavaScript array of objects, or as a JSON file containing the object array. This array of objects may also include the user-defined style configuration. See the demo files and style.md file for details. |
| `automation` | `any` | Whether the coordinates (of the objects on the canvas) should be automatically generated or manually inputted. |
| `configuration` | `any` | The configuration (display settings) defined by the user. This is also the place to define `sort_by` ("height" or "id") for the object space. NOTE: In the case that automation == true, then the user must define configuration.width, as this will be used as the "max canvas width" for the automation process. If automation == false, then all configuration properties are optional, and the function will still operate even without defining them. |
| Name | Type | Description |
| :-------------- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `objects` | `any` | The array of objects to be drawn: this could be passed as an actual JavaScript array of objects, or as a JSON file containing the object array. This array of objects may also include the user-defined style configuration. See the demo files and style.md file for details. |
| `automation` | `any` | Whether the coordinates (of the objects on the canvas) should be automatically generated or manually inputted. |
| `configuration` | `any` | The configuration (display settings) defined by the user. This is also the place to define `sort_by` ("height" or "id") for the object space. NOTE: In the case that automation == true, then the user must define configuration.width, as this will be used as the "max canvas width" for the automation process. If this user-defined width is too small, it will be overwritten by a calculated minimum width value. If automation == false, then all configuration properties are optional, and the function will still operate even without defining them. |

#### Returns

Expand Down

0 comments on commit 972e23f

Please sign in to comment.