index :: ui

ui.rslider

aliases: [ui.rsl]

range slider

available since version: 0.1

---

information

By default outputs messages on mouse click, mouse up and dragging To output messages only on specified event use: @mouse_events=1 and [ui.mouse_filter]

methods:

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• interp interplolates between presets
  parameters:
  • IDX preset fraction index
    type: float
    required: True
    
• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

• set sets slider value without output
  parameters:
  • V new value
    type: float
    required: True
    
• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @min Get/set minimum allowed slider value
  type: float
  default: 0
  

• @max Get/set maximum allowed slider value
  type: float
  default: 1
  

• @value Get/set current slider value
  type: list
  

• @low Get/set low (left) selection value
  type: float
  default: 0.4
  

• @high Get/set max (right) selection value
  type: float
  default: 0.6
  

• @range (readonly) Get selected slider value
  type: float
  min value: 0
  default: 0.2
  

• @presetname Get/set preset name for using with [ui.preset]
  type: symbol
  default: (null)
  

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 120 15
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @mouse_events Get/set mouse events output mode. If on outputs @mouse_down, @mouse_up and @mouse_drag events
  type: bool
  default: 0
  

• @knob_color Get/set knob color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0.75 1 1
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.93 0.93 0.93 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @label Get/set label text
  type: symbol
  default: (null)
  

• @label_color Get/set label color in RGB format within 0-1 range, for example: 0.2 0.4 0.1
  type: list
  default: 0 0 0 1
  

• @label_inner Get/set label position (1 - inner, 0 - outer).
  type: bool
  default: 0
  

• @label_align Get/set label horizontal align
  type: symbol
  enum: left, center, right
  default: left
  

• @label_valign Get/set label vertical align
  type: symbol
  enum: top, center, bottom
  default: top
  

• @label_side Get/set label snap side
  type: symbol
  enum: left, top, right, bottom
  default: top
  

• @label_margins Get/set label offset in pixels
  type: list
  default: 0 0
  

inlets:

• outputs current slider state
  type: control

outlets:

• output slider range as pair of values
  type: control

keywords:

ui range slider

See also: [ui.slider] [ui.sliders]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later