NE.Standard.UI.Graph

Nodes

A canvas of typed nodes the viewer wires together.

NodesComponent · type key graph.canvas.nodes · Graph

new NodesComponent("nodes")

Properties

PropertyTypeDefaultBindingDescription
Own
Catalog
SetCatalog · BindCatalog
UINodeCatalognullone-wayThe node kinds the picker offers and a saved document is read back through.
ShowRunProgress
SetShowRunProgress · BindShowRunProgress
bool?trueone-wayWhether a run's progress is drawn as a line along the canvas's top.
Needs SetRunProgressEffects pushed by the runner, and shows from the first run on; its room along the top stays clear before it, so the corner's chrome and a fit do not move when it appears.
ShowRunPanel
SetShowRunPanel · BindShowRunPanel
bool?falseone-wayWhether the canvas carries Run, Run all and Stop in its top corner.
Run and Run all save under a run's reason (UIGraphArguments.RunReason) for UINodeRuns; Stop raises GraphEvents.RunStop.
NodeCornerRadius
SetNodeCornerRadius · BindNodeCornerRadius
UICornerRadius?nullone-wayThe corners of the canvas's nodes; unset, the theme's card radius, and UICornerRadius.Uniform(0) squares them.
A node's head and its chosen ring follow each corner, as a group's frame does; a reroute, unset, keeps a button's smaller one.
PinChoices
SetPinChoices · BindPinChoices
IReadOnlyDictionary<string, IReadOnlyList<UIChoice>>nullone-wayThe runtime choice lists for inputs carrying GraphInputAttribute.ChoicesKey, keyed by that key.
From GraphCanvasComponentBase
SheetName
SetSheetName · BindSheetName
UIPhrasenullone-wayThe sheet's name in the corner menu panel's header, beside the menu's glyph; unset, the header says the package's word for the menu. translatable
ColorChoices
SetColorChoices
UIGraphColorChoice[]NE.Standard.UI.Graph.UIGraphColorChoice[]—The colours an item's or a group's menu offers, in their order.
Render-time only: the choices are how the menus are built.
EdgeShape
SetEdgeShape · BindEdgeShape
UIGraphEdgeShape?UIGraphEdgeShape.Orthogonalone-wayThe shape every edge is drawn in: stepped unless told otherwise, on every kind of canvas.
GridSize
SetGridSize · BindGridSize
double?32one-wayThe step of the grid behind the canvas, in canvas units.
ShowGrid
SetShowGrid · BindShowGrid
bool?trueone-wayWhether the grid is drawn.
ShowFocusRing
SetShowFocusRing · BindShowFocusRing
bool?falseone-wayWhether the canvas shows a ring when it takes the keyboard.
ShowMenuPanel
SetShowMenuPanel · BindShowMenuPanel
bool?trueone-wayWhether the canvas draws GraphCanvasComponentBase.Menu in a folding panel over its leading corner, for input without a right button.
ShowMinimap
SetShowMinimap · BindShowMinimap
bool?falseone-wayWhether the canvas draws a pressable overview map of the whole sheet in its corner, with the visible part marked. Off by default.
HighlightOnHover
SetHighlightOnHover · BindHighlightOnHover
bool?falseone-wayWhether hovering an item highlights what it connects to, dimming everything else. Off by default here; a layered graph turns it on.
AutoSave
SetAutoSave · BindAutoSave
bool?falseone-wayWhether every edit is saved as it is made, the save event raised with UIGraphArguments.AutoSaveReason.
For a page whose document is the application's at once rather than the viewer's until Ctrl+S. Off by default.
NodeActionBar
SetNodeActionBar
bool?false—Whether a node carries an action bar: the node menu's entries marked InActionBar — pin, rename and delete, and an application's own — as icons in a bar above the node the reader pressed, centred on it, until a press elsewhere or Escape; the rest behind its "…". Off by default.
Render-time only. The bar floats a small gap above the node at its size on screen, under it where the canvas leaves no room above, and stays over the node redrawn as the document changes. A read-only canvas, and one in the middle of a drag, shows none. A long press on a touch screen opens the node's menu with the bar's icons atop it.
NodeActionBarRepeatInMore
SetNodeActionBarRepeatInMore
bool?false—Whether the menu a node bar's "…" opens repeats the entries the bar shows. Off by default: the "…" opens the rest of the node menu (colour, an application's own entries), and a right-click or a long press the whole of it.
Render-time only.
SnapToGrid
SetSnapToGrid · BindSnapToGrid
bool?trueone-wayWhether a moved item's position, and a node's size on the node canvas, snap to the grid step. On by default.
MinZoom
BindMinZoom
double?0.25one-wayHow far the canvas may be zoomed out.
MaxZoom
BindMaxZoom
double?2.5one-wayHow far the canvas may be zoomed in.
CanvasHeight
SetCanvasHeight · BindCanvasHeight
double?32one-wayThe least height the canvas stands at, in rem; a canvas given a height of its own — a fill — grows past it.
From InputComponentBase
Value
SetValue · BindValue
UINodeDocumentnulltwo-wayThe input's current value, boxed to Object; a concrete input also exposes its own typed Value alongside this one.
IsReadOnly
SetIsReadOnly · BindIsReadOnly
bool?falseone-wayWhether the input can be seen but not edited; unlike IVisualComponent.Enabled, a read-only value still submits and stays focusable.
True by a static value or a controller binding, the server refuses a value the input sends and answers it with the value it holds. A guard against a stale or forged page, not the permission itself: who may change the value belongs in the setter.
FormId
SetFormId · BindFormId
stringnullone-wayThe id of the form this input belongs to, used to scope Submit-trigger validation.
Settable through the contract, so a preset can join the fields it holds to its form (UIDialogs.Form).
Validation
SetValidation · BindValidation
UIValidationMessage?nullone-wayA message the controller puts on the field, beside whatever the client rules say; the strongest one shows.
ValidationPresentation
SetValidationPresentation
UIValidationPresentation?UIValidationPresentation.Auto—Where the message goes: a line under the field, or an edge mark with the message in a tooltip.
Decided once at render; UIValidationPresentation.Auto is the line except in a grid cell.
Icon
SetIcon · BindIcon
stringnullone-wayThe icon shown before the title, by name from the registered icon font/set.
IconColor
SetIconColor · BindIconColor
UIThemeColor?Defaultone-wayThe leading icon's colour, defaulting to ITextBaseModel.DefaultIconColor.
IconSize
SetIconSize · BindIconSize
UISize?nullone-wayThe leading icon size; left unset the glyph is as tall as the title beside it.
IconShape
SetIconShape · BindIconShape
UIShape?nullone-wayThe shape a leading icon that is a picture is drawn in — UIShape.Circle for a person's avatar; a glyph keeps its own.
IconFallback
SetIconFallback · BindIconFallback
stringnullone-wayThe glyph a picture icon shows while it has no picture — a round one (ITextBaseModel.IconShape Circle) none given or one that fails, any other one that fails; unset, UIGlyphs.Person on a round one and UIGlyphs.Image on any other.
Title
SetTitle · BindTitle
UIPhrasenullone-wayThe label text drawn as the title; nothing renders when it is unset. translatable
A string (an author's text) or a UIPhrase, as every text of the model contracts is — the description, the tooltip, the badge's title and tooltip, a select entry's value — so a moment can stand in it.
TitleType
SetTitleType · BindTitleType
UITextAppearance?Captionone-wayThe primary text type.
TitleColor
SetTitleColor · BindTitleColor
UIThemeColor?Defaultone-wayThe primary text colour, which also colours the icon unless IconColor is set, and the description when ITextModel.DescriptionColor is set to UIColorStyle.Default.
BadgePlacement
SetBadgePlacement · BindBadgePlacement
UITextBadgePlacement?UITextBadgePlacement.Trailingone-wayWhere badge content is placed.
BadgeVariant
SetBadgeVariant · BindBadgeVariant
UIBadgeVariant?UIBadgeVariant.Infoone-wayThe badge visual variant.
BadgeColor
SetBadgeColor · BindBadgeColor
UIThemeColor?nullone-wayThe badge's own colour, overriding IBadgeModel.BadgeVariant when set — a tag or a category swatch, which the closed variant enum cannot name.
BadgeFill
SetBadgeFill · BindBadgeFill
UIBadgeFill?nullone-wayHow the badge spends its colour; unset, a variant fills and a IBadgeModel.BadgeColor tints. A plain badge ignores it.
BadgeIcon
SetBadgeIcon · BindBadgeIcon
stringnullone-wayThe icon shown beside the badge's title, by name from the registered icon font/set.
BadgeIconColor
SetBadgeIconColor · BindBadgeIconColor
UIThemeColor?Defaultone-wayThe badge icon's colour, defaulting to IBadgeModel.DefaultBadgeIconColor.
BadgeIconSize
SetBadgeIconSize · BindBadgeIconSize
UISize?nullone-wayThe badge icon size. Left unset the glyph is as tall as the badge's title.
BadgeTitle
SetBadgeTitle · BindBadgeTitle
UIPhrasenullone-wayThe short text drawn inside the badge, beside its icon. translatable
BadgeTitleType
SetBadgeTitleType · BindBadgeTitleType
UITextAppearance?Overlineone-wayThe role of the badge's title, defaulting to IBadgeModel.DefaultBadgeTitleType.
BadgeTooltip
SetBadgeTooltip · BindBadgeTooltip
UIPhrasenullone-wayThe tooltip for the badge content. translatable
BadgeTooltipPlacement
SetBadgeTooltipPlacement · BindBadgeTooltipPlacement
UIPopupPlacement?UIPopupPlacement.Topone-wayThe side the badge's own tooltip prefers, placed against the badge rather than against the row.
TooltipPlain
SetTooltipPlain
bool?false—Whether the tooltip is shown as written, its asterisks, brackets and braces as characters, rather than read as inline markup: words the controller holds bound to it — a person's name, a note's status; unset, it is markup.
Render-time only: the first paint and every value pushed later are shown the same way.
Tooltip
SetTooltip · BindTooltip
UIPhrasenullone-wayThe tooltip shown on hover and focus; on an icon button with no title, it also names the control for screen readers. translatable
TooltipPlacement
SetTooltipPlacement · BindTooltipPlacement
UIPopupPlacement?UIPopupPlacement.Topone-wayThe side the tooltip prefers; flips to the opposite side when there is no room for it there.
AccessibleName
SetAccessibleName · BindAccessibleName
UIPhrasenullone-wayThe name a screen reader announces in place of the visible words; unset, the control is named by what it shows. The set is a wrapper's hand (a labelled control is named by its label), an author's own words said at the component. translatable

Events

OnSave(string command)
Runs command on Ctrl+S or the menu's Save, after the document has reached the server.
OnSave(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Runs command on Ctrl+S or the menu's Save, after the document has reached the server.
OnSaveLiteral(string command, params KeyValuePair<string, object>[] arguments)
Runs command on Ctrl+S or the menu's Save with literal argument values, after the document has reached the server, as with every form.
OnMenuEntry(string command, string argumentName = "key")
Runs command when an entry the application put into any of the canvas's menus is clicked; the entry's id is the command's key.
The pick is raised on the entry as its menu's own event, so the server runs it only for an entry that menu holds, enabled and shown. The canvas's own entries are done in the browser and never raise it.
OnMenuEntry(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
The same, naming what the command takes: UIGraphArguments.Entry, UIGraphArguments.TargetKind and UIGraphArguments.Target.
The target is named for an entry of an item's, a group's or an edge's menu.
OnMenuEntryLiteral(string command, params KeyValuePair<string, object>[] arguments)
Runs command when an entry the application put into the canvas's menus is clicked, with literal argument values in place of the entry's key and its target: for a canvas whose menus carry one entry of the application's.
OnNodeClick(string command, string argumentName = "node")
Runs command when an item is clicked; the clicked item's id is the command's key.
OnNodeClick(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Runs command when an item is clicked; the clicked item's id is the command's key.
OnNodeClickLiteral(string command, params KeyValuePair<string, object>[] arguments)
Runs command when an item is clicked, with literal argument values in place of the item's id: for a command that needs no item.
OnImageUpload(string command)
Runs command when a file chosen on a picture pin is uploaded, passing the node, pin, selection and file name (see UIGraphArguments).
The pin shows nothing until the command replies with a SetNodeValueEffect carrying the stored address; storage itself is the application's responsibility.
OnImageUpload(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Runs command when a file chosen on a picture pin is uploaded, passing the node, pin, selection and file name (see UIGraphArguments).
The pin shows nothing until the command replies with a SetNodeValueEffect carrying the stored address; storage itself is the application's responsibility.
OnStop(string command)
Runs command when the run panel's Stop is pressed, a run being on — UINodeRuns.Stop() in it.
OnStop(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Runs command when the run panel's Stop is pressed, a run being on — UINodeRuns.Stop() in it.
OnStopLiteral(string command, params KeyValuePair<string, object>[] arguments)
Runs command when the run panel's Stop is pressed, a run being on, with literal argument values.
OnChange(string command)
Registers a change event command.
OnChange(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a change event command with action arguments.
OnChangeLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a change event command with literal argument values.
OnBlur(string command)
Registers a blur event command.
OnBlur(string command, params KeyValuePair<string, UIActionArgument>[] arguments)
Registers a blur event command with action arguments.
OnBlurLiteral(string command, params KeyValuePair<string, object>[] arguments)
Registers a blur event command with literal argument values.

Methods

AddMenuEntry(MenuItem entry)
Appends an entry to the corner menu, under the built-in commands.
AddMenuEntries(params MenuItem[] entries)
Appends a separator and then the given entries to the corner menu.
AddContextMenuEntries(params MenuItem[] entries)
Appends a separator and then the given entries to the menu the right button opens on the empty surface.
AddNodeMenuEntries(params MenuItem[] entries)
Adds a separator and then the given entries to the menu the right button opens on an item, ahead of the rule over Delete, which stays last; the command hears which item.
AddEdgeMenuEntries(params MenuItem[] entries)
Appends a separator and then the given entries to the menu the right button opens on an edge; the command hears which edge.
AddGroupMenuEntries(params MenuItem[] entries)
Appends a separator and then the given entries to the menu the right button opens on a group's band; the command hears which group.
SetCommandIcon(string command, string icon)
Replaces the framework glyph of the canvas's own entries of one command with an application's icon, in every menu that has it.
See UIGraphCommands for the keys.
SetZoomRange(double minZoom, double maxZoom)
Sets how far the canvas may be zoomed out and in.
SubmitsForm(string eventName)
Its save submits its form, so an OnSubmit document goes before the command (graph.ts registers it so).
SetHeaderAction(IVisualComponent action)
Sets the control the caption row carries at its far edge, keeping the row at one caption line's height.
ConfigureTemplate(TTemplate? current, Action<TTemplate> configure, string what)
Configures current when it is a TTemplate, throwing when a different one was set.
ValidationInto(IVisualComponent targetComponent, UIProperty property)
Sends this field's validation message to another component's property, leaving the field its edge colour alone.
ValidationInto(string componentId, UIProperty property)
Sends this field's validation message to another component's property, leaving the field its edge colour alone.
Required(string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a required-value validation rule; its message is the author's text or a key.
Required(UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a required-value validation rule whose message is a phrase, such as a key with its arguments.
Regex(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a regular-expression validation rule; its message is the author's text or a key.
Regex(string pattern, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a regular-expression validation rule whose message is a phrase, such as a key with its arguments.
RegexEach(string pattern, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule every item of a list value must match — a multi-select's each key, and a tag typed into one with free text is refused before it becomes a chip; its message is the author's text or a key.
RegexEach(string pattern, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule every item of a list value must match, whose message is a phrase, such as a key with its arguments.
Validate(UIValidationTrigger trigger, UIComparisonOperator operator, object? value, string message, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a validation rule; its message is the author's text or a key, looked up as a plain value on a translatable property is.
Validate(UIValidationTrigger trigger, UIComparisonOperator operator, object? value, UIPhrase message, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a validation rule whose message is a phrase: a key with its arguments — a limit's {max} — or UIPhrase.Text.
ValidateAgainst(IInputComponent sourceComponent, UIComparisonOperator operator, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's — "Password again" Equal to "New password" — judged in the browser as either changes; its message is the author's text or a key.
ValidateAgainst(string componentId, UIComparisonOperator operator, string message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's — "Password again" Equal to "New password" — judged in the browser as either changes; its message is the author's text or a key.
ValidateAgainst(IInputComponent sourceComponent, UIComparisonOperator operator, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's, whose message is a phrase, such as a key with its arguments.
ValidateAgainst(string componentId, UIComparisonOperator operator, UIPhrase message, UIValidationTrigger trigger = UIValidationTrigger.Change, UIValidationSeverity severity = UIValidationSeverity.Error)
Adds a rule comparing the value with another field's, whose message is a phrase, such as a key with its arguments.
Common properties (23) — layout, visibility, theme, and the rest every component shares
PropertyTypeDefaultBindingDescription
Visibility
SetVisibility · BindVisibility
UIResponsive<UIVisibility>?Visibleone-wayWhat the component does with the room it was given, optionally overridden per breakpoint (e.g. collapsed from a given width up).
Hidden at every width — by a static value or a controller binding — the server refuses a command or a value the component or anything inside it sends. That is a guard against a stale or forged page, not the permission itself: an interaction that hides it (HiddenWhen) lives on the client alone, so who may act belongs in the command or the setter.
Enabled
SetEnabled · BindEnabled
bool?trueone-wayWhether the component responds to input; false dims it and marks it, and its subtree, inert.
False by a static value or a controller binding, the server refuses a command or a value the component or anything inside it sends. That is a guard against a stale or forged page, not the permission itself: an interaction that disables it (EnabledWhen) lives on the client alone, so who may act belongs in the command or the setter.
Theme
SetTheme · BindTheme
UIThemeMode?nullone-wayThe theme mode forced on this component's subtree, or null to inherit the ambient theme.
HorizontalAlignment
SetHorizontalAlignment · BindHorizontalAlignment
UIResponsive<UIAlignment>?Stretchone-wayWhere the component sits within its grid cell along the horizontal axis, optionally overridden per breakpoint.
VerticalAlignment
SetVerticalAlignment · BindVerticalAlignment
UIResponsive<UIAlignment>?Centerone-wayWhere the component sits within its grid cell along the vertical axis, optionally overridden per breakpoint.
Width
SetWidth · BindWidth
UIResponsive<UILayoutLength>?nullone-wayThe component width, optionally overridden per breakpoint.
MinWidth
SetMinWidth · BindMinWidth
UIResponsive<UILayoutLength>?nullone-wayThe component minimum width, optionally overridden per breakpoint.
MaxWidth
SetMaxWidth · BindMaxWidth
UIResponsive<UILayoutLength>?nullone-wayThe component maximum width, optionally overridden per breakpoint.
Height
SetHeight · BindHeight
UIResponsive<UILayoutLength>?nullone-wayThe component height, optionally overridden per breakpoint.
MinHeight
SetMinHeight · BindMinHeight
UIResponsive<UILayoutLength>?nullone-wayThe component minimum height, optionally overridden per breakpoint.
MaxHeight
SetMaxHeight · BindMaxHeight
UIResponsive<UILayoutLength>?nullone-wayThe component maximum height, optionally overridden per breakpoint.
ZIndex
SetZIndex · BindZIndex
int?0one-wayThe stacking order within the visual tree.
Margin
SetMargin · BindMargin
UIResponsive<UIThickness>?nullone-wayThe outer spacing around the component, optionally overridden per breakpoint.
Placement
SetPlacement · BindPlacement
UIResponsive<UIGridPlacement>?nullone-wayThe grid placement, optionally overridden per breakpoint.
AlignWithFieldBoxes
SetAlignWithFieldBoxes
UIResponsive<UIFieldBoxAlignment>?null—Whether the component stands level with the boxes of captioned fields beside it — a caption line down, centred on the box — and on which boxes, per breakpoint. Unset, the compiler decides it wherever the component stands side by side with a thing that draws a caption row (UIFieldBoxes); UIFieldBoxAlignment.None keeps it where it is laid out.
Render-time only. A panel draws it as its top padding and its least height, anything else as its top margin, set down onto the band's middle; an authored Padding, MinHeight or Margin replaces them.
Loading
SetLoading · BindLoading
bool?falseone-wayWhether the component is in loading state — a live state a controller turns on and off.
While it holds, by a static value or a controller binding, the server refuses a command or a value the component or anything inside it sends — as the page does.
LoadingStyle
SetLoadingStyle · BindLoadingStyle
UILoadingStyle?nullone-wayThe visual indicator shown while this component or spinner is loading, or null to inherit the ambient or theme loading style.
ShowContextMenu
SetShowContextMenu · BindShowContextMenu
bool?trueone-wayWhether a right-click opens the IVisualComponent.ContextMenu; on a host with rows, whether it opens any row's. Off, the menu stays in the tree and nothing opens it.
ActionBar
SetActionBar
UIActionBarAlignment?null—How the component's action bar lines up with it, or null for none: the IVisualComponent.ContextMenu's entries marked for the bar (a menu item's InActionBar) as icons, and "more" opening the menu itself, floating above the component once the reader chooses it — a press, a tap, the keyboard's cursor — until a press elsewhere, Escape, or another chosen.
A quick view of the menu, not a second list: a press on an icon is that entry's press. Render-time only; a component with an action bar and no context menu is refused when the view compiles.
ActionBarRepeatInMore
SetActionBarRepeatInMore
bool?true—Whether the menu the IVisualComponent.ActionBar's "more" opens repeats the entries the bar shows (the default), or holds the rest alone — no caption or rule left with nothing to stand over or between. A right-click and a long press open the whole menu either way, and a bar whose menu holds nothing more draws no "more".
Render-time only.
ScrollGroup
SetScrollGroup · BindScrollGroup
stringnullone-wayThe scroll group this component belongs to: every component sharing the name scrolls together.
Driven by whichever one the reader scrolls. Components that mark their shown source lines (e.g. a code field and a Markdown display) sync line-for-line; otherwise by scroll fraction.
TextSelectable
SetTextSelectable · BindTextSelectable
bool?nullone-wayWhether the reader can select the words in this component and everything inside it: true lets them (a table whose cells are copied, a chat bubble), false keeps them out; unset, the place decides — a Text's and a Paragraph's words and a validation message select, unless they stand in a row, a menu or another control, and nothing else does. The nearest component that says wins.
A control's own words (a button's label, a tab, a menu entry, a field's caption), a surface the pointer drags (a row that drags by itself, a canvas, a grip) and, on a touch screen, anything a long press opens a menu on never select; a field's value always does.
WindowFoot
SetWindowFoot
bool?null—Whether this component is the window's foot (a chat's composer, a pane's last row): where it stands at the window's bottom edge the phone's system bar takes its background colour, dimmed by any open modal drawer or dialog veil, and its content sits above the bar. The page's bottom bar is one by itself.
Render-time only.