index :: ui

ui.colorpanel

colorchooser widget

available since version: 0.1

---

methods:

• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

• interp for this object acts as load, no interpolation performed
  

• 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 set widget value with no output
  parameters:

  • COL column index
    type: int
    required: True
    

  • ROW row index
    type: int
    required: True
    

• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    

properties:

• @matrix Get/set matrix size
  type: list
  default: 24 13
  

• @index Get/set color position in panel
  type: list
  

• @reverse Get/set matrix reversed
  type: bool
  default: 0
  

• @saturation Get/set saturation
  type: float
  range: 0..1
  default: 1
  

• @hue Get/set first hue
  type: float
  range: 0..1
  default: 0
  

• @lightness Get/set first lightness
  type: float
  range: 0..1
  default: 1
  

• @pd (readonly) Get pd color value
  type: int
  default: 0
  

• @rgb (readonly) Get RGB value triplet on 0-1 range
  type: list
  

• @hsl (readonly) Get HSL value triplet on 0-1 range
  type: list
  

• @hex (readonly) Get HEX value in format #RRGGBB
  type: symbol
  

• @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: 181 105
  

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

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

• outputs current widget value
  type: control

outlets:

• output values: @pd COLOR, @rgb in range [0-1], @hsl in range [0-1], @hex
  type: control

keywords:

ui color choose

See also: [ui.number]

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later