← Back to Docs
  • index.html
  • Clayground
  • Clayground.Lab
  • Parameter
  • Clayground 2026.7
  • Parameter QML Type

    A named, ranged lab parameter, auto-registered with Lab. More...

    Import Statement: import Clayground.Lab

    Properties

    Detailed Description

    Declare one per tunable quantity and bind your system to value. ParamPanel builds its sliders from all registered parameters; agents set values via Lab.set(name, value).

    Example usage:

    import Clayground.Lab
    
    Parameter { id: pGravity; name: "gravity"; value: 9.81; from: 0; to: 30; unit: "m/s²" }

    See also Lab and ParamPanel.

    Property Documentation

    description : string

    One-line explanation shown as tooltip/annotation.


    from : real

    Lower bound of the value range.


    name : string

    Unique name used by Lab, ParamPanel and agents.


    stepSize : real

    Slider step (0 = continuous).


    to : real

    Upper bound of the value range.


    unit : string

    Display unit, e.g. "m/s²".


    value : real

    Current value; bind your system to this.