renoise.ViewBuilder

Class which is used to construct new views. All view properties can optionally be in-lined in a passed construction table:

local vb = renoise.ViewBuilder() -- create a new ViewBuilder
vb:button { text = "ButtonText" } -- is the same as
my_button = vb:button(); my_button.text = "ButtonText"

Besides the listed class properties, you can also specify the following "extra" properties in the passed table:

  • id = "SomeString": Can be use to resolve the view later on, e.g. vb.views.SomeString or vb.views["SomeString"]

  • Nested child views: Add child views to the currently specified view.

examples:

Creates a column view with margin = 1 and adds two text views to the column.

vb:column {
  margin = 1,
  vb:text {
    text = "Text1"
  },
  vb:text {
    text = "Text1"
  }
}

Constants

DEFAULT_CONTROL_MARGIN : integer

The default margin for all control views

DEFAULT_CONTROL_SPACING : integer

The default spacing for all control views

DEFAULT_CONTROL_HEIGHT : integer

The default height for control views

DEFAULT_MINI_CONTROL_HEIGHT : integer

The default height for mini-sliders

DEFAULT_DIALOG_MARGIN : integer

The default margin for dialogs

DEFAULT_DIALOG_SPACING : integer

The default spacing for dialogs

DEFAULT_DIALOG_BUTTON_HEIGHT : integer

The default height for buttons

Properties

views : table<string, renoise.Views.View>

Table of views, which got registered via the "id" property View id is the table key, the table's value is the view's object.

examples:

vb:text { id="my_view", text="some_text"}
vb.views.my_view.visible = false
--or
vb.views["my_view"].visible = false

Functions

column(self, properties : RackViewProperties)

You can add nested child views when constructing a column or row by including them in the constructor table in the views property.

examples:

vb:column {
  margin = 1,
  vb:text {
    text = "Text1"
  },
  vb:text {
    text = "Text2"
  }
}

row(self, properties : RackViewProperties)

You can add nested child views when constructing a column or row by including them in the constructor table in the views property.

examples:

vb:column {
  margin = 1,
  vb:text {
    text = "Text1"
  },
  vb:text {
    text = "Text2"
  }
}

horizontal_aligner(self, properties : AlignerViewProperties)

You can add nested child views when constructing aligners by including them in the constructor table.

examples:

vb:horizontal_aligner {
   mode = "center",
   vb:text {
     text = "Text1"
   },
   vb:text {
     text = "Text2"
   }
}

vertical_aligner(self, properties : AlignerViewProperties)

You can add nested child views when constructing aligners by including them in the constructor table.

examples:

vb:horizontal_aligner {
   mode = "center",
   vb:text {
     text = "Text1"
   },
   vb:text {
     text = "Text2"
   }
}

space(self, properties : ViewProperties)

You can create an empty space in layouts with a space.

examples:

--Empty space in layouts
vb:row {
  vb:button {
    text = "Some Button"
  },
  vb:space { -- extra spacing between buttons
    width = 8
  },
  vb:button {
    text = "Another Button"
  },
}

text(self, properties : TextViewProperties?)

->renoise.Views.Text

See: renoise.Views.Text

multiline_text(self, properties : MultilineTextViewProperties?)

->renoise.Views.MultiLineText

See: renoise.Views.MultiLineText

textfield(self, properties : TextFieldProperties?)

->renoise.Views.TextField

See: renoise.Views.TextField

multiline_textfield(self, properties : MultilineTextFieldProperties?)

->renoise.Views.MultiLineTextField

See: renoise.Views.MultiLineTextField

bitmap(self, properties : BitmapViewProperties?)

->renoise.Views.Bitmap

See: renoise.Views.Bitmap

button(self, properties : ButtonProperties?)

->renoise.Views.Button

See: renoise.Views.Button

checkbox(self, properties : CheckBoxProperties?)

->renoise.Views.CheckBox

See: renoise.Views.CheckBox

switch(self, properties : ButtonSwitchProperties?)

->renoise.Views.Switch

See: renoise.Views.Switch

->renoise.Views.Popup

See: renoise.Views.Popup

chooser(self, properties : ChooserProperties?)

->renoise.Views.Chooser

See: renoise.Views.Chooser

valuebox(self, properties : ValueBoxProperties?)

->renoise.Views.ValueBox

