Skip to main content

Plot

Plot Widget API

Properties​

ProgressBar​

WidgetHasState
</>
Plot.ProgressBar: Iris.ProgressBar

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>?
}

PlotLines​

WidgetHasState
</>
Plot.PlotLines: Iris.PlotLines

A line graph for plotting a single line. Includes hovering to see a specific value on the graph, and automatic scaling. Has an overlay text option at the top of the plot for displaying any information. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "Plot Lines",
    Height: number? = 0,
    Min: number? = min, -- Iris will use the minimum value from the values
    Max: number? = max, -- Iris will use the maximum value from the values
    TextOverlay: string? = ""
}
Events = {
    hovered: () -> boolean
}
States = {
    values: State<{number}>?,
    hovered: State<{number}>? -- read-only property
}

PlotHistogram​

WidgetHasState
</>
Plot.PlotHistogram: Iris.PlotHistogram

A hisogram graph for showing values. Includes hovering to see a specific block on the graph, and automatic scaling. Has an overlay text option at the top of the plot for displaying any information. Also supports a baseline option, which determines where the blocks start from. 

hasChildren = false
hasState = true
Arguments = {
    Text: string? = "Plot Histogram",
    Height: number? = 0,
    Min: number? = min, -- Iris will use the minimum value from the values
    Max: number? = max, -- Iris will use the maximum value from the values
    TextOverlay: string? = "",
    BaseLine: number? = 0 -- by default, blocks swap side at 0
}
Events = {
    hovered: () -> boolean
}
States = {
    values: State<{number}>?,
    hovered: State<{number}>? -- read-only property
}
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.ProgressBar",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1798,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "PlotLines",
            "desc": "A line graph for plotting a single line. Includes hovering to see a specific value on the graph,\nand automatic scaling. Has an overlay text option at the top of the plot for displaying any\ninformation.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"Plot Lines\",\n    Height: number? = 0,\n    Min: number? = min, -- Iris will use the minimum value from the values\n    Max: number? = max, -- Iris will use the maximum value from the values\n    TextOverlay: string? = \"\"\n}\nEvents = {\n    hovered: () -> boolean\n}\nStates = {\n    values: State<{number}>?,\n    hovered: State<{number}>? -- read-only property\n}\n```\n    ",
            "lua_type": "Iris.PlotLines",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1829,
                "path": "lib/API.lua"
            }
        },
        {
            "name": "PlotHistogram",
            "desc": "A hisogram graph for showing values. Includes hovering to see a specific block on the graph,\nand automatic scaling. Has an overlay text option at the top of the plot for displaying any\ninformation. Also supports a baseline option, which determines where the blocks start from.\n\n```lua\nhasChildren = false\nhasState = true\nArguments = {\n    Text: string? = \"Plot Histogram\",\n    Height: number? = 0,\n    Min: number? = min, -- Iris will use the minimum value from the values\n    Max: number? = max, -- Iris will use the maximum value from the values\n    TextOverlay: string? = \"\",\n    BaseLine: number? = 0 -- by default, blocks swap side at 0\n}\nEvents = {\n    hovered: () -> boolean\n}\nStates = {\n    values: State<{number}>?,\n    hovered: State<{number}>? -- read-only property\n}\n```\n    ",
            "lua_type": "Iris.PlotHistogram",
            "tags": [
                "Widget",
                "HasState"
            ],
            "source": {
                "line": 1861,
                "path": "lib/API.lua"
            }
        }
    ],
    "types": [],
    "name": "Plot",
    "desc": "Plot Widget API\n    ",
    "source": {
        "line": 1773,
        "path": "lib/API.lua"
    }
}