diff --git a/resources/docs/docs/widgets/properties-reference.md b/resources/docs/docs/widgets/properties-reference.md index 42d057fdb..2f43d5a01 100644 --- a/resources/docs/docs/widgets/properties-reference.md +++ b/resources/docs/docs/widgets/properties-reference.md @@ -582,6 +582,8 @@ | --- | --- | --- | --- | |
rangeX#
| `object` | \{
 "min": 0,
 "max": 1
} | Defines the min and max values for the x axis | |
rangeY#
| `object` | \{
 "min": 0,
 "max": 1
} | Defines the min and max values for the y axis | + |
logScaleX#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the x axis. Set to `-1` for exponential scale. | + |
logScaleY#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the y axis. Set to `-1` for exponential scale. | |
origin#
| `number`|
`boolean` | "auto" | Defines the y axis origin. Set to `false` to disable it | === "value" @@ -614,6 +616,8 @@ | --- | --- | --- | --- | |
rangeX#
| `object` | \{
 "min": 20,
 "max": 22000
} | Defines the min and max values for the x axis (in Hz, logarithmic scale) | |
rangeY#
| `object` | \{
 "min": -6,
 "max": 6
} | Defines the min and max values for the y axis (in dB) | + |
logScaleX#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the x axis. Set to `-1` for exponential scale. | + |
logScaleY#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the y axis. Set to `-1` for exponential scale. | |
origin#
| `number`|
`boolean` | "auto" | Defines the y axis origin. Set to `false` to disable it | |
filters#
| `array` | "" | Each item must be an object with the following properties
- `type`: string ("highpass", "highshelf", "lowpass", "lowshelf", "peak", "bandpass" or "notch", default: "peak")
- `freq`: number (filter's resonant frequency, default: 1000)
- `q`: number (Q factor, default: 1)
- `gain`: number (default: 0)
- `on`: boolean (default: true)

See https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode | |
pips#
| `boolean` | true | Set to false to hide the scale | @@ -646,10 +650,11 @@ | --- | --- | --- | --- | |
rangeX#
| `object` | \{
 "min": 0,
 "max": 1
} | Defines the min and max values for the x axis | |
rangeY#
| `object` | \{
 "min": 0,
 "max": 1
} | Defines the min and max values for the y axis | + |
logScaleX#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the x axis. Set to `-1` for exponential scale. | + |
logScaleY#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the y axis (base 10). Set to a `number` to define the logarithm's base. | |
origin#
| `number` | "auto" | Defines the y axis origin. Set to `false` to disable it | |
duration#
| `number` | 1 | Defines visualization duration in seconds | |
framerate#
| `number` | 30 | Defines visualization framerate | - |
logScaleY#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the y axis (base 10). Set to a `number` to define the logarithm's base. | |
freeze#
| `boolean` | false | Set to `true` to freeze current view and ignore incoming values | === "value" @@ -717,6 +722,7 @@ |
rangeY#
| `object` | \{
 "min": 0,
 "max": 1
} | Defines the min and max values for the y axis | |
logScaleX#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the x axis. Set to `-1` for exponential scale. | |
logScaleY#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the y axis. Set to `-1` for exponential scale. | + |
axisLock#
| `string` | "" | Restrict movements to one of the axes only unless `Shift` is held.

When left to the default value, holding `Shift` while dragging will lock the pad according the first movement.

Choices: ``, `x`, `y` | |
doubleTap#
| `boolean`|
`string` | false | Set to `true` to make the fader reset to its default value when receiving a double tap.

Can also be an osc address, which case the widget will just send an osc message: `/ ` | |
sensitivity#
| `number` | 1 | Defines the pad's sensitivity when `snap` is `false` | @@ -769,6 +775,7 @@ |
rangeY#
| `object` | \{
 "min": 0,
 "max": 1
} | Defines the min and max values for the y axis | |
logScaleX#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the x axis. Set to `-1` for exponential scale. | |
logScaleY#
| `boolean`|
`number` | false | Set to `true` to use logarithmic scale for the y axis. Set to `-1` for exponential scale. | + |
axisLock#
| `string` | "" | Restrict movements to one of the axes only.

When left to the default value, holding `Shift` while dragging will lock the pad according the first movement.

Choices: ``, `x`, `y` | |
doubleTap#
| `boolean`|
`string` | false | Set to `true` to make the fader reset to its default value when receiving a double tap.

Can also be an osc address, which case the widget will just send an osc message: `/ ` | |
sensitivity#
| `number` | 1 | Defines the pad's sensitivity when `snap` is `false` | @@ -817,6 +824,7 @@ |
css#
| `string` | "" | CSS rules. See documentation.

Some style-related properties can be set or read from css using css variables:
- `--color-background`: `colorBg`
- `--color-widget`: `colorWidget`
- `--color-fill`: `colorFill`
- `--color-stroke`: `colorStroke`
- `--color-text`: `colorText`
- `--widget-padding`: `padding`
- `--line-width`: `lineWidth`
- `--border-radius`: `borderRadius`
- `--alpha-fill-on`: `alphaFillOn`
- `--alpha-fill-off`: `alphaFillOff`
- `--alpha-stroke`: `alphaStroke`
- `--alpha-pips`: `alphaPips`
- `--alpha-pips-text`: `alphaPipsText`

Canvas-based widget have their computed width and height available as css variables (read-only):
- `--widget-width`
- `--widget-height` | |
design#
| `string` | "default" | Design style

Choices: `default`, `round`, `compact` | |
knobSize#
| `number` | "auto" | Fader knob size | + |
colorKnob#
| `string` | "auto" | Fader knob color | |
horizontal#
| `boolean` | false | Set to `true` to display the fader horizontally | |
pips#
| `boolean` | false | Set to `true` to show range breakpoints (ignored if `design` is `compact`) | |
dashed#
| `boolean`|
`array` | false | Set to `true` to display a dashed gauge. Can be set as an `array` of two numbers : `[dash_size, gap_size]` | @@ -851,6 +859,7 @@ | --- | --- | --- | --- | |
css#
| `string` | "" | CSS rules. See documentation.

Some style-related properties can be set or read from css using css variables:
- `--color-background`: `colorBg`
- `--color-widget`: `colorWidget`
- `--color-fill`: `colorFill`
- `--color-stroke`: `colorStroke`
- `--color-text`: `colorText`
- `--widget-padding`: `padding`
- `--line-width`: `lineWidth`
- `--border-radius`: `borderRadius`
- `--alpha-fill-on`: `alphaFillOn`
- `--alpha-fill-off`: `alphaFillOff`
- `--alpha-stroke`: `alphaStroke`
- `--alpha-pips`: `alphaPips`
- `--alpha-pips-text`: `alphaPipsText`

Canvas-based widget have their computed width and height available as css variables (read-only):
- `--widget-width`
- `--widget-height` | |
design#
| `string` | "default" | Design style

Note: "solid" design uses "colorStroke" for the central knob color.

Choices: `default`, `solid`, `line` | + |
colorKnob#
| `string` | "auto" | Knob color | |
pips#
| `boolean` | false | Set to `true` to show the scale's breakpoints | |
dashed#
| `boolean`|
`array` | false | Set to `true` to display a dashed gauge. Can be set as an `array` of two numbers : `[dash_size, gap_size]` | |
angle#
| `number` | 270 | Defines the angle's width of the knob, in degrees | @@ -915,6 +924,7 @@ |
css#
| `string` | "" | CSS rules. See documentation.

Some style-related properties can be set or read from css using css variables:
- `--color-background`: `colorBg`
- `--color-widget`: `colorWidget`
- `--color-fill`: `colorFill`
- `--color-stroke`: `colorStroke`
- `--color-text`: `colorText`
- `--widget-padding`: `padding`
- `--line-width`: `lineWidth`
- `--border-radius`: `borderRadius`
- `--alpha-fill-on`: `alphaFillOn`
- `--alpha-fill-off`: `alphaFillOff`
- `--alpha-stroke`: `alphaStroke`
- `--alpha-pips`: `alphaPips`
- `--alpha-pips-text`: `alphaPipsText`

Canvas-based widget have their computed width and height available as css variables (read-only):
- `--widget-width`
- `--widget-height` | |
design#
| `string` | "default" | Design style

Choices: `default`, `round`, `compact` | |
knobSize#
| `number` | "auto" | Fader knob size | + |
colorKnob#
| `string` | "auto" | Fader knob color | |
horizontal#
| `boolean` | false | Set to `true` to display the fader horizontally | |
pips#
| `boolean` | false | Set to `true` to show range breakpoints (ignored if `design` is `compact`) | |
dashed#
| `boolean`|
`array` | false | Set to `true` to display a dashed gauge. Can be set as an `array` of two numbers : `[dash_size, gap_size]` |