See: renoise.Views.ValueBox

value(self, properties : ValueViewProperties?)

->renoise.Views.Value

See: renoise.Views.Value

valuefield(self, properties : ValueFieldProperties?)

->renoise.Views.ValueField

See: renoise.Views.ValueField

slider(self, properties : SliderProperties?)

->renoise.Views.Slider

See: renoise.Views.Slider

minislider(self, properties : MiniSliderProperties?)

->renoise.Views.MiniSlider

See: renoise.Views.MiniSlider

rotary(self, properties : RotaryEncoderProperties?)

->renoise.Views.RotaryEncoder

See: renoise.Views.RotaryEncoder

xypad(self, properties : XYPadProperties?)

->renoise.Views.XYPad

See: renoise.Views.XYPad

Local Structs

AlignerViewProperties

Properties

margin : RackMargin?

Set the "borders" of a rack (left, right, top and bottom inclusively)

  • Default: 0 (no borders)

spacing : RackSpacing?

Set the amount stacked child views are separated by (horizontally in rows, vertically in columns).

  • Default: 0 (no spacing)

mode : AlignerMode?

  • Default: "left" (for horizontal_aligner) "top" (for vertical_aligner)

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

BitmapViewProperties

Properties

mode : BitmapMode?

Setup how the bitmap should be drawn, recolored. Available modes are:

bitmap : BitmapPath?

Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency).

notifier : ButtonNotifier?

A click notifier

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ButtonProperties

Properties

text : ButtonLabel?

The text label of the button

  • Default: ""

bitmap : ButtonBitmapPath?

If set, existing text is removed and the loaded image is displayed instead. Supported bitmap file formats are ".bmp", ".png" and ".tiff". Colors in bitmaps will be overridden by the button's theme color, using black as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. All other colors are mapped to the theme color according to their grey value, so plain white is the target theme color, and all other colors blend into the button's background color of the theme.

color : ButtonColor?

When set, the unpressed button's background will be drawn in the specified color. A text color is automatically selected unless explicitly set, to make sure it's always visible. Set color {0,0,0} to enable the theme colors for the button again.

notifier : ButtonNotifier?

A click notifier

pressed : ButtonNotifier?

A click notifier

released : ButtonNotifier?

A click notifier

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ButtonSwitchProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SelectedItem?

The currently selected item's index

notifier : IntegerNotifier?

Set up a notifier that will be called whenever a new item is picked

items : ItemLabels?

A list of buttons labels to show in order. Must have more than one item.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

CheckBoxProperties

Properties

bind : ViewBooleanObservable?

Bind the view's value to a renoise.Document.ObservableBoolean object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : CheckBoxBoolean?

The current state of the checkbox, expressed as boolean.

  • Default: false

notifier : CheckBoxBooleanNotifier?

A notifier for when the checkbox is toggled

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ChooserProperties

Properties

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SelectedItem?

The currently selected item's index

notifier : IntegerNotifier?

Set up a notifier that will be called whenever a new item is picked

items : ItemLabels?

A list of buttons labels to show in order. Must have more than one item.

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

MiniSliderProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SliderNumberValue?

The current value of the view

notifier : NumberValueNotifier?

Set up a value notifier that will be called whenever the value changes

min : SliderMinValue?

The minimum value that can be set using the view

  • Default: 0

max : SliderMaxValue?

The maximum value that can be set using the view

  • Default: 1.0

default : SliderDefaultValue?

The default value that will be re-applied on double-click

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

MultilineTextFieldProperties

Properties

bind : ViewStringListObservable?

Bind the view's value to a renoise.Document.ObservableStringList object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

active : TextActive?

When false, text is displayed but can not be entered/modified by the user.

  • Default: true

value : TextMultilineString?

The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs.

notifier : StringChangeNotifier?

Set up a notifier for text changes

text : TextValueAlias?

Exactly the same as "value"; provided for consistency.

  • Default: ""

paragraphs : TextParagraphs?

A table of text lines to be used instead of specifying a single text line with newline characters like "text"

  • Default: []

font : TextFontStyle?

The style that the text should be displayed with.

style : TextBackgroundStyle?

Setup the text view's background:

edit_mode : TextEditMode?

True when the text field is focused. setting it at run-time programmatically will focus the text field or remove the focus (focus the dialog) accordingly.

  • Default: false

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

