renoise.Views.XYPad

A slider like pad which allows for controlling two values at once. By default it freely moves the XY values, but it can also be configured to snap back to a predefined value when releasing the mouse button.

All values, notifiers, current value or min/max properties will act just like a slider or a rotary's properties, but nstead of a single number, a table with the fields {x = xvalue, y = yvalue} is expected, returned.
 +-------+
 |    o  |
 |   +   |
 |       |
 +-------+

Properties
Functions
Aliases

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.

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.

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.

views : `renoise.Views.View`[]

READ-ONLY Empty for all controls, for layout views this contains the layout child views in the order they got added

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}

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.

Functions

add_view(self, child : `renoise.Views.View`)

Add a new child view to this view.

remove_view(self, child : `renoise.Views.View`)

Remove a child view from this view.

swap_views(self, child1 : `renoise.Views.View`, child2 : `renoise.Views.View`)

Swap position of two child views in this view. With a series of swaps views can be moved to any position in the parent.

add_child(self, child : `renoise.Views.View`)

Deprecated. Use add_view instead

remove_child(self, child : `renoise.Views.View`)

Deprecated. Use remove_view instead

swap_childs(self, child1 : `renoise.Views.View`, child2 : `renoise.Views.View`)

Deprecated. Use swap_views instead

add_notifier(self, notifier : `XYValueNotifierFunction`)

Add value change notifier

remove_notifier(self, notifier : `XYValueNotifierFunction`)

Remove value change notifier

Aliases

ControlActive

boolean

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

ControlMidiMappingString

string

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

SliderMaxValue

number

The maximum value that can be set using the view

Default: 1.0

SliderMinValue

number

The minimum value that can be set using the view

Default: 0

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

string | integer

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

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

integer

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

string

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

Default: "" (no tip will be shown)

ViewVisibility

boolean

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

Default: true

XYPadMaxValues

{ x : SliderMaxValue, y : SliderMaxValue }

A table of allowed maximum values for each axis

Default: {x: 1.0, y: 1.0}

XYPadMinValues

{ x : SliderMinValue, y : SliderMinValue }

A table of allowed minimum values for each axis

Default: {x: 0.0, y: 0.0}

XYPadSnapbackValues

{ x : number, y : number }

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