API Reference
Class
LiveEvent
One update for a live widget, addressed by the widget's name. Every live change travels as a LiveEvent, so updates from any thread can be queued, coalesced, recorded as JSON lines and replayed without reflection.
Inheritance
- Object
- LiveEvent
Usage
Explore 52 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 2
- Method LiveEvent.WithTime
- Method LiveRecordingReader.Read
Accepted by parameters 50
- Method Recording.Export
- Method Recording.ExportPlayerData
- Method ILiveDispatcher.Post
- Method ILiveTarget.Apply
- Method ILiveTarget.Describe
- Method ImmediateDispatcher.Post
- Method LiveRecorder.Write
- Method LiveSession.Post
- Method ReplayMarker.From
- Method ReplayPlayer.Play
- Method ActivityList.Apply
- Method ActivityList.Describe
- Method BarChart.Apply
- Method BarChart.Describe
- Method CellMap.Apply
- Method CellMap.Describe
- Method Dashboard.Apply
- Method Dashboard.Describe
- Method Histogram.Apply
- Method Histogram.Describe
- Method KeyValueList.Apply
- Method KeyValueList.Describe
- Method Lanes.Apply
- Method Lanes.Describe
- Method LineChart.Apply
- Method LineChart.Describe
- Method LiveTable.Apply
- Method LiveTable.Describe
- Method LiveWidget.Apply
- Method LiveWidget.Describe
- Method LogRegion.Apply
- Method LogRegion.Describe
- Method Phases.Apply
- Method Phases.Describe
- Method ProgressBar.Apply
- Method ProgressBar.Describe
- Method Slot.Apply
- Method Slot.Describe
- Method Sparkline.Apply
- Method Sparkline.Describe
- Method Spinner.Apply
- Method Spinner.Describe
- Method StackedBar.Apply
- Method StackedBar.Describe
- Method StatusList.Apply
- Method StatusList.Describe
- Method SummaryBar.Apply
- Method SummaryBar.Describe
- Method WatchView.Apply
- Method WatchView.Describe
Constructors
public LiveEvent(String target, String operation, String? key = null, String? text = null, String? state = null, Double value = 0, Double total = 0, Int64 time = 0, Boolean isMarkup = false) #Creates an event.
Parameters
- target System.String
- The name of the target widget.
- operation System.String
- The operation, defined by the target (for example advance, add, write).
- key System.String? = null
- The item key inside the target (lane, phase, row), when the operation needs one.
- text System.String? = null
- Free text (log line, detail, label).
- state System.String? = null
- A state word (pass, fail, running, info, warn...).
- value System.Double = 0
- A numeric value (increment, sample, current value).
- total System.Double = 0
- A second numeric value (maximum, total, duration).
- time System.Int64 = 0
- Milliseconds since the session started; the session stamps it when 0.
- isMarkup System.Boolean = false
- Whether text is markup (rich text) rather than literal text.
Methods
public override String ToString() #Returns:
StringReturns a string that represents the current object.
Returns
A string that represents the current object.
public LiveEvent WithTime(Int64 time) #Returns:
LiveEventReturns a copy stamped with a time.
Parameters
- time System.Int64
- Milliseconds since the session started.
Returns
The stamped event.
Inherited Methods
Properties
public Boolean IsMarkup { get; } #Whether LiveEvent.Text is markup (rich text, for example from New-ConsoleText) rather than literal text. Targets that show text literally (lane labels and detail, log lines) render it with its styles when set.