deploy: 373bd7b485
This commit is contained in:
24
docs/references/elements/Graph.md
Normal file
24
docs/references/elements/Graph.md
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
# Graph : VisualElement
|
||||||
|
|
||||||
|
## Functions
|
||||||
|
|
||||||
|
|Method|Returns|Description|
|
||||||
|
|---|---|---|
|
||||||
|
|[Graph.new](#Graph.new)|-|
|
||||||
|
|[Graph:addPoint](#Graph:addPoint)|-|
|
||||||
|
|[Graph:init](#Graph:init)|-|
|
||||||
|
|[Graph:render](#Graph:render)|-|
|
||||||
|
|[Graph:setPoint](#Graph:setPoint)|-|
|
||||||
|
|
||||||
|
|
||||||
|
## Graph.new()
|
||||||
|
|
||||||
|
## Graph:addPoint()
|
||||||
|
|
||||||
|
## Graph:init()
|
||||||
|
|
||||||
|
## Graph:render()
|
||||||
|
|
||||||
|
## Graph:setPoint()
|
||||||
|
|
||||||
|
|
||||||
@@ -25,6 +25,7 @@ custom item rendering, separators, and selection handling.
|
|||||||
|---|---|---|
|
|---|---|---|
|
||||||
|[List:addItem](#List:addItem)|List|Adds an item to the list
|
|[List:addItem](#List:addItem)|List|Adds an item to the list
|
||||||
|[List:clear](#List:clear)|List|Clears all items from the list
|
|[List:clear](#List:clear)|List|Clears all items from the list
|
||||||
|
|[List:getSelectedItem](#List:getSelectedItem)|table?|Gets first selected item
|
||||||
|[List:getSelectedItems](#List:getSelectedItems)|table|Gets the currently selected items
|
|[List:getSelectedItems](#List:getSelectedItems)|table|Gets the currently selected items
|
||||||
|[List:onSelect](#List:onSelect)|List|Registers a callback for the select event
|
|[List:onSelect](#List:onSelect)|List|Registers a callback for the select event
|
||||||
|[List:removeItem](#List:removeItem)|List|Removes an item from the list
|
|[List:removeItem](#List:removeItem)|List|Removes an item from the list
|
||||||
@@ -67,6 +68,12 @@ Clears all items from the list
|
|||||||
list:clear()
|
list:clear()
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## List:getSelectedItem()
|
||||||
|
Gets first selected item
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
* `table?` `selected` The first item
|
||||||
|
|
||||||
## List:getSelectedItems()
|
## List:getSelectedItems()
|
||||||
Gets the currently selected items
|
Gets the currently selected items
|
||||||
|
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ What this code does is it loads basalt into the project, and you can access it b
|
|||||||
|[basalt.create](#basalt.create)|table|Creates a new UI element
|
|[basalt.create](#basalt.create)|table|Creates a new UI element
|
||||||
|[basalt.createFrame](#basalt.createFrame)|table|Creates a new BaseFrame
|
|[basalt.createFrame](#basalt.createFrame)|table|Creates a new BaseFrame
|
||||||
|[basalt.getAPI](#basalt.getAPI)|table|Returns a Plugin API
|
|[basalt.getAPI](#basalt.getAPI)|table|Returns a Plugin API
|
||||||
|
|[basalt.getElementClass](#basalt.getElementClass)|table|Returns an element class
|
||||||
|[basalt.getElementManager](#basalt.getElementManager)|table|Returns the element manager
|
|[basalt.getElementManager](#basalt.getElementManager)|table|Returns the element manager
|
||||||
|[basalt.getMainFrame](#basalt.getMainFrame)|BaseFrame|Gets or creates the main frame
|
|[basalt.getMainFrame](#basalt.getMainFrame)|BaseFrame|Gets or creates the main frame
|
||||||
|[basalt.removeSchedule](#basalt.removeSchedule)|boolean|Removes a scheduled update
|
|[basalt.removeSchedule](#basalt.removeSchedule)|boolean|Removes a scheduled update
|
||||||
@@ -73,6 +74,15 @@ Returns a Plugin API
|
|||||||
### Returns
|
### Returns
|
||||||
* `table` `Plugin` The plugin API
|
* `table` `Plugin` The plugin API
|
||||||
|
|
||||||
|
## basalt.getElementClass(name)
|
||||||
|
Returns an element class
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
* `name` `string` The name of the element
|
||||||
|
|
||||||
|
### Returns
|
||||||
|
* `table` `Element` The element class
|
||||||
|
|
||||||
## basalt.getElementManager()
|
## basalt.getElementManager()
|
||||||
Returns the element manager instance
|
Returns the element manager instance
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user