HueRingPicker

A hue ring color picker that lets users select a hue on a circular ring, with an optional alpha slider.

Basic HueRingPicker

Inherits: LayoutControl

Properties

• color(Optional[ColorValue]) –

  The currently selected color.

• color_picker_height(Optional[Number]) –

  Height of the color picker in virtual pixels.

• enable_alpha(bool) –

  Whether to enable alpha (opacity) slider.

• hue_ring_stroke_width(Optional[Number]) –

  Stroke width for the hue ring.

• picker_area_border_radius(Optional[BorderRadiusValue]) –

  Border radius for the picker area.

• portrait_only(bool) –

  Whether to force portrait layout.

Events

• on_color_change(Optional[ControlEventHandler[HueRingPicker]]) –

  Called when the picker color is changed.

Example

Properties

color class-attribute instance-attribute

color: Optional[ColorValue] = None

The currently selected color.

color_picker_height class-attribute instance-attribute

color_picker_height: Optional[Number] = None

Height of the color picker in virtual pixels.

enable_alpha class-attribute instance-attribute

enable_alpha: bool = False

Whether to enable alpha (opacity) slider.

hue_ring_stroke_width class-attribute instance-attribute

hue_ring_stroke_width: Optional[Number] = None

Stroke width for the hue ring.

picker_area_border_radius class-attribute instance-attribute

picker_area_border_radius: Optional[BorderRadiusValue] = (
    None
)

Border radius for the picker area.

portrait_only class-attribute instance-attribute

portrait_only: bool = False

Whether to force portrait layout.

Events

on_color_change class-attribute instance-attribute

on_color_change: Optional[
    ControlEventHandler[HueRingPicker]
] = None

Called when the picker color is changed.

The data property of the event handler argument contains the color value as a hex string.