MultilineTextViewProperties

Properties

text : TextMultilineString?

The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs.

paragraphs : TextParagraphs?

A table of text lines to be used instead of specifying a single text line with newline characters like "text"

  • Default: []

font : TextFontStyle?

The style that the text should be displayed with.

style : TextBackgroundStyle?

Setup the text view's background:

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

PopUpMenuProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SelectedItem?

The currently selected item's index

notifier : IntegerNotifier?

Set up a notifier that will be called whenever a new item is picked

items : PopupItemLabels?

A list of buttons labels to show in order The list can be empty, then "None" is displayed and the value won't change.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

RackViewProperties

Properties

margin : RackMargin?

Set the "borders" of a rack (left, right, top and bottom inclusively)

  • Default: 0 (no borders)

spacing : RackSpacing?

Set the amount stacked child views are separated by (horizontally in rows, vertically in columns).

  • Default: 0 (no spacing)

style : ViewBackgroundStyle?

Setup a background style for the view.

uniform : RackUniformity?

When set to true, all child views in the rack are automatically resized to the max size of all child views (width in ViewBuilder.column, height in ViewBuilder.row). This can be useful to automatically align all sub columns/panels to the same size. Resizing is done automatically, as soon as a child view size changes or new children are added.

  • Default: false

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

RotaryEncoderProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SliderNumberValue?

The current value of the view

notifier : NumberValueNotifier?

Set up a value notifier that will be called whenever the value changes

min : SliderMinValue?

The minimum value that can be set using the view

  • Default: 0

max : SliderMaxValue?

The maximum value that can be set using the view

  • Default: 1.0

default : SliderDefaultValue?

The default value that will be re-applied on double-click

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

SliderProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SliderNumberValue?

The current value of the view

notifier : NumberValueNotifier?

Set up a value notifier that will be called whenever the value changes

min : SliderMinValue?

The minimum value that can be set using the view

  • Default: 0

max : SliderMaxValue?

The maximum value that can be set using the view

  • Default: 1.0

steps : SliderStepAmounts?

A table containing two numbers representing the step amounts for incrementing and decrementing by clicking the <> buttons. The first value is the small step (applied on left clicks) second value is the big step (applied on right clicks)

default : SliderDefaultValue?

The default value that will be re-applied on double-click

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

TextFieldProperties

Properties

bind : ViewStringObservable?

Bind the view's value to a renoise.Document.ObservableString object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

active : TextActive?

When false, text is displayed but can not be entered/modified by the user.

  • Default: true

value : TextValue?

The currently shown text. The text will not be updated when editing, rather only after editing is complete (return is pressed, or focus is lost).

  • Default: ""

notifier : StringChangeNotifier?

Set up a notifier for text changes

text : TextValueAlias?

Exactly the same as "value"; provided for consistency.

  • Default: ""

align : TextAlignment?

Setup the text's alignment. Applies only when the view's size is larger than the needed size to draw the text

edit_mode : TextEditMode?

True when the text field is focused. setting it at run-time programmatically will focus the text field or remove the focus (focus the dialog) accordingly.

  • Default: false

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

TextViewProperties

Properties

text : TextSingleLineString?

The text that should be displayed. Setting a new text will resize the view in order to make the text fully visible (expanding only).

  • Default: ""

font : TextFontStyle?

The style that the text should be displayed with.

style : TextStyle?

Get/set the color style the text should be displayed with.

align : TextAlignment?

Setup the text's alignment. Applies only when the view's size is larger than the needed size to draw the text

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ValueBoxProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SliderNumberValue?

The current value of the view

notifier : NumberValueNotifier?

Set up a value notifier that will be called whenever the value changes

min : ValueBoxMinValue?

The minimum value that can be set using the view

  • Default: 0

max : ValueBoxMaxValue?

The maximum value that can be set using the view

  • Default: 100

steps : SliderStepAmounts?

A table containing two numbers representing the step amounts for incrementing and decrementing by clicking the <> buttons. The first value is the small step (applied on left clicks) second value is the big step (applied on right clicks)

tostring : PairedShowNumberAsString?

Make sure to also set tonumber if you set this.

tonumber : PairedParseStringAsNumber?

