From 972e23fa6921c454446d3d83decf69b7aae9422e Mon Sep 17 00:00:00 2001 From: yoonie-jang Date: Fri, 28 Jun 2024 18:02:03 -0400 Subject: [PATCH] Update documentation --- docs/docs/99-api/modules.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/99-api/modules.md b/docs/docs/99-api/modules.md index 63094e23..49fa5e04 100644 --- a/docs/docs/99-api/modules.md +++ b/docs/docs/99-api/modules.md @@ -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