index :: ui

ui.aview

array view with cursor and selection

available since version: 0.6

---

methods:

• dump dumps all object info to Pd console window.
  

• pos set UI element position
  parameters:

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

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

• select set selection
  parameters:

  • BEGIN selection start in samples
    type: int
    required: True
    

  • END selection end in samples
    type: int
    required: True
    

• update redraws view
  

properties:

• @array Get/set array name
  type: symbol
  

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

• @cursor_samp Get/set cursor position in samples
  type: int
  units: samp
  default: 0
  

• @cursor_phase Get/set cursor position in 0-1 range
  type: float
  range: 0..1
  default: 0
  

• @cursor_sec Get/set cursor position in seconds
  type: float
  units: sec
  default: 0
  

• @cursor_ms Get/set cursor position in milliseconds
  type: float
  units: ms
  default: 0
  

• @select_samp Get/set selection range in samples, pair of values: begin, end
  type: list
  units: samp
  

• @select_sec Get/set selection range in seconds, pair of values: begin, end
  type: list
  units: sec
  

• @select_ms Get/set selection range in milliseconds, pair of values: begin, end
  type: list
  units: ms
  

• @select_phase Get/set selection range noramlized to 0-1 range, pair of values: begin, end
  type: list
  

• @show_rms Get/set show RMS graph
  type: bool
  default: 0
  

• @show_labels Get/set if show corner labels
  type: bool
  default: 0
  

• @label_top Get/set top right label if @show_labels is on
  type: symbol
  

• @label_bottom Get/set bottom right label if @show_labels is on
  type: symbol
  

• @size_samp (readonly) Get array size in samples
  type: int
  units: samp
  min value: 0
  default: 0
  

• @size_sec (readonly) Get array size in seconds
  type: float
  units: sec
  min value: 0
  default: 0
  

• @size_ms (readonly) Get array size in milliseconds
  type: float
  units: ms
  min value: 0
  default: 0
  

• @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: 300 100
  

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

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

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

• @wave_color Get/set wave color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.3 0.3 0.3 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
  

inlets:

• output current cursor positions: @cursor_samp, @cursor_phase, @cursor_ms, @cursor_sec and selection (if selected): @select_samp, @select_phase, @select_ms, @select_sec, @begin, @end
  type: control

outlets:

• output
  type: control

keywords:

ui array view

Authors: Serge Poltavsky

License: GPL3 or later