Make sure to also set tostring if you set this.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ValueFieldProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SliderNumberValue?

The current value of the view

notifier : NumberValueNotifier?

Set up a value notifier that will be called whenever the value changes

min : SliderMinValue?

The minimum value that can be set using the view

  • Default: 0

max : SliderMaxValue?

The maximum value that can be set using the view

  • Default: 1.0

align : TextAlignment?

Setup the text's alignment. Applies only when the view's size is larger than the needed size to draw the text

tostring : PairedShowNumberAsString?

Make sure to also set tonumber if you set this.

tonumber : PairedParseStringAsNumber?

Make sure to also set tostring if you set this.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ValueViewProperties

Properties

bind : ViewNumberObservable?

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

value : SliderNumberValue?

The current value of the view

notifier : NumberValueNotifier?

Set up a value notifier that will be called whenever the value changes

align : TextAlignment?

Setup the text's alignment. Applies only when the view's size is larger than the needed size to draw the text

font : TextFontStyle?

The style that the text should be displayed with.

tostring : ShowNumberAsString?

Set a custom rule on how a number value should be displayed. Useful for showing units like decibel or note values etc. If none are set, a default string/number conversion is done, which simply shows the number with 3 digits after the decimal point. Note: When the callback fails with an error, it will be disabled to avoid a flood of error messages.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ViewProperties

Base for all View constructor tables in the viewbuilder.

Properties

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

XYPadProperties

Properties

active : ControlActive?

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

midi_mapping : ControlMidiMappingString?

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

id : ViewId?

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

width : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

height : ViewDimension?

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

visible : ViewVisibility?

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

tooltip : ViewTooltip?

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

bind : XYPadObservables?

Bind the view's value to a pair of renoise.Document.ObservableNumber objects. Automatically keep both values in sync. Will change the Observables' values as soon as the view's value changes, and change the view's values as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object. Just like in the other XYPad properties, a table with the fields X and Y is expected here and not a single value. So you have to bind two ObservableNumber object to the pad.

value : XYPadValues?

A table of the XYPad's current values on each axis

snapback : XYPadSnapbackValues?

A table of snapback values for each axis When snapback is enabled, the pad will revert its values to the specified snapback values as soon as the mouse button is released in the pad. When disabled, releasing the mouse button will not change the value. You can disable snapback at runtime by setting it to nil or an empty table.

notifier : XYValueNotifier?

Set up a value notifier function that will be used whenever the pad's values change

min : XYPadMinValues?

A table of allowed minimum values for each axis

  • Default: {x: 0.0, y: 0.0}

max : XYPadMaxValues?

A table of allowed maximum values for each axis

  • Default: {x: 1.0, y: 1.0}

Local Aliases

AlignerMode

"bottom" | "center" | "distribute" | "justify" | "left" | "right" | "top"

-- * Default: "left" (for horizontal_aligner) "top" (for vertical_aligner)
AlignerMode:
    | "left" -- align from left to right (for horizontal_aligner only)
    | "right" -- align from right to left (for horizontal_aligner only)
    | "top" -- align from top to bottom (for vertical_aligner only)
    | "bottom" -- align from bottom to top (for vertical_aligner only)
    | "center" -- center all views
    | "justify" -- keep outer views at the borders, distribute the rest
    | "distribute" -- equally distributes views over the aligners width/height

BitmapImagePath

string

You can load an image from your tool's directory, or use one from Renoise's built-in icons.

  • For the built-in icons, use "Icons/ArrowRight.bmp"
  • For custom images, use a path relative to your tool's root folder.

For example "Images/MyBitmap.bmp" will load the image from "com.me.MyTool.xrnx/Images/MyBitmap.bmp".
If your custom path matches a built-in icon's (like "Icons/ArrowRight.bmp"), your image will be loaded instead of the one from Renoise.

If you want to support high DPI UI scaling with your bitmaps like the built-in Icons, include high resolution versions with their filenames ending with "@4x"
The following rules will be used when loading bitmaps

  • When UI scaling is 100%, only the base bitmaps are used.
  • When UI scaling is 125%, the base bitmaps are used, except if there is a BitmapName@x1.25.bmp variant.
  • For all other UI scaling > 125% the "@4x" variants are used and downscaled as needed, except when there is an exact match for the current UI scaling factor (e.g. BitmapName@1.5x.bmp for 150%)

