Panel class
One panel being served. Obtained from Panels.add, never constructed.
Properties
- description → String?
-
final
- descriptor → PanelDescriptor
-
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Unique in the app, and the channel this panel's requests arrive on.
final
-
knobs
→ List<
KnobDescriptor> -
The knobs as they stand right now.
no setter
- label → String
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
action(
PluginAction declaration, PanelActionHandler run) → void - Declares a command that runs inside the app.
-
announce(
) → void - Says the panel's values moved, without the shape having changed.
-
emit(
String feedId, Map< String, Object?> payload, {String? rid, Map<String, Object?> ? details}) → int -
Reports one event on
feedId, and returns the event's id. -
feed(
String feedId, String feedLabel, {String? description, List< FieldDescriptor> fields = const [], String? durationKey}) → void - Declares an append-only feed. Its events go on PanelDescriptor.feedChannel.
-
itemAction(
String feedId, PluginAction declaration, PanelActionHandler run) → void -
Declares a command offered on one event of
feedIdrather than on the panel —explainon the query the user clicked. -
knob(
KnobDescriptor declaration, {required KnobReader read, required KnobWriter write}) → void - Declares a read-write value.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
readState(
String stateId) → FutureOr< Map< String, Object?> > - Produces one declared snapshot.
-
removeKnob(
String name) → void - Stops offering a knob — a devbar variable whose widget unmounted.
-
run(
String actionId, [Map< String, Object?> args = const {}]) → FutureOr<Object?> - Runs one of this panel's commands in process, without a wire.
-
state(
String stateId, String stateLabel, {String? description, List< FieldDescriptor> fields = const [], required PanelStateReader read}) → void - Declares a snapshot the host can ask for.
-
toString(
) → String -
A string representation of this object.
inherited
-
writeKnob(
String name, Object? value) → Future< List< KnobDescriptor> > - Writes one declared knob, and answers with what the app kept — which is not always what was asked for.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited