LabKit MATLAB Workbench

reference

FrameworkApp SDK API

labkit.app.view.Snapshot

Build one immutable complete visible-state snapshot.

Syntax

view = labkit.app.view.Snapshot() view = view.value(target, value) view = view.choices(target, choices) view = view.limits(target, limits) view = view.enabled(target, enabled) view = view.visible(target, visible) view = view.text(target, text) view = view.filePaths(target, paths) view = view.fileItemStatuses(target, statuses) view = view.listSelection(target, selection) view = view.tableCellSelection(target, selection) view = view.tableData(target, data, Name=Value) view = view.renderPlot(target, model, Name=Value) view = view.workspacePage(target, Name=Value) view = view.anchorPath(interaction, points, Name=Value) view = view.pairedAnchors(interaction, pointSets, Name=Value) view = view.pointSlots(interaction, value, Name=Value) view = view.rectangle(interaction, position, Name=Value) view = view.regionSelection(interaction, Name=Value) view = view.interval(interaction, range, Name=Value) view = view.scaleReference(interaction, endpoints, Name=Value) view = view.include(fragment)

Description

View snapshot is a closed immutable operation vocabulary. One value describes the complete current visible state; Definition validates targets, capabilities, renderer references, and completeness before a runtime may reconcile it. Apps do not author patches or generic target/property setters.

Inputs

target
Nonempty Layout target ID.
value
Target value owned by the App state.
choices
Text array or cellstr of legal choices.
limits
Increasing finite two-element numeric row.
enabled
Logical scalar availability.
visible
Logical scalar visibility.
text
Scalar text.
paths
String or cell array of file paths.
statuses
Empty or one reader-facing status per file-list row.
selection
Selection value accepted by the target.
data
App-owned table, numeric array, or cell array.
model
App-owned model passed to the renderer declared by plotArea.

Options

ViewRevision
Nonnegative integer identifying the requested initial viewport. The adapter preserves user zoom while the value is unchanged and accepts renderer limits once when it changes. Default: 0.

Outputs

view
New immutable labkit.app.view.Snapshot snapshot.
fragment
Another Snapshot whose non-duplicate operations should be included in this snapshot.

Errors

labkit:app:contract:InvalidValue
An operation argument is malformed.
labkit:app:contract:DuplicateId
The same operation is supplied twice for one target.

Example

view = labkit.app.view.Snapshot();
view = view.choices("group", ["A", "B"]);
view = view.value("group", "A");
assert(isa(view, "labkit.app.view.Snapshot"))

Source

This page is generated from the MATLAB help text in +labkit/+app/+view/Snapshot.m.