BitmapMode

"body_color" | "button_color" | "main_color" | "plain" | "transparent"

-- Setup how the bitmap should be drawn, recolored. Available modes are:
BitmapMode:
    | "plain" -- bitmap is drawn as is, no recoloring is done (Default)
    | "transparent" -- same as plain, but black pixels will be fully transparent
    | "button_color" -- recolor the bitmap, using the theme's button color
    | "body_color" -- same as 'button_back' but with body text/back color
    | "main_color" -- same as 'button_back' but with main text/back colors

BitmapPath

BitmapImagePath

Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency).

BooleanValueNotifierFunction

(value : boolean)

BooleanValueNotifierMemberFunction

(self : NotifierMemberContext, value : boolean)

BooleanValueNotifierMethod1

{ 1 : NotifierMemberContext, 2 : BooleanValueNotifierMemberFunction }

BooleanValueNotifierMethod2

{ 1 : BooleanValueNotifierMemberFunction, 2 : NotifierMemberContext }

ButtonBitmapPath

BitmapImagePath

If set, existing text is removed and the loaded image is displayed instead. Supported bitmap file formats are ".bmp", ".png" and ".tiff". Colors in bitmaps will be overridden by the button's theme color, using black as the transparent color for BMPs and TIFFS, and the alpha channel for PNGs. All other colors are mapped to the theme color according to their grey value, so plain white is the target theme color, and all other colors blend into the button's background color of the theme.

ButtonColor

RGBColor

When set, the unpressed button's background will be drawn in the specified color. A text color is automatically selected unless explicitly set, to make sure it's always visible. Set color {0,0,0} to enable the theme colors for the button again.

ButtonLabel

string

The text label of the button

  • Default: ""

ButtonNotifier

NotifierFunction | NotifierMethod1 | NotifierMethod2

A click notifier

CheckBoxBoolean

boolean

The current state of the checkbox, expressed as boolean.

  • Default: false

CheckBoxBooleanNotifier

BooleanValueNotifierFunction | BooleanValueNotifierMethod1 | BooleanValueNotifierMethod2

A notifier for when the checkbox is toggled

ControlActive

boolean

Instead of making a control invisible, you can also make it inactive. Deactivated controls will still be shown, and will still show their currently assigned values, but will not allow changes. Most controls will display as "grayed out" to visualize the deactivated state.

ControlMidiMappingString

string

When set, the control will be highlighted when Renoise's MIDI mapping dialog is open. When clicked, it selects the specified string as a MIDI mapping target action. This target acton can either be one of the globally available mappings in Renoise, or those that were created by the tool itself. Target strings are not verified. When they point to nothing, the mapped MIDI message will do nothing and no error is fired.

IntegerNotifier

IntegerValueNotifierFunction | IntegerValueNotifierMethod1 | IntegerValueNotifierMethod2

Set up a notifier that will be called whenever a new item is picked

IntegerValueNotifierFunction

(value : integer)

IntegerValueNotifierMemberFunction

(self : NotifierMemberContext, value : integer)

IntegerValueNotifierMethod1

{ 1 : NotifierMemberContext, 2 : IntegerValueNotifierMemberFunction }

IntegerValueNotifierMethod2

{ 1 : IntegerValueNotifierMemberFunction, 2 : NotifierMemberContext }

ItemLabels

string[]

A list of buttons labels to show in order. Must have more than one item.

ListElementAdded

{ index : integer, type : "insert" }

ListElementChange

ListElementAdded | ListElementRemoved | ListElementsSwapped

ListElementRemoved

{ index : integer, type : "removed" }

ListElementsSwapped

{ index1 : integer, index2 : integer, type : "swapped" }

ListNotifierFunction

(change : ListElementChange)

ListNotifierMemberContext

table | userdata

NotifierFunction

fun()

NotifierMemberContext

table | userdata

NotifierMemberFunction

(self : NotifierMemberContext)

NotifierMethod1

{ 1 : NotifierMemberContext, 2 : NotifierMemberFunction }

NotifierMethod2

{ 1 : NotifierMemberFunction, 2 : NotifierMemberContext }

NumberValueNotifier

NumberValueNotifierFunction | NumberValueNotifierMethod1 | NumberValueNotifierMethod2

