KnobDescriptor class

Constructors

KnobDescriptor({required String name, required KnobKind kind, required Object? value, required Object? defaultValue, num? min, num? max, num? step, String? description, List<String> options = const [], PickerStyle style = PickerStyle.dropdown})
const
KnobDescriptor.fromJson(Map<String, Object?> json)
factory

Properties

defaultValue → Object?
What it renders with when nothing has been set — the value written in the demo, which is also what it shows outside the catalog.
final
description → String?
What this knob is for, when the producer said. Shown beside the control.
final
hashCode → int
The hash code for this object.
no setterinherited
isDefault → bool
no setter
kind → KnobKind
final
max → num?
final
min → num?
Bounds for KnobKind.integer and KnobKind.number, when the demo gave any. A knob with both is a slider; a knob with neither is a field.
final
name → String
Unique within an entry, and how a value is addressed.
final
options → List<String>
The labels of a KnobKind.picker, in the order the demo declared them.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
step → num?
The granularity a slider moves in, when the producer declared one. Absent means continuous — a devbar variable declares this, a catalog demo does not.
final
style → PickerStyle
How a KnobKind.picker asked to be drawn. Written to JSON only when it is not the default, so a report from a guest that predates it reads the same as one from a picker that never asked.
final
value → Object?
What the entry is currently being rendered with.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>
toString() → String
A string representation of this object.
inherited
withValue(Object? value) → KnobDescriptor
The same knob showing value, for a panel that wants to draw the value a user is choosing before the guest has confirmed it.

Operators

operator ==(Object other) → bool
The equality operator.
inherited