Skip to content

Commit

Permalink
docs: adding corresponding document entry
Browse files Browse the repository at this point in the history
  • Loading branch information
Nithos committed Oct 25, 2023
1 parent 2013687 commit 93f161d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/api/grafer-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,16 @@ Initiates a graph render using the [viewport method](./viewport.md#render).
| name | string | A string serving as an identifier for the layer to be added. Should be unique. |
| useColors | boolean - *optional* | A boolean indicating if the nodes, edges, and labels in the layer should use colors stored in the grafer controller during rendering, otherwise use colors specified in the layer data. |

### `addLayerAt`
###### void

| Parameter | Type | Description |
| :--- | :--- | :--- |
| layerData | GraferLayerData | An object containing lists of nodes, edges, and labels. See [GraferLayerData](./grafer-layer-data.md) for more information. |
| name | string | A string serving as an identifier for the layer to be added. Should be unique. |
| useColors | boolean - *optional* | A boolean indicating if the nodes, edges, and labels in the layer should use colors stored in the grafer controller during rendering, otherwise use colors specified in the layer data. |
| index | number - *optional* | A numeric value indicating at which position in the layer list should this layer be inserted into. If the index is out of range (i.e. layer.length < index < 0) then it will simply append it to the end as would calling [addLayer](#addlayer). |

### `removeLayerByName`
###### void

Expand Down

0 comments on commit 93f161d

Please sign in to comment.