Set up a value notifier that will be called whenever the value changes

NumberValueNotifierFunction

(value : number)

NumberValueNotifierMemberFunction

(self : NotifierMemberContext, value : number)

NumberValueNotifierMethod1

{ 1 : NotifierMemberContext, 2 : NumberValueNotifierMemberFunction }

NumberValueNotifierMethod2

{ 1 : NumberValueNotifierMemberFunction, 2 : NotifierMemberContext }

PairedParseStringAsNumber

(value : string) -> number?

Make sure to also set tostring if you set this.

PairedShowNumberAsString

ShowNumberAsString

Make sure to also set tonumber if you set this.

PopupItemLabels

string[]

A list of buttons labels to show in order The list can be empty, then "None" is displayed and the value won't change.

RGBColor

{ 1 : integer, 2 : integer, 3 : integer }

A table of 3 bytes (ranging from 0 to 255) representing the red, green and blue channels of a color. {0xFF, 0xFF, 0xFF} is white {165, 73, 35} is the red from the Renoise logo

RackMargin

integer

Set the "borders" of a rack (left, right, top and bottom inclusively)

  • Default: 0 (no borders)

RackSpacing

integer

Set the amount stacked child views are separated by (horizontally in rows, vertically in columns).

  • Default: 0 (no spacing)

RackUniformity

boolean

When set to true, all child views in the rack are automatically resized to the max size of all child views (width in ViewBuilder.column, height in ViewBuilder.row). This can be useful to automatically align all sub columns/panels to the same size. Resizing is done automatically, as soon as a child view size changes or new children are added.

  • Default: false

SelectedItem

integer

The currently selected item's index

ShowNumberAsString

(value : number) -> string?

Set a custom rule on how a number value should be displayed. Useful for showing units like decibel or note values etc. If none are set, a default string/number conversion is done, which simply shows the number with 3 digits after the decimal point. Note: When the callback fails with an error, it will be disabled to avoid a flood of error messages.

SliderDefaultValue

number

The default value that will be re-applied on double-click

SliderMaxValue

number

The maximum value that can be set using the view

  • Default: 1.0

SliderMinValue

number

The minimum value that can be set using the view

  • Default: 0

SliderNumberValue

number

The current value of the view

SliderStepAmounts

{ 1 : number, 2 : number }

A table containing two numbers representing the step amounts for incrementing and decrementing by clicking the <> buttons. The first value is the small step (applied on left clicks) second value is the big step (applied on right clicks)

StringChangeNotifier

StringValueNotifierFunction | StringValueNotifierMethod1 | StringValueNotifierMethod2

Set up a notifier for text changes

StringValueNotifierFunction

(value : string)

StringValueNotifierMemberFunction

(self : NotifierMemberContext, value : string)

StringValueNotifierMethod1

{ 1 : NotifierMemberContext, 2 : StringValueNotifierMemberFunction }

StringValueNotifierMethod2

{ 1 : StringValueNotifierMemberFunction, 2 : NotifierMemberContext }

TextActive

boolean

When false, text is displayed but can not be entered/modified by the user.

  • Default: true

TextAlignment

"center" | "left" | "right"

-- Setup the text's alignment. Applies only when the view's size is larger than
-- the needed size to draw the text
TextAlignment:
    | "left" -- (Default)
    | "right" -- aligned to the right
    | "center" -- center text

TextBackgroundStyle

"body" | "border" | "strong"

-- Setup the text view's background:
TextBackgroundStyle:
    | "body" -- simple text color with no background
    | "strong" -- stronger text color with no background
    | "border" -- text on a bordered background

TextEditMode

boolean

True when the text field is focused. setting it at run-time programmatically will focus the text field or remove the focus (focus the dialog) accordingly.

  • Default: false

TextFontStyle

"big" | "bold" | "italic" | "mono" | "normal"

-- The style that the text should be displayed with.
TextFontStyle:
    | "normal" -- (Default)
    | "big" -- big text
    | "bold" -- bold font
    | "italic" -- italic font
    | "mono" -- monospace font

TextMultilineString

string

The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs.

TextParagraphs

string[]

A table of text lines to be used instead of specifying a single text line with newline characters like "text"

  • Default: []

TextSingleLineString

string

The text that should be displayed. Setting a new text will resize the view in order to make the text fully visible (expanding only).

  • Default: ""

