Skip to main content

Plot

Plot Widget API

Properties​

ProgressBar​

WidgetHasState
</>
Plot.ProgressBar: Iris.PrograssBar

A progress bar line with a state value to show the current state.

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "Progress Bar",
    Format: string? = nil -- optional to override with a custom progress such as `29/54`
}
Events = {
    hovered: () -> boolean,
    changed: () -> boolean
}
States = {
    progress: State<number>?
}
Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "ProgressBar",
            "desc": "A progress bar line with a state value to show the current state.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"Progress Bar\",\n    Format: string? = nil -- optional to override with a custom progress such as `29/54`\n}\nEvents = {\n    hovered: () -> boolean,\n    changed: () -> boolean\n}\nStates = {\n    progress: State<number>?\n}\n```\n    ",
            "lua_type": "Iris.PrograssBar",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1634,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Plot",
    "desc": "Plot Widget API\n    ",
    "source": {
        "line": 1609,
        "path": "lib/API.lua"
    }
}