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
orvb.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, views = { vb:text { text = "Text1" }, vb:text { text = "Text1" } } }
- Constants
- Properties
- Functions
- column(self, properties :
RackViewProperties
) - row(self, properties :
RackViewProperties
) - horizontal_aligner(self, properties :
AlignerViewProperties
) - vertical_aligner(self, properties :
AlignerViewProperties
) - stack(self, properties :
StackViewProperties``?
) - space(self, properties :
ViewProperties
) - canvas(self, properties :
CanvasViewProperties``?
) - text(self, properties :
TextViewProperties``?
) - multiline_text(self, properties :
MultilineTextViewProperties``?
) - textfield(self, properties :
TextFieldProperties``?
) - multiline_textfield(self, properties :
MultilineTextFieldProperties``?
) - link(self, properties :
TextLinkViewProperties``?
) - bitmap(self, properties :
BitmapViewProperties``?
) - button(self, properties :
ButtonProperties``?
) - checkbox(self, properties :
CheckBoxProperties``?
) - switch(self, properties :
ButtonSwitchProperties``?
) - popup(self, properties :
PopUpMenuProperties``?
) - chooser(self, properties :
ChooserProperties``?
) - valuebox(self, properties :
ValueBoxProperties``?
) - value(self, properties :
ValueViewProperties``?
) - valuefield(self, properties :
ValueFieldProperties``?
) - scrollbar(self, properties :
ScrollBarProperties``?
) - slider(self, properties :
SliderProperties``?
) - minislider(self, properties :
MiniSliderProperties``?
) - rotary(self, properties :
RotaryEncoderProperties``?
) - xypad(self, properties :
XYPadProperties``?
)
- column(self, properties :
- Structs
- AlignerViewProperties
- Properties
- margin :
RackMargin``?
- spacing :
RackSpacing``?
- mode :
AlignerMode``?
- background :
ViewBackgroundStyle``?
- mouse_handler :
MouseHandler``?
- mouse_events :
MouseEventTypes``?
- views :
AlignerChildViews``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- margin :
- Aliases
- AlignerChildViews
- AlignerMode
- MouseEventButton
- MouseEventType
- MouseEventTypes
- MouseEventWheelDirection
- MouseHandler
- MouseHandlerNotifierFunction
- MouseHandlerNotifierMemberFunction
- MouseHandlerNotifierMethod1
- MouseHandlerNotifierMethod2
- NotifierMemberContext
- RackMargin
- RackSpacing
- ViewBackgroundStyle
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- BitmapViewProperties
- Properties
- mode :
BitmapMode``?
- color :
BitmapColor``?
- bitmap :
BitmapPath``?
- notifier :
ButtonNotifier``?
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- mode :
- Aliases
- BitmapColor
- BitmapImagePath
- BitmapMode
- BitmapPath
- ButtonNotifier
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NotifierMemberFunction
- NotifierMethod1
- NotifierMethod2
- RGBColor
- ThemeColor
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ButtonProperties
- Properties
- text :
ButtonLabel``?
- bitmap :
ButtonBitmapPath``?
- align :
ButtonAlignment``?
- font :
TextFontStyle``?
- color :
ButtonColor``?
- secondary_color :
ButtonColor``?
- style :
ButtonStyle``?
- notifier :
ButtonNotifier``?
- pressed :
ButtonNotifier``?
- released :
ButtonNotifier``?
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- text :
- Aliases
- BitmapImagePath
- ButtonAlignment
- ButtonBitmapPath
- ButtonColor
- ButtonLabel
- ButtonNotifier
- ButtonStyle
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NotifierMemberFunction
- NotifierMethod1
- NotifierMethod2
- RGBColor
- TextFontStyle
- ThemeColor
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ButtonSwitchProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SelectedItem``?
- notifier :
IntegerNotifier``?
- items :
ItemLabels``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- IntegerNotifier
- IntegerValueNotifierFunction
- IntegerValueNotifierMemberFunction
- IntegerValueNotifierMethod1
- IntegerValueNotifierMethod2
- ItemLabels
- NotifierFunction
- NotifierMemberContext
- SelectedItem
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- CanvasViewProperties
- Properties
- mode :
CanvasMode``?
- render :
CanvasRenderFunction``?
- mouse_handler :
MouseHandler``?
- mouse_events :
MouseEventTypes``?
- views :
CanvasChildViews``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- mode :
- Aliases
- CanvasChildViews
- CanvasMode
- CanvasRenderFunction
- MouseEventButton
- MouseEventType
- MouseEventTypes
- MouseEventWheelDirection
- MouseHandler
- MouseHandlerNotifierFunction
- MouseHandlerNotifierMemberFunction
- MouseHandlerNotifierMethod1
- MouseHandlerNotifierMethod2
- NotifierMemberContext
- RGBAColor
- RGBColor
- ThemeColor
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- CheckBoxProperties
- Properties
- bind :
ViewBooleanObservable``?
- value :
CheckBoxBoolean``?
- notifier :
CheckBoxBooleanNotifier``?
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- bind :
- Aliases
- BooleanValueNotifierFunction
- BooleanValueNotifierMemberFunction
- BooleanValueNotifierMethod1
- BooleanValueNotifierMethod2
- CheckBoxBoolean
- CheckBoxBooleanNotifier
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- ViewBooleanObservable
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ChooserProperties
- Properties
- bind :
ViewNumberObservable``?
- value :
SelectedItem``?
- notifier :
IntegerNotifier``?
- items :
ItemLabels``?
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- bind :
- Aliases
- ControlActive
- ControlMidiMappingString
- IntegerNotifier
- IntegerValueNotifierFunction
- IntegerValueNotifierMemberFunction
- IntegerValueNotifierMethod1
- IntegerValueNotifierMethod2
- ItemLabels
- NotifierFunction
- NotifierMemberContext
- SelectedItem
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- MiniSliderProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SliderNumberValue``?
- notifier :
NumberValueNotifier``?
- polarity :
SliderPolarity``?
- min :
SliderMinValue``?
- max :
SliderMaxValue``?
- default :
SliderDefaultValue``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- SliderDefaultValue
- SliderMaxValue
- SliderMinValue
- SliderNumberValue
- SliderPolarity
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- MouseEvent
- Properties
- type :
MouseEventType
- button :
MouseEventButton``?
- direction :
MouseEventWheelDirection``?
- position : { x :
number
, y :number
} - modifier_flags : { alt :
boolean
, control :boolean
, meta :boolean
, shift :boolean
} - button_flags : { left :
boolean
, middle :boolean
, right :boolean
} - hover_views : { id :
string
, view :renoise.Views.View
}[]
- type :
- Aliases
- Properties
- MultilineTextFieldProperties
- Properties
- bind :
ViewStringListObservable``?
- active :
TextActive``?
- value :
TextMultilineString``?
- notifier :
StringChangeNotifier``?
- text :
TextValueAlias``?
- paragraphs :
TextParagraphs``?
- font :
TextFontStyle``?
- style :
TextBackgroundStyle``?
- edit_mode :
TextEditMode``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- bind :
- Aliases
- ListElementAdded
- ListElementChange
- ListElementRemoved
- ListElementsSwapped
- ListNotifierFunction
- ListNotifierMemberContext
- NotifierMemberContext
- StringChangeNotifier
- StringValueNotifierFunction
- StringValueNotifierMemberFunction
- StringValueNotifierMethod1
- StringValueNotifierMethod2
- TextActive
- TextBackgroundStyle
- TextEditMode
- TextFontStyle
- TextMultilineString
- TextParagraphs
- TextValueAlias
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewStringListObservable
- ViewTooltip
- ViewVisibility
- Properties
- MultilineTextViewProperties
- Properties
- text :
TextMultilineString``?
- paragraphs :
TextParagraphs``?
- font :
TextFontStyle``?
- style :
TextBackgroundStyle``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- text :
- Aliases
- Properties
- PopUpMenuProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SelectedItem``?
- notifier :
IntegerNotifier``?
- items :
PopupItemLabels``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- IntegerNotifier
- IntegerValueNotifierFunction
- IntegerValueNotifierMemberFunction
- IntegerValueNotifierMethod1
- IntegerValueNotifierMethod2
- NotifierFunction
- NotifierMemberContext
- PopupItemLabels
- SelectedItem
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- RackViewProperties
- Properties
- margin :
RackMargin``?
- spacing :
RackSpacing``?
- background :
ViewBackgroundStyle``?
- uniform :
RackUniformity``?
- mouse_handler :
MouseHandler``?
- mouse_events :
MouseEventTypes``?
- views :
RackChildViews``?
- style :
ViewBackgroundStyle``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- margin :
- Aliases
- MouseEventButton
- MouseEventType
- MouseEventTypes
- MouseEventWheelDirection
- MouseHandler
- MouseHandlerNotifierFunction
- MouseHandlerNotifierMemberFunction
- MouseHandlerNotifierMethod1
- MouseHandlerNotifierMethod2
- NotifierMemberContext
- RackChildViews
- RackMargin
- RackSpacing
- RackUniformity
- ViewBackgroundStyle
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- RotaryEncoderProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SliderNumberValue``?
- notifier :
NumberValueNotifier``?
- polarity :
SliderPolarity``?
- min :
SliderMinValue``?
- max :
SliderMaxValue``?
- default :
SliderDefaultValue``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- SliderDefaultValue
- SliderMaxValue
- SliderMinValue
- SliderNumberValue
- SliderPolarity
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ScrollBarProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
ScrollbarValue``?
- notifier :
NumberValueNotifier``?
- min :
ScrollbarMin``?
- max :
ScrollbarMax``?
- step :
ScrollbarStep``?
- pagestep :
ScrollbarPagestep``?
- background :
ViewBackgroundStyle``?
- autohide :
ScrollbarAutoHide``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- ScrollbarAutoHide
- ScrollbarMax
- ScrollbarMin
- ScrollbarPagestep
- ScrollbarStep
- ScrollbarValue
- ViewBackgroundStyle
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- SliderProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SliderNumberValue``?
- notifier :
NumberValueNotifier``?
- polarity :
SliderPolarity``?
- min :
SliderMinValue``?
- max :
SliderMaxValue``?
- steps :
SliderStepAmounts``?
- default :
SliderDefaultValue``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- SliderDefaultValue
- SliderMaxValue
- SliderMinValue
- SliderNumberValue
- SliderPolarity
- SliderStepAmounts
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- StackViewProperties
- Properties
- autosize :
StackAutoSize``?
- background :
ViewBackgroundStyle``?
- mouse_handler :
MouseHandler``?
- mouse_events :
MouseEventTypes``?
- views :
StackChildViews``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- autosize :
- Aliases
- MouseEventButton
- MouseEventType
- MouseEventTypes
- MouseEventWheelDirection
- MouseHandler
- MouseHandlerNotifierFunction
- MouseHandlerNotifierMemberFunction
- MouseHandlerNotifierMethod1
- MouseHandlerNotifierMethod2
- NotifierMemberContext
- StackAutoSize
- StackChildViews
- ViewBackgroundStyle
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- TextFieldProperties
- Properties
- bind :
ViewStringObservable``?
- active :
TextActive``?
- value :
TextValue``?
- notifier :
StringChangeNotifier``?
- text :
TextValueAlias``?
- align :
TextAlignment``?
- edit_mode :
TextEditMode``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- bind :
- Aliases
- NotifierFunction
- NotifierMemberContext
- StringChangeNotifier
- StringValueNotifierFunction
- StringValueNotifierMemberFunction
- StringValueNotifierMethod1
- StringValueNotifierMethod2
- TextActive
- TextAlignment
- TextEditMode
- TextValue
- TextValueAlias
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewStringObservable
- ViewTooltip
- ViewVisibility
- Properties
- TextLinkViewProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- notifier :
ButtonNotifier``?
- pressed :
ButtonNotifier``?
- released :
ButtonNotifier``?
- text :
TextSingleLineString``?
- font :
TextFontStyle``?
- style :
TextStyle``?
- color :
TextColor``?
- orientation :
TextOrientation``?
- align :
TextAlignment``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ButtonNotifier
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NotifierMemberFunction
- NotifierMethod1
- NotifierMethod2
- RGBColor
- TextAlignment
- TextColor
- TextFontStyle
- TextOrientation
- TextSingleLineString
- TextStyle
- ThemeColor
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- TextViewProperties
- Properties
- text :
TextSingleLineString``?
- font :
TextFontStyle``?
- style :
TextStyle``?
- color :
TextColor``?
- orientation :
TextOrientation``?
- align :
TextAlignment``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- text :
- Aliases
- Properties
- ValueBoxProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SliderNumberValue``?
- notifier :
NumberValueNotifier``?
- min :
ValueBoxMinValue``?
- max :
ValueBoxMaxValue``?
- steps :
SliderStepAmounts``?
- tostring :
PairedShowNumberAsString``?
- tonumber :
PairedParseStringAsNumber``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- PairedParseStringAsNumber
- PairedShowNumberAsString
- ShowNumberAsString
- SliderNumberValue
- SliderStepAmounts
- ValueBoxMaxValue
- ValueBoxMinValue
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ValueFieldProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- bind :
ViewNumberObservable``?
- value :
SliderNumberValue``?
- notifier :
NumberValueNotifier``?
- min :
SliderMinValue``?
- max :
SliderMaxValue``?
- align :
TextAlignment``?
- tostring :
PairedShowNumberAsString``?
- tonumber :
PairedParseStringAsNumber``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- PairedParseStringAsNumber
- PairedShowNumberAsString
- ShowNumberAsString
- SliderMaxValue
- SliderMinValue
- SliderNumberValue
- TextAlignment
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ValueViewProperties
- Properties
- bind :
ViewNumberObservable``?
- value :
SliderNumberValue``?
- notifier :
NumberValueNotifier``?
- align :
TextAlignment``?
- font :
TextFontStyle``?
- tostring :
ShowNumberAsString``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- bind :
- Aliases
- NotifierFunction
- NotifierMemberContext
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- ShowNumberAsString
- SliderNumberValue
- TextAlignment
- TextFontStyle
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- Properties
- ViewProperties
- XYPadProperties
- Properties
- active :
ControlActive``?
- midi_mapping :
ControlMidiMappingString``?
- id :
ViewId``?
- visible :
ViewVisibility``?
- origin :
ViewOrigin``?
- width :
ViewDimension``?
- height :
ViewDimension``?
- size :
ViewSize``?
- tooltip :
ViewTooltip``?
- cursor :
ViewCursorShape``?
- bind :
XYPadObservables``?
- value :
XYPadValues``?
- snapback :
XYPadSnapbackValues``?
- notifier :
XYValueNotifier``?
- min :
XYPadMinValues``?
- max :
XYPadMaxValues``?
- active :
- Aliases
- ControlActive
- ControlMidiMappingString
- NotifierFunction
- NotifierMemberContext
- SliderMaxValue
- SliderMinValue
- SliderNumberValue
- ViewCursorShape
- ViewDimension
- ViewId
- ViewOrigin
- ViewPosition
- ViewSize
- ViewTooltip
- ViewVisibility
- XYPadMaxValues
- XYPadMinValues
- XYPadObservables
- XYPadSnapbackValues
- XYPadValues
- XYValueNotifier
- XYValueNotifierFunction
- XYValueNotifierMemberFunction
- XYValueNotifierMethod1
- XYValueNotifierMethod2
- Aliases
- AlignerChildViews
- AlignerMode
- BitmapColor
- BitmapImagePath
- BitmapMode
- BitmapPath
- BooleanValueNotifierFunction
- BooleanValueNotifierMemberFunction
- BooleanValueNotifierMethod1
- BooleanValueNotifierMethod2
- ButtonAlignment
- ButtonBitmapPath
- ButtonColor
- ButtonLabel
- ButtonNotifier
- ButtonStyle
- CanvasChildViews
- CanvasMode
- CanvasRenderFunction
- CheckBoxBoolean
- CheckBoxBooleanNotifier
- ControlActive
- ControlMidiMappingString
- IntegerNotifier
- IntegerValueNotifierFunction
- IntegerValueNotifierMemberFunction
- IntegerValueNotifierMethod1
- IntegerValueNotifierMethod2
- ItemLabels
- ListElementAdded
- ListElementChange
- ListElementRemoved
- ListElementsSwapped
- ListNotifierFunction
- ListNotifierMemberContext
- MouseEventButton
- MouseEventType
- MouseEventTypes
- MouseEventWheelDirection
- MouseHandler
- MouseHandlerNotifierFunction
- MouseHandlerNotifierMemberFunction
- MouseHandlerNotifierMethod1
- MouseHandlerNotifierMethod2
- NotifierFunction
- NotifierMemberContext
- NotifierMemberFunction
- NotifierMethod1
- NotifierMethod2
- NumberValueNotifier
- NumberValueNotifierFunction
- NumberValueNotifierMemberFunction
- NumberValueNotifierMethod1
- NumberValueNotifierMethod2
- PairedParseStringAsNumber
- PairedShowNumberAsString
- PopupItemLabels
- RGBAColor
- RGBColor
- RackChildViews
- RackMargin
- RackSpacing
- RackUniformity
- ScrollbarAutoHide
- ScrollbarMax
- ScrollbarMin
- ScrollbarPagestep
- ScrollbarStep
- ScrollbarValue
- SelectedItem
- ShowNumberAsString
- SliderDefaultValue
- SliderMaxValue
- SliderMinValue
- SliderNumberValue
- SliderPolarity
- SliderStepAmounts
- StackAutoSize
- StackChildViews
- StringChangeNotifier
- StringValueNotifierFunction
- StringValueNotifierMemberFunction
- StringValueNotifierMethod1
- StringValueNotifierMethod2
- TextActive
- TextAlignment
- TextBackgroundStyle
- TextColor
- TextEditMode
- TextFontStyle
- TextMultilineString
- TextOrientation
- TextParagraphs
- TextSingleLineString
- TextStyle
- TextValue
- TextValueAlias
- ThemeColor
- ValueBoxMaxValue
- ValueBoxMinValue
- ViewBackgroundStyle
- ViewBooleanObservable
- ViewCursorShape
- ViewDimension
- ViewId
- ViewNumberObservable
- ViewOrigin
- ViewPosition
- ViewSize
- ViewStringListObservable
- ViewStringObservable
- ViewTooltip
- ViewVisibility
- XYPadMaxValues
- XYPadMinValues
- XYPadObservables
- XYPadSnapbackValues
- XYPadValues
- XYValueNotifier
- XYValueNotifierFunction
- XYValueNotifierMemberFunction
- XYValueNotifierMethod1
- XYValueNotifierMethod2
- Properties
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, views = { 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, views = { 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", views = { 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", views = { vb:text { text = "Text1" }, vb:text { text = "Text2" } } }
stack(self, properties : StackViewProperties
?
)
You can add nested child views when constructing stacks by including them in the constructor table. Use the view property
origin
to position them in the stack.
--Stack multiple views vb:stack { views = { vb:text { origin = { 10, 10 }, text = "Text1" }, vb:text { origin = { 100, 20 }, text = "Text 2" } } }
See:
renoise.Views.Stack
space(self, properties : ViewProperties
)
You can create an empty space in layouts with a space.
examples:
--Empty space in layouts vb:row { views = { vb:button { text = "Some Button" }, vb:space { -- extra spacing between buttons width = 8 }, vb:button { text = "Another Button" }, } }
canvas(self, properties : CanvasViewProperties
?
)
See:
renoise.Views.Canvas
text(self, properties : TextViewProperties
?
)
See:
renoise.Views.Text
multiline_text(self, properties : MultilineTextViewProperties
?
)
See:
renoise.Views.MultiLineText
textfield(self, properties : TextFieldProperties
?
)
See:
renoise.Views.TextField
multiline_textfield(self, properties : MultilineTextFieldProperties
?
)
->
renoise.Views.MultiLineTextField
See:
renoise.Views.MultiLineTextField
link(self, properties : TextLinkViewProperties
?
)
See:
renoise.Views.TextLink
bitmap(self, properties : BitmapViewProperties
?
)
See:
renoise.Views.Bitmap
button(self, properties : ButtonProperties
?
)
See:
renoise.Views.Button
checkbox(self, properties : CheckBoxProperties
?
)
See:
renoise.Views.CheckBox
switch(self, properties : ButtonSwitchProperties
?
)
See:
renoise.Views.Switch
popup(self, properties : PopUpMenuProperties
?
)
See:
renoise.Views.Popup
chooser(self, properties : ChooserProperties
?
)
See:
renoise.Views.Chooser
valuebox(self, properties : ValueBoxProperties
?
)
See:
renoise.Views.ValueBox
value(self, properties : ValueViewProperties
?
)
See:
renoise.Views.Value
valuefield(self, properties : ValueFieldProperties
?
)
See:
renoise.Views.ValueField
scrollbar(self, properties : ScrollBarProperties
?
)
See:
renoise.Views.ScrollBar
slider(self, properties : SliderProperties
?
)
See:
renoise.Views.Slider
minislider(self, properties : MiniSliderProperties
?
)
See:
renoise.Views.MiniSlider
rotary(self, properties : RotaryEncoderProperties
?
)
See:
renoise.Views.RotaryEncoder
xypad(self, properties : XYPadProperties
?
)
See:
renoise.Views.XYPad
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)
background : ViewBackgroundStyle
?
Setup a background style for the view.
mouse_handler : MouseHandler
?
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
mouse_events : MouseEventTypes
?
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
views : AlignerChildViews
?
The aligner view's initial child views. Views can later on also be added and removed dynamically after construction via
aligner:add_view(child)
andaligner:remove_view(child)
id : ViewId
?
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
AlignerChildViews
The aligner view's initial child views. Views can later on also be added and removed dynamically after construction via
aligner:add_view(child)
andaligner:remove_view(child)
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
MouseEventButton
"left"
| "middle"
| "right"
-- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag".
MouseEventButton:
| "left"
| "right"
| "middle"
MouseEventType
"double"
| "down"
| "drag"
| "enter"
| "exit"
| "move"
| "up"
| "wheel"
-- Event type of a `MouseEvent`.
MouseEventType:
| "enter"
| "exit"
| "move"
| "down"
| "up"
| "double"
| "drag"
| "wheel"
MouseEventTypes
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
MouseEventWheelDirection
"down"
| "left"
| "right"
| "up"
-- Mouse wheel direction in a `MouseEvent` of type "wheel".
MouseEventWheelDirection:
| "up"
| "down"
| "left"
| "right"
MouseHandler
MouseHandlerNotifierFunction
| MouseHandlerNotifierMethod1
| MouseHandlerNotifierMethod2
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
MouseHandlerNotifierFunction
(event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMemberFunction
(self : NotifierMemberContext
, event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMethod1
{ 1 : NotifierMemberContext
, 2 : MouseHandlerNotifierMemberFunction
}
MouseHandlerNotifierMethod2
{ 1 : MouseHandlerNotifierMemberFunction
, 2 : NotifierMemberContext
}
NotifierMemberContext
RackMargin
Set the "borders" of a rack (left, right, top and bottom inclusively)
- Default: 0 (no borders)
RackSpacing
Set the amount stacked child views are separated by (horizontally in rows, vertically in columns).
- Default: 0 (no spacing)
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
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
BitmapViewProperties
Properties
mode : BitmapMode
?
Setup how the bitmap should be drawn, recolored. Available modes are:
color : BitmapColor
?
When set, the bitmap will be drawn in the specified color and
mode
is set tocustom_color
. Setmode
to something else thancustom_color
or thecolor
to{0, 0, 0}
to enable aplain
display mode.
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
BitmapColor
-- When set, the bitmap will be drawn in the specified color and `mode` is set
-- to `custom_color`. Set `mode` to something else than `custom_color` or the
-- `color` to `{0, 0, 0}` to enable a `plain` display mode.
-- 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
-- The application theme's colors
BitmapColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
BitmapImagePath
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"
| "custom_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
| "custom_color" -- Recolor the bitmap using a custom color set by the `color'
BitmapPath
Supported bitmap file formats are *.bmp, *.png or *.tif (no transparency).
ButtonNotifier
NotifierFunction
| NotifierMethod1
| NotifierMethod2
A click notifier
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.
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.
NotifierFunction
fun()
NotifierMemberContext
NotifierMemberFunction
(self : NotifierMemberContext
)
NotifierMethod1
{ 1 : NotifierMemberContext
, 2 : NotifierMemberFunction
}
NotifierMethod2
{ 1 : NotifierMemberFunction
, 2 : NotifierMemberContext
}
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
ThemeColor
"alternate_main_back"
| "alternate_main_font"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_marker_diamond"
| "automation_marker_pair"
| "automation_marker_play"
| "automation_marker_single"
| "automation_point"
| "body_back"
| "body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
| "folder"
| "main_back"
| "main_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "pattern_centerbar_back"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font"
| "pattern_centerbar_font_standby"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_delay"
| "pattern_default_font_dspfx"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_unused"
| "pattern_default_font_volume"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_unused"
| "pattern_highlighted_font_volume"
| "pattern_mute_state"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_selection"
| "pattern_standby_selection"
| "scrollbar"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "slider"
| "standby_selection_back"
| "standby_selection_font"
| "strong_body_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "vumeter_back_clipped"
| "vumeter_back_normal"
| "vumeter_meter"
| "vumeter_meter_high"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_peak"
-- The application theme's colors
ThemeColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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.
align : ButtonAlignment
?
Setup the buttons text's or bitmap's alignment within the button.
font : TextFontStyle
?
The style that the text should be displayed with.
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 its always visible. Set color {0,0,0} to enable the theme colors for the button again.
secondary_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 its always visible. Set color {0,0,0} to enable the theme colors for the button again.
style : ButtonStyle
?
Get/set the style a button should be displayed with.
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
BitmapImagePath
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%)
ButtonAlignment
"center"
| "left"
| "right"
-- Setup the buttons text's or bitmap's alignment within the button.
ButtonAlignment:
| "left" -- aligned to the left
| "right" -- aligned to the right
| "center" -- center (default)
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.
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 its
-- always visible.
-- Set color {0,0,0} to enable the theme colors for the button again.
-- 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
-- The application theme's colors
ButtonColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ButtonLabel
The text label of the button
- Default: ""
ButtonNotifier
NotifierFunction
| NotifierMethod1
| NotifierMethod2
A click notifier
ButtonStyle
"normal"
| "rounded"
| "rounded_bottom"
| "rounded_left"
| "rounded_right"
| "rounded_top"
-- Get/set the style a button should be displayed with.
ButtonStyle:
| "normal" -- (Default)
| "rounded" -- rounded corners on all sides
| "rounded_left" -- rounded left side
| "rounded_right" -- rounded right side
| "rounded_top" -- rounded left side
| "rounded_bottom" -- rounded right side
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.
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.
NotifierFunction
fun()
NotifierMemberContext
NotifierMemberFunction
(self : NotifierMemberContext
)
NotifierMethod1
{ 1 : NotifierMemberContext
, 2 : NotifierMemberFunction
}
NotifierMethod2
{ 1 : NotifierMemberFunction
, 2 : NotifierMemberContext
}
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
TextFontStyle
"big"
| "bold"
| "code"
| "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
| "code" -- monospace code font
ThemeColor
"alternate_main_back"
| "alternate_main_font"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_marker_diamond"
| "automation_marker_pair"
| "automation_marker_play"
| "automation_marker_single"
| "automation_point"
| "body_back"
| "body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
| "folder"
| "main_back"
| "main_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "pattern_centerbar_back"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font"
| "pattern_centerbar_font_standby"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_delay"
| "pattern_default_font_dspfx"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_unused"
| "pattern_default_font_volume"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_unused"
| "pattern_highlighted_font_volume"
| "pattern_mute_state"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_selection"
| "pattern_standby_selection"
| "scrollbar"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "slider"
| "standby_selection_back"
| "standby_selection_font"
| "strong_body_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "vumeter_back_clipped"
| "vumeter_back_normal"
| "vumeter_meter"
| "vumeter_meter_high"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_peak"
-- The application theme's colors
ThemeColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
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.
NotifierFunction
fun()
NotifierMemberContext
SelectedItem
The currently selected item's index
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
CanvasViewProperties
Properties
mode : CanvasMode
?
How to draw the canvas context to screen: "transparent" draws with alpha from the canvas, "plain" ignores alpha values, which usually is a lot faster to draw. Use "plain" to speed up drawing background alike canvas views which cover the entire view area. Default: "transparent"
render : CanvasRenderFunction
?
Rendering callback for a canvas.
To update the canvas, use the canvas view's
update
function. This will will schedule a new drawing as soon as the backend is ready to draw. Always draw a complete image here, as the canvas will be completely empty in each new render call.UI scaling: the canvas context by default is set up, so that the global UI scaling gets applied. So all positions in the canvas context by default use view sizes and not pixels. If you want to draw in a raw pixel resolution reset the canvas transformation via
context.set_transform(1.0, 0.0, 0.0, 1.0, 0.0, 0.0)
To query the actual canvas size in pixels, use the context'ssize
property.
mouse_handler : MouseHandler
?
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
mouse_events : MouseEventTypes
?
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
views : CanvasChildViews
?
The canvas view's optional child views. Views can later on also be added and removed dynamically after construction via
stack:add_view(child)
andstack:remove_view(child)
id : ViewId
?
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
CanvasChildViews
The canvas view's optional child views. Views can later on also be added and removed dynamically after construction via
stack:add_view(child)
andstack:remove_view(child)
CanvasMode
"plain"
| "transparent"
-- How to draw the canvas context to screen: "transparent" draws with alpha from
-- the canvas, "plain" ignores alpha values, which usually is a lot faster to draw.
-- Use "plain" to speed up drawing background alike canvas views which cover the
-- entire view area. Default: "transparent"
CanvasMode:
| "plain"
| "transparent"
CanvasRenderFunction
(context : renoise.Views.Canvas.Context
)
Rendering callback for a canvas.
To update the canvas, use the canvas view's
update
function. This will will schedule a new drawing as soon as the backend is ready to draw. Always draw a complete image here, as the canvas will be completely empty in each new render call.UI scaling: the canvas context by default is set up, so that the global UI scaling gets applied. So all positions in the canvas context by default use view sizes and not pixels. If you want to draw in a raw pixel resolution reset the canvas transformation via
context.set_transform(1.0, 0.0, 0.0, 1.0, 0.0, 0.0)
To query the actual canvas size in pixels, use the context'ssize
property.
MouseEventButton
"left"
| "middle"
| "right"
-- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag".
MouseEventButton:
| "left"
| "right"
| "middle"
MouseEventType
"double"
| "down"
| "drag"
| "enter"
| "exit"
| "move"
| "up"
| "wheel"
-- Event type of a `MouseEvent`.
MouseEventType:
| "enter"
| "exit"
| "move"
| "down"
| "up"
| "double"
| "drag"
| "wheel"
MouseEventTypes
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
MouseEventWheelDirection
"down"
| "left"
| "right"
| "up"
-- Mouse wheel direction in a `MouseEvent` of type "wheel".
MouseEventWheelDirection:
| "up"
| "down"
| "left"
| "right"
MouseHandler
MouseHandlerNotifierFunction
| MouseHandlerNotifierMethod1
| MouseHandlerNotifierMethod2
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
MouseHandlerNotifierFunction
(event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMemberFunction
(self : NotifierMemberContext
, event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMethod1
{ 1 : NotifierMemberContext
, 2 : MouseHandlerNotifierMemberFunction
}
MouseHandlerNotifierMethod2
{ 1 : MouseHandlerNotifierMemberFunction
, 2 : NotifierMemberContext
}
NotifierMemberContext
RGBAColor
{ 1 : integer
, 2 : integer
, 3 : integer
, 4 : integer
}
A table of 4 bytes (ranging from 0 to 255) representing the red, green, blue, alpha channels of a color. {0xFF, 0xFF, 0xFF, 0xFF} is white {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque.
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
ThemeColor
"alternate_main_back"
| "alternate_main_font"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_marker_diamond"
| "automation_marker_pair"
| "automation_marker_play"
| "automation_marker_single"
| "automation_point"
| "body_back"
| "body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
| "folder"
| "main_back"
| "main_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "pattern_centerbar_back"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font"
| "pattern_centerbar_font_standby"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_delay"
| "pattern_default_font_dspfx"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_unused"
| "pattern_default_font_volume"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_unused"
| "pattern_highlighted_font_volume"
| "pattern_mute_state"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_selection"
| "pattern_standby_selection"
| "scrollbar"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "slider"
| "standby_selection_back"
| "standby_selection_font"
| "strong_body_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "vumeter_back_clipped"
| "vumeter_back_normal"
| "vumeter_meter"
| "vumeter_meter_high"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_peak"
-- The application theme's colors
ThemeColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
BooleanValueNotifierFunction
(value : boolean
)
BooleanValueNotifierMemberFunction
(self : NotifierMemberContext
, value : boolean
)
BooleanValueNotifierMethod1
{ 1 : NotifierMemberContext
, 2 : BooleanValueNotifierMemberFunction
}
BooleanValueNotifierMethod2
{ 1 : BooleanValueNotifierMemberFunction
, 2 : NotifierMemberContext
}
CheckBoxBoolean
The current state of the checkbox, expressed as boolean.
- Default: false
CheckBoxBooleanNotifier
BooleanValueNotifierFunction
| BooleanValueNotifierMethod1
| BooleanValueNotifierMethod2
A notifier for when the checkbox is toggled
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.
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.
NotifierFunction
fun()
NotifierMemberContext
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.
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
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.
NotifierFunction
fun()
NotifierMemberContext
SelectedItem
The currently selected item's index
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
polarity : SliderPolarity
?
Value polarity of the control. Bipolar controls show the value from the center to left and right or up and down and typically controls a range around zero, e.g. -1 to 1. Unipolar controls show the value from left to right or bottom to top.
- Default: "unipolar"
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
NotifierFunction
fun()
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
}
SliderDefaultValue
The default value that will be re-applied on double-click
SliderMaxValue
The maximum value that can be set using the view
- Default: 1.0
SliderMinValue
The minimum value that can be set using the view
- Default: 0
SliderNumberValue
The current value of the view
SliderPolarity
"bipolar"
| "unipolar"
-- Value polarity of the control. Bipolar controls show the value from the
-- center to left and right or up and down and typically controls a range
-- around zero, e.g. -1 to 1. Unipolar controls show the value from left to
-- right or bottom to top.
-- * Default: "unipolar"
SliderPolarity:
| "unipolar"
| "bipolar"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
MouseEvent
Mouse event as passed to a layout view's "mouse_handler" function.
Properties
type : MouseEventType
Mouse event type. Only enabled types are passed to the handler.
button : MouseEventButton
?
For "up"|"down"|"double"|"drag" events, the mouse button which got pressed, nil for all other events.
direction : MouseEventWheelDirection
?
For "wheel" events, the wheel's direction, nil for all other events.
position : { x : number
, y : number
}
Mouse cursor position in relative coordinates to the layout.
modifier_flags : { alt : boolean
, control : boolean
, meta : boolean
, shift : boolean
}
Currently pressed (held down) keyboard modifier buttons.
button_flags : { left : boolean
, middle : boolean
, right : boolean
}
Currently pressed (held down) mouse buttons.
hover_views : { id : string
, view : renoise.Views.View
}[]
List of sub views and possible layout subview's subviews, that are located below the mouse cursor. In other words: all views that are located below the mouse cursor. The list is orderd by containing the top-most visible view first, so you usually will need to check the first table entry only.
NB: Only views that got created with the same view builder instance as the layout, and only subviews with valid viewbuilder "id"s will show up here!
Aliases
MouseEventButton
"left"
| "middle"
| "right"
-- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag".
MouseEventButton:
| "left"
| "right"
| "middle"
MouseEventType
"double"
| "down"
| "drag"
| "enter"
| "exit"
| "move"
| "up"
| "wheel"
-- Event type of a `MouseEvent`.
MouseEventType:
| "enter"
| "exit"
| "move"
| "down"
| "up"
| "double"
| "drag"
| "wheel"
MouseEventWheelDirection
"down"
| "left"
| "right"
| "up"
-- Mouse wheel direction in a `MouseEvent` of type "wheel".
MouseEventWheelDirection:
| "up"
| "down"
| "left"
| "right"
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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
NotifierMemberContext
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
When false, text is displayed but can not be entered/modified by the user.
- Default: true
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
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"
| "code"
| "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
| "code" -- monospace code font
TextMultilineString
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: []
TextValueAlias
Exactly the same as "value"; provided for consistency.
- Default: ""
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
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.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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
TextFontStyle
"big"
| "bold"
| "code"
| "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
| "code" -- monospace code font
TextMultilineString
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: []
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
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
}
NotifierFunction
fun()
NotifierMemberContext
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.
SelectedItem
The currently selected item's index
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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)
background : 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
mouse_handler : MouseHandler
?
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
mouse_events : MouseEventTypes
?
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
views : RackChildViews
?
The rack view's initial child views. Views can later on also be added and removed dynamically after construction via
rack:add_view(child)
andrack:remove_view(child)
style : ViewBackgroundStyle
?
Deprecated Use
background
instead.
id : ViewId
?
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
MouseEventButton
"left"
| "middle"
| "right"
-- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag".
MouseEventButton:
| "left"
| "right"
| "middle"
MouseEventType
"double"
| "down"
| "drag"
| "enter"
| "exit"
| "move"
| "up"
| "wheel"
-- Event type of a `MouseEvent`.
MouseEventType:
| "enter"
| "exit"
| "move"
| "down"
| "up"
| "double"
| "drag"
| "wheel"
MouseEventTypes
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
MouseEventWheelDirection
"down"
| "left"
| "right"
| "up"
-- Mouse wheel direction in a `MouseEvent` of type "wheel".
MouseEventWheelDirection:
| "up"
| "down"
| "left"
| "right"
MouseHandler
MouseHandlerNotifierFunction
| MouseHandlerNotifierMethod1
| MouseHandlerNotifierMethod2
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
MouseHandlerNotifierFunction
(event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMemberFunction
(self : NotifierMemberContext
, event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMethod1
{ 1 : NotifierMemberContext
, 2 : MouseHandlerNotifierMemberFunction
}
MouseHandlerNotifierMethod2
{ 1 : MouseHandlerNotifierMemberFunction
, 2 : NotifierMemberContext
}
NotifierMemberContext
RackChildViews
The rack view's initial child views. Views can later on also be added and removed dynamically after construction via
rack:add_view(child)
andrack:remove_view(child)
RackMargin
Set the "borders" of a rack (left, right, top and bottom inclusively)
- Default: 0 (no borders)
RackSpacing
Set the amount stacked child views are separated by (horizontally in rows, vertically in columns).
- Default: 0 (no spacing)
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
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
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
polarity : SliderPolarity
?
Value polarity of the control. Bipolar controls show the value from the center to left and right or up and down and typically controls a range around zero, e.g. -1 to 1. Unipolar controls show the value from left to right or bottom to top.
- Default: "unipolar"
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
NotifierFunction
fun()
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
}
SliderDefaultValue
The default value that will be re-applied on double-click
SliderMaxValue
The maximum value that can be set using the view
- Default: 1.0
SliderMinValue
The minimum value that can be set using the view
- Default: 0
SliderNumberValue
The current value of the view
SliderPolarity
"bipolar"
| "unipolar"
-- Value polarity of the control. Bipolar controls show the value from the
-- center to left and right or up and down and typically controls a range
-- around zero, e.g. -1 to 1. Unipolar controls show the value from left to
-- right or bottom to top.
-- * Default: "unipolar"
SliderPolarity:
| "unipolar"
| "bipolar"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
ScrollBarProperties
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 : ScrollbarValue
?
Default 0. Offset value in range
min to max - pagestep
.
notifier : NumberValueNotifier
?
Set up a value notifier that will be called whenever the value changes
min : ScrollbarMin
?
Default 0. Minimum offset value.
max : ScrollbarMax
?
Default 100. Maximum offset value.
step : ScrollbarStep
?
Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar move the scrollable area.
pagestep : ScrollbarPagestep
?
Default 100. Size of the currently visible area.
background : ViewBackgroundStyle
?
Setup a background style for the view.
autohide : ScrollbarAutoHide
?
Default: false. When true, view gets automatically hidden when no scrolling is needed
id : ViewId
?
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
NotifierFunction
fun()
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
}
ScrollbarAutoHide
Default: false. When true, view gets automatically hidden when no scrolling is needed
ScrollbarMax
Default 100. Maximum offset value.
ScrollbarMin
Default 0. Minimum offset value.
ScrollbarPagestep
Default 100. Size of the currently visible area.
ScrollbarStep
Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar move the scrollable area.
ScrollbarValue
Default 0. Offset value in range
min to max - pagestep
.
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
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
polarity : SliderPolarity
?
Value polarity of the control. Bipolar controls show the value from the center to left and right or up and down and typically controls a range around zero, e.g. -1 to 1. Unipolar controls show the value from left to right or bottom to top.
- Default: "unipolar"
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
NotifierFunction
fun()
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
}
SliderDefaultValue
The default value that will be re-applied on double-click
SliderMaxValue
The maximum value that can be set using the view
- Default: 1.0
SliderMinValue
The minimum value that can be set using the view
- Default: 0
SliderNumberValue
The current value of the view
SliderPolarity
"bipolar"
| "unipolar"
-- Value polarity of the control. Bipolar controls show the value from the
-- center to left and right or up and down and typically controls a range
-- around zero, e.g. -1 to 1. Unipolar controls show the value from left to
-- right or bottom to top.
-- * Default: "unipolar"
SliderPolarity:
| "unipolar"
| "bipolar"
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)
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
StackViewProperties
Properties
autosize : StackAutoSize
?
When set to true, the width and height of the stack will be automatically calculated and updated from the stack's child views, to ensure all views fit into the stack. When disabled, the width and height must be set manually.
- Default: true
background : ViewBackgroundStyle
?
Setup a background style for the view.
mouse_handler : MouseHandler
?
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
mouse_events : MouseEventTypes
?
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
views : StackChildViews
?
The stack view's optional child views. Views can later on also be added and removed dynamically after construction via
stack:add_view(child)
andstack:remove_view(child)
id : ViewId
?
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
MouseEventButton
"left"
| "middle"
| "right"
-- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag".
MouseEventButton:
| "left"
| "right"
| "middle"
MouseEventType
"double"
| "down"
| "drag"
| "enter"
| "exit"
| "move"
| "up"
| "wheel"
-- Event type of a `MouseEvent`.
MouseEventType:
| "enter"
| "exit"
| "move"
| "down"
| "up"
| "double"
| "drag"
| "wheel"
MouseEventTypes
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
MouseEventWheelDirection
"down"
| "left"
| "right"
| "up"
-- Mouse wheel direction in a `MouseEvent` of type "wheel".
MouseEventWheelDirection:
| "up"
| "down"
| "left"
| "right"
MouseHandler
MouseHandlerNotifierFunction
| MouseHandlerNotifierMethod1
| MouseHandlerNotifierMethod2
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
MouseHandlerNotifierFunction
(event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMemberFunction
(self : NotifierMemberContext
, event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMethod1
{ 1 : NotifierMemberContext
, 2 : MouseHandlerNotifierMemberFunction
}
MouseHandlerNotifierMethod2
{ 1 : MouseHandlerNotifierMemberFunction
, 2 : NotifierMemberContext
}
NotifierMemberContext
StackAutoSize
When set to true, the width and height of the stack will be automatically calculated and updated from the stack's child views, to ensure all views fit into the stack. When disabled, the width and height must be set manually.
- Default: true
StackChildViews
The stack view's optional child views. Views can later on also be added and removed dynamically after construction via
stack:add_view(child)
andstack:remove_view(child)
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
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
NotifierFunction
fun()
NotifierMemberContext
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
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
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
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: ""
TextValueAlias
Exactly the same as "value"; provided for consistency.
- Default: ""
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
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
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
TextLinkViewProperties
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.
notifier : ButtonNotifier
?
A click notifier
pressed : ButtonNotifier
?
A click notifier
released : ButtonNotifier
?
A click notifier
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.
color : TextColor
?
When set, the text will be drawn in the specified color. Set style to something else than "custom" or color to
{0, 0, 0}
to enable the default theme color for the text again.
orientation : TextOrientation
?
Setup the texts's orientation (writing direction).
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
ButtonNotifier
NotifierFunction
| NotifierMethod1
| NotifierMethod2
A click notifier
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.
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.
NotifierFunction
fun()
NotifierMemberContext
NotifierMemberFunction
(self : NotifierMemberContext
)
NotifierMethod1
{ 1 : NotifierMemberContext
, 2 : NotifierMemberFunction
}
NotifierMethod2
{ 1 : NotifierMemberFunction
, 2 : NotifierMemberContext
}
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
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
TextColor
-- When set, the text will be drawn in the specified color.
-- Set style to something else than "custom" or color to `{0, 0, 0}`
-- to enable the default theme color for the text again.
-- 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
-- The application theme's colors
TextColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
TextFontStyle
"big"
| "bold"
| "code"
| "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
| "code" -- monospace code font
TextOrientation
"horizontal"
| "horizontal-rl"
| "vertical"
| "vertical-tb"
-- Setup the texts's orientation (writing direction).
TextOrientation:
| "horizontal" -- Draw from left to right (Default)
| "horizontal-rl" -- Draw from right to left
| "vertical" -- Draw from bottom to top
| "vertical-tb" -- Draw from top to bottom
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: ""
TextStyle
"custom"
| "disabled"
| "normal"
| "strong"
-- Get/set the color style the text should be displayed with.
TextStyle:
| "normal" -- (Default)
| "strong" -- highlighted color
| "disabled" -- greyed out color
| "custom" -- custom color
ThemeColor
"alternate_main_back"
| "alternate_main_font"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_marker_diamond"
| "automation_marker_pair"
| "automation_marker_play"
| "automation_marker_single"
| "automation_point"
| "body_back"
| "body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
| "folder"
| "main_back"
| "main_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "pattern_centerbar_back"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font"
| "pattern_centerbar_font_standby"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_delay"
| "pattern_default_font_dspfx"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_unused"
| "pattern_default_font_volume"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_unused"
| "pattern_highlighted_font_volume"
| "pattern_mute_state"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_selection"
| "pattern_standby_selection"
| "scrollbar"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "slider"
| "standby_selection_back"
| "standby_selection_font"
| "strong_body_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "vumeter_back_clipped"
| "vumeter_back_normal"
| "vumeter_meter"
| "vumeter_meter_high"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_peak"
-- The application theme's colors
ThemeColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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.
color : TextColor
?
When set, the text will be drawn in the specified color. Set style to something else than "custom" or color to
{0, 0, 0}
to enable the default theme color for the text again.
orientation : TextOrientation
?
Setup the texts's orientation (writing direction).
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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
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
TextColor
-- When set, the text will be drawn in the specified color.
-- Set style to something else than "custom" or color to `{0, 0, 0}`
-- to enable the default theme color for the text again.
-- 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
-- The application theme's colors
TextColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
TextFontStyle
"big"
| "bold"
| "code"
| "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
| "code" -- monospace code font
TextOrientation
"horizontal"
| "horizontal-rl"
| "vertical"
| "vertical-tb"
-- Setup the texts's orientation (writing direction).
TextOrientation:
| "horizontal" -- Draw from left to right (Default)
| "horizontal-rl" -- Draw from right to left
| "vertical" -- Draw from bottom to top
| "vertical-tb" -- Draw from top to bottom
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: ""
TextStyle
"custom"
| "disabled"
| "normal"
| "strong"
-- Get/set the color style the text should be displayed with.
TextStyle:
| "normal" -- (Default)
| "strong" -- highlighted color
| "disabled" -- greyed out color
| "custom" -- custom color
ThemeColor
"alternate_main_back"
| "alternate_main_font"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_marker_diamond"
| "automation_marker_pair"
| "automation_marker_play"
| "automation_marker_single"
| "automation_point"
| "body_back"
| "body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
| "folder"
| "main_back"
| "main_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "pattern_centerbar_back"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font"
| "pattern_centerbar_font_standby"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_delay"
| "pattern_default_font_dspfx"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_unused"
| "pattern_default_font_volume"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_unused"
| "pattern_highlighted_font_volume"
| "pattern_mute_state"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_selection"
| "pattern_standby_selection"
| "scrollbar"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "slider"
| "standby_selection_back"
| "standby_selection_font"
| "strong_body_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "vumeter_back_clipped"
| "vumeter_back_normal"
| "vumeter_meter"
| "vumeter_meter_high"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_peak"
-- The application theme's colors
ThemeColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
NotifierFunction
fun()
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
Make sure to also set
tostring
if you set this.
PairedShowNumberAsString
Make sure to also set
tonumber
if you set this.
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.
SliderNumberValue
The current value of the view
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)
ValueBoxMaxValue
The maximum value that can be set using the view
- Default: 100
ValueBoxMinValue
The minimum value that can be set using the view
- Default: 0
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
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.
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.
NotifierFunction
fun()
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
Make sure to also set
tostring
if you set this.
PairedShowNumberAsString
Make sure to also set
tonumber
if you set this.
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.
SliderMaxValue
The maximum value that can be set using the view
- Default: 1.0
SliderMinValue
The minimum value that can be set using the view
- Default: 0
SliderNumberValue
The current value of the view
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
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
NotifierFunction
fun()
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
}
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.
SliderNumberValue
The current value of the view
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
TextFontStyle
"big"
| "bold"
| "code"
| "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
| "code" -- monospace code font
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
Aliases
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
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
origin : ViewOrigin
?
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
width : ViewDimension
?
Deprecated. Use property
size
instead.
height : ViewDimension
?
Deprecated. Use property
size
instead.
size : ViewSize
?
The dimensions of a view has to be larger than 0. For nested views you can also specify relative size, for example
vb:text { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
tooltip : ViewTooltip
?
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
cursor : ViewCursorShape
?
The cursor cursor for this view which apears on mouse hover. Using a "none" shape will use use underlying view's cursor or the default cursor.
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}
Aliases
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.
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.
NotifierFunction
fun()
NotifierMemberContext
SliderMaxValue
The maximum value that can be set using the view
- Default: 1.0
SliderMinValue
The minimum value that can be set using the view
- Default: 0
SliderNumberValue
The current value of the view
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.views["Some String"]
View ids must be unique within a single view builder instance.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
ViewTooltip
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
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
}
Aliases
AlignerChildViews
The aligner view's initial child views. Views can later on also be added and removed dynamically after construction via
aligner:add_view(child)
andaligner:remove_view(child)
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
BitmapColor
-- When set, the bitmap will be drawn in the specified color and `mode` is set
-- to `custom_color`. Set `mode` to something else than `custom_color` or the
-- `color` to `{0, 0, 0}` to enable a `plain` display mode.
-- 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
-- The application theme's colors
BitmapColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
BitmapImagePath
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"
| "custom_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
| "custom_color" -- Recolor the bitmap using a custom color set by the `color'
BitmapPath
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
}
ButtonAlignment
"center"
| "left"
| "right"
-- Setup the buttons text's or bitmap's alignment within the button.
ButtonAlignment:
| "left" -- aligned to the left
| "right" -- aligned to the right
| "center" -- center (default)
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.
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 its
-- always visible.
-- Set color {0,0,0} to enable the theme colors for the button again.
-- 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
-- The application theme's colors
ButtonColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ButtonLabel
The text label of the button
- Default: ""
ButtonNotifier
NotifierFunction
| NotifierMethod1
| NotifierMethod2
A click notifier
ButtonStyle
"normal"
| "rounded"
| "rounded_bottom"
| "rounded_left"
| "rounded_right"
| "rounded_top"
-- Get/set the style a button should be displayed with.
ButtonStyle:
| "normal" -- (Default)
| "rounded" -- rounded corners on all sides
| "rounded_left" -- rounded left side
| "rounded_right" -- rounded right side
| "rounded_top" -- rounded left side
| "rounded_bottom" -- rounded right side
CanvasChildViews
The canvas view's optional child views. Views can later on also be added and removed dynamically after construction via
stack:add_view(child)
andstack:remove_view(child)
CanvasMode
"plain"
| "transparent"
-- How to draw the canvas context to screen: "transparent" draws with alpha from
-- the canvas, "plain" ignores alpha values, which usually is a lot faster to draw.
-- Use "plain" to speed up drawing background alike canvas views which cover the
-- entire view area. Default: "transparent"
CanvasMode:
| "plain"
| "transparent"
CanvasRenderFunction
(context : renoise.Views.Canvas.Context
)
Rendering callback for a canvas.
To update the canvas, use the canvas view's
update
function. This will will schedule a new drawing as soon as the backend is ready to draw. Always draw a complete image here, as the canvas will be completely empty in each new render call.UI scaling: the canvas context by default is set up, so that the global UI scaling gets applied. So all positions in the canvas context by default use view sizes and not pixels. If you want to draw in a raw pixel resolution reset the canvas transformation via
context.set_transform(1.0, 0.0, 0.0, 1.0, 0.0, 0.0)
To query the actual canvas size in pixels, use the context'ssize
property.
CheckBoxBoolean
The current state of the checkbox, expressed as boolean.
- Default: false
CheckBoxBooleanNotifier
BooleanValueNotifierFunction
| BooleanValueNotifierMethod1
| BooleanValueNotifierMethod2
A notifier for when the checkbox is toggled
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.
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.
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
MouseEventButton
"left"
| "middle"
| "right"
-- Mouse button of a `MouseEvent` of type "up"|"down"|"double"|"drag".
MouseEventButton:
| "left"
| "right"
| "middle"
MouseEventType
"double"
| "down"
| "drag"
| "enter"
| "exit"
| "move"
| "up"
| "wheel"
-- Event type of a `MouseEvent`.
MouseEventType:
| "enter"
| "exit"
| "move"
| "down"
| "up"
| "double"
| "drag"
| "wheel"
MouseEventTypes
The mouse event types that should be passed to your
mouse_handler
function. By default:{ "down", "up", "double" }
Avoid adding event types that you don't use, especially "move" events as they do create quite some overhead. Also note that when enabling "drag", sub view controls can no longer handle drag events, even when you pass back the event in the handler, so only enable it when you want to completely override mouse drag behavior of all your content views.
MouseEventWheelDirection
"down"
| "left"
| "right"
| "up"
-- Mouse wheel direction in a `MouseEvent` of type "wheel".
MouseEventWheelDirection:
| "up"
| "down"
| "left"
| "right"
MouseHandler
MouseHandlerNotifierFunction
| MouseHandlerNotifierMethod1
| MouseHandlerNotifierMethod2
Optional mouse event handler for a view. return nil when the event got handled to stop propagating the event. return the event instance, as passed, to pass it to the next view in the view hirarchy.
MouseHandlerNotifierFunction
(event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMemberFunction
(self : NotifierMemberContext
, event : MouseEvent
) ->
MouseEvent
?
MouseHandlerNotifierMethod1
{ 1 : NotifierMemberContext
, 2 : MouseHandlerNotifierMemberFunction
}
MouseHandlerNotifierMethod2
{ 1 : MouseHandlerNotifierMemberFunction
, 2 : NotifierMemberContext
}
NotifierFunction
fun()
NotifierMemberContext
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
Make sure to also set
tostring
if you set this.
PairedShowNumberAsString
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.
RGBAColor
{ 1 : integer
, 2 : integer
, 3 : integer
, 4 : integer
}
A table of 4 bytes (ranging from 0 to 255) representing the red, green, blue, alpha channels of a color. {0xFF, 0xFF, 0xFF, 0xFF} is white {165, 73, 35, 0x80} is the red from the Renoise logo, half opaque.
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
RackChildViews
The rack view's initial child views. Views can later on also be added and removed dynamically after construction via
rack:add_view(child)
andrack:remove_view(child)
RackMargin
Set the "borders" of a rack (left, right, top and bottom inclusively)
- Default: 0 (no borders)
RackSpacing
Set the amount stacked child views are separated by (horizontally in rows, vertically in columns).
- Default: 0 (no spacing)
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
ScrollbarAutoHide
Default: false. When true, view gets automatically hidden when no scrolling is needed
ScrollbarMax
Default 100. Maximum offset value.
ScrollbarMin
Default 0. Minimum offset value.
ScrollbarPagestep
Default 100. Size of the currently visible area.
ScrollbarStep
Default 1. Amount the mouse-wheel or additional +/- buttons in the scroll bar move the scrollable area.
ScrollbarValue
Default 0. Offset value in range
min to max - pagestep
.
SelectedItem
The currently selected item's index
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.
SliderDefaultValue
The default value that will be re-applied on double-click
SliderMaxValue
The maximum value that can be set using the view
- Default: 1.0
SliderMinValue
The minimum value that can be set using the view
- Default: 0
SliderNumberValue
The current value of the view
SliderPolarity
"bipolar"
| "unipolar"
-- Value polarity of the control. Bipolar controls show the value from the
-- center to left and right or up and down and typically controls a range
-- around zero, e.g. -1 to 1. Unipolar controls show the value from left to
-- right or bottom to top.
-- * Default: "unipolar"
SliderPolarity:
| "unipolar"
| "bipolar"
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)
StackAutoSize
When set to true, the width and height of the stack will be automatically calculated and updated from the stack's child views, to ensure all views fit into the stack. When disabled, the width and height must be set manually.
- Default: true
StackChildViews
The stack view's optional child views. Views can later on also be added and removed dynamically after construction via
stack:add_view(child)
andstack:remove_view(child)
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
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
TextColor
-- When set, the text will be drawn in the specified color.
-- Set style to something else than "custom" or color to `{0, 0, 0}`
-- to enable the default theme color for the text again.
-- 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
-- The application theme's colors
TextColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
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
TextFontStyle
"big"
| "bold"
| "code"
| "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
| "code" -- monospace code font
TextMultilineString
The text that should be displayed. Newlines (Windows, Mac or Unix styled) in the text can be used to create paragraphs.
TextOrientation
"horizontal"
| "horizontal-rl"
| "vertical"
| "vertical-tb"
-- Setup the texts's orientation (writing direction).
TextOrientation:
| "horizontal" -- Draw from left to right (Default)
| "horizontal-rl" -- Draw from right to left
| "vertical" -- Draw from bottom to top
| "vertical-tb" -- Draw from top to bottom
TextParagraphs
string
[]
A table of text lines to be used instead of specifying a single text line with newline characters like "text"
- Default: []
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: ""
TextStyle
"custom"
| "disabled"
| "normal"
| "strong"
-- Get/set the color style the text should be displayed with.
TextStyle:
| "normal" -- (Default)
| "strong" -- highlighted color
| "disabled" -- greyed out color
| "custom" -- custom color
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: ""
TextValueAlias
Exactly the same as "value"; provided for consistency.
- Default: ""
ThemeColor
"alternate_main_back"
| "alternate_main_font"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_marker_diamond"
| "automation_marker_pair"
| "automation_marker_play"
| "automation_marker_single"
| "automation_point"
| "body_back"
| "body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
| "folder"
| "main_back"
| "main_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "pattern_centerbar_back"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font"
| "pattern_centerbar_font_standby"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_delay"
| "pattern_default_font_dspfx"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_unused"
| "pattern_default_font_volume"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_unused"
| "pattern_highlighted_font_volume"
| "pattern_mute_state"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_selection"
| "pattern_standby_selection"
| "scrollbar"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "slider"
| "standby_selection_back"
| "standby_selection_font"
| "strong_body_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "vumeter_back_clipped"
| "vumeter_back_normal"
| "vumeter_meter"
| "vumeter_meter_high"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_peak"
-- The application theme's colors
ThemeColor:
| "main_back"
| "main_font"
| "alternate_main_back"
| "alternate_main_font"
| "body_back"
| "body_font"
| "strong_body_font"
| "button_back"
| "button_font"
| "button_highlight_font"
| "selected_button_back"
| "selected_button_font"
| "selection_back"
| "selection_font"
| "standby_selection_back"
| "standby_selection_font"
| "midi_mapping_back"
| "midi_mapping_font"
| "tooltip_back"
| "tooltip_font"
| "valuebox_back"
| "valuebox_font"
| "valuebox_font_icons"
| "scrollbar"
| "slider"
| "folder"
| "pattern_default_back"
| "pattern_default_font"
| "pattern_default_font_volume"
| "pattern_default_font_panning"
| "pattern_default_font_pitch"
| "pattern_default_font_delay"
| "pattern_default_font_global"
| "pattern_default_font_other"
| "pattern_default_font_dspfx"
| "pattern_default_font_unused"
| "pattern_highlighted_back"
| "pattern_highlighted_font"
| "pattern_highlighted_font_volume"
| "pattern_highlighted_font_panning"
| "pattern_highlighted_font_pitch"
| "pattern_highlighted_font_delay"
| "pattern_highlighted_font_global"
| "pattern_highlighted_font_other"
| "pattern_highlighted_font_dspfx"
| "pattern_highlighted_font_unused"
| "pattern_playposition_back"
| "pattern_playposition_font"
| "pattern_centerbar_back"
| "pattern_centerbar_font"
| "pattern_centerbar_back_standby"
| "pattern_centerbar_font_standby"
| "pattern_selection"
| "pattern_standby_selection"
| "pattern_mute_state"
| "automation_grid"
| "automation_line_edge"
| "automation_line_fill"
| "automation_point"
| "automation_marker_play"
| "automation_marker_single"
| "automation_marker_pair"
| "automation_marker_diamond"
| "vumeter_meter"
| "vumeter_meter_low"
| "vumeter_meter_middle"
| "vumeter_meter_high"
| "vumeter_peak"
| "vumeter_back_normal"
| "vumeter_back_clipped"
| "default_color_01"
| "default_color_02"
| "default_color_03"
| "default_color_04"
| "default_color_05"
| "default_color_06"
| "default_color_07"
| "default_color_08"
| "default_color_09"
| "default_color_10"
| "default_color_11"
| "default_color_12"
| "default_color_13"
| "default_color_14"
| "default_color_15"
| "default_color_16"
ValueBoxMaxValue
The maximum value that can be set using the view
- Default: 100
ValueBoxMinValue
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.
ViewCursorShape
"busy"
| "change_value"
| "crosshair"
| "default"
| "drag"
| "drop"
| "edit_text"
| "empty"
| "erase"
| "extend_bottom"
| "extend_bottom_alias"
| "extend_left"
| "extend_left_alias"
| "extend_right"
| "extend_right_alias"
| "extend_top"
| "extend_top_alias"
| "marker"
| "move"
| "nodrop"
| "none"
| "pencil"
| "play"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "resize_edge_horizontal"
| "resize_edge_vertical"
| "resize_horizontal"
| "resize_vertical"
| "zoom"
| "zoom_horizontal"
| "zoom_vertical"
-- The cursor cursor for this view which apears on mouse hover.
-- Using a "none" shape will use use underlying view's cursor or the default cursor.
ViewCursorShape:
| "none"
| "empty"
| "default"
| "change_value"
| "edit_text"
| "pencil"
| "marker"
| "crosshair"
| "move"
| "erase"
| "play"
| "drag"
| "drop"
| "nodrop"
| "busy"
| "resize_vertical"
| "resize_horizontal"
| "resize_edge_vertical"
| "resize_edge_horizontal"
| "resize_edge_diagonal_left"
| "resize_edge_diagonal_right"
| "extend_left"
| "extend_right"
| "extend_top"
| "extend_bottom"
| "extend_left_alias"
| "extend_right_alias"
| "extend_top_alias"
| "extend_bottom_alias"
| "zoom_vertical"
| "zoom_horizontal"
| "zoom"
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.
ViewId
Unique identifier to resolve the view later on in the viewbuilder, e.g.
vb.views.SomeString
orvb.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.
ViewOrigin
{ 1 : ViewPosition
, 2 : ViewPosition
} | { x : ViewPosition
, y : ViewPosition
}
The position of a view within its parent view. Only the
stack
layouts allows to freely position child views. Other layout views will automatically set the origin, but the origin then still can be read in for example mouse handlers.
ViewPosition
Horizontal (x) or Vertical (y) position of a view within its parent view.
ViewSize
{ 1 : ViewDimension
, 2 : ViewDimension
} | { height : ViewDimension
, 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 { size = { width = "80%", height = 20}}
. The percentage values are relative to the view's parent size and will automatically update when the parent view's size changes.
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
A ViewTooltip text that should be shown for this view on mouse hover.
- Default: "" (no tip will be shown)
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
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
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
}