TextStyle

"disabled" | "normal" | "strong"

-- Get/set the color style the text should be displayed with.
TextStyle:
    | "normal" -- (Default)
    | "strong" -- highlighted color
    | "disabled" -- greyed out color

TextValue

string

The currently shown text. The text will not be updated when editing, rather only after editing is complete (return is pressed, or focus is lost).

  • Default: ""

TextValueAlias

string

Exactly the same as "value"; provided for consistency.

  • Default: ""

ValueBoxMaxValue

number

The maximum value that can be set using the view

  • Default: 100

ValueBoxMinValue

number

The minimum value that can be set using the view

  • Default: 0

ViewBackgroundStyle

"body" | "border" | "group" | "invisible" | "panel" | "plain"

-- Setup a background style for the view. 
ViewBackgroundStyle:
    | "invisible" -- no background (Default)
    | "plain" -- undecorated, single coloured background
    | "border" -- same as plain, but with a bold nested border
    | "body" -- main "background" style, as used in dialog backgrounds
    | "panel" -- alternative "background" style, beveled
    | "group" -- background for "nested" groups within body

ViewBooleanObservable

renoise.Document.ObservableBoolean

Bind the view's value to a renoise.Document.ObservableBoolean object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

ViewDimension

string | integer

The dimensions of a view has to be larger than 0. For nested views you can also specify relative size for example vb:text { width = "80%"}. The percentage values are relative to the view's parent size and will automatically update on size changes.

ViewId

string

Unique identifier to resolve the view later on in the viewbuilder, e.g. vb.views.SomeString or vb.views["Some String"] View ids must be unique within a single view builder instance.

ViewNumberObservable

renoise.Document.ObservableNumber

Bind the view's value to a renoise.Document.ObservableNumber object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

ViewStringListObservable

renoise.Document.ObservableStringList

Bind the view's value to a renoise.Document.ObservableStringList object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

ViewStringObservable

renoise.Document.ObservableString

Bind the view's value to a renoise.Document.ObservableString object. Automatically keep them in sync. The view will change the Observable value as soon as its value changes and change the view's value as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object.

ViewTooltip

string

A tooltip text that should be shown for this view on mouse hover.

  • Default: "" (no tip will be shown)

ViewVisibility

boolean

Set visible to false to hide a view (make it invisible without removing it). Please note that view.visible will also return false when any of its parents are invisible (when its implicitly invisible).

  • Default: true

XYPadMaxValues

{ x : SliderMaxValue, y : SliderMaxValue }

A table of allowed maximum values for each axis

  • Default: {x: 1.0, y: 1.0}

XYPadMinValues

{ x : SliderMinValue, y : SliderMinValue }

A table of allowed minimum values for each axis

  • Default: {x: 0.0, y: 0.0}

XYPadObservables

{ x : renoise.Document.ObservableNumber, y : renoise.Document.ObservableNumber }

Bind the view's value to a pair of renoise.Document.ObservableNumber objects. Automatically keep both values in sync. Will change the Observables' values as soon as the view's value changes, and change the view's values as soon as the Observable's value changes. Notifiers can be added to either the view or the Observable object. Just like in the other XYPad properties, a table with the fields X and Y is expected here and not a single value. So you have to bind two ObservableNumber object to the pad.

XYPadSnapbackValues

{ x : number, y : number }

A table of snapback values for each axis When snapback is enabled, the pad will revert its values to the specified snapback values as soon as the mouse button is released in the pad. When disabled, releasing the mouse button will not change the value. You can disable snapback at runtime by setting it to nil or an empty table.

XYPadValues

{ x : SliderNumberValue, y : SliderNumberValue }

A table of the XYPad's current values on each axis

XYValueNotifier

XYValueNotifierFunction | XYValueNotifierMethod1 | XYValueNotifierMethod2

Set up a value notifier function that will be used whenever the pad's values change

XYValueNotifierFunction

(value : XYPadValues)

XYValueNotifierMemberFunction

(self : NotifierMemberContext, value : XYPadValues)

XYValueNotifierMethod1

{ 1 : NotifierMemberContext, 2 : XYValueNotifierMemberFunction }

XYValueNotifierMethod2

{ 1 : XYValueNotifierMemberFunction, 2 : NotifierMemberContext }