NE.Standard.UI.Graph

Enums and value types

Every enum and every value type a component property or an item model carries, with what each member means. A property page links here from its type.

Value types

A length, a colour, a text appearance: built from a static member, or written as its parts.

ColorVariant

From NE.Colors, a package of its own: the names are listed here, and what they mean is in its own repository.

MemberMeaning
FromRgb(byte red, byte green, byte blue, ColorAdjustment adjustment = ColorAdjustment.None, int factor = 0, byte opacity = 255)
FromColor(Color color, ColorAdjustment adjustment = ColorAdjustment.None, int factor = 0)
TryParseHex(string? text, ColorVariant variant)
Nearest(Color color)
Nearest(byte red, byte green, byte blue, byte opacity = 255)
MinFactor
MaxFactor
ColorName Name
ColorAdjustment Adjustment
int Factor
byte Opacity
int? Rgb

UIActionArgument

Represents a value, binding, or contextual value passed to a UI action.

MemberMeaning
Literal(object? value)Creates a literal action argument from a value.
Literals(params KeyValuePair<string, object>[] arguments)Creates literal action arguments from named values, keeping their names and order.
CurrentItem()Creates an action argument resolved from the current item.
CurrentItemKey()Creates an action argument resolved from the current item key.
GroupKey()Creates an action argument resolved from the current item's group.
EventKey(int index)Creates an action argument resolved from the key at index of the event's own key chain.
EventValue()Creates an action argument resolved from what the event carries after the keys that address its component.
EventValue(int index)Creates an action argument resolved from the value at index of what the event carries after the keys that address its component.
Bind(UIBindingPath binding)Creates an action argument resolved from a binding path.
UIActionArgumentKind KindHow this argument is resolved.
object ValueThe literal value for literal arguments, the place in the event's key chain for an event key, or the tuple index for an event value.
UIBindingPath? BindingThe binding path for binding arguments.
bool OfferedWhether the framework offers the argument beside the author's own (a drop, an edited row's key): a command with no parameter for it leaves it untaken, and the compile does not warn of it.

UIBindingPath

Represents a recursive binding path and the context used to resolve it.

MemberMeaning
Relative(RecursivePath path)Creates a binding path resolved relative to the current binding context.
Parent(RecursivePath path)Creates a binding path resolved in the scope around the component's own (UIBindingScope.Parent).
Root(RecursivePath path)Creates a binding path resolved relative to the root binding context.
RecursivePath PathThe recursive binding path.
UIBindingScope ScopeThe context used to resolve the path.

UICornerRadius

Corner radius values, in pixels, for a rectangular UI element's four corners.

MemberMeaning
All(double topLeft, double topRight, double bottomRight, double bottomLeft)Creates a corner radius with an independent value for each corner.
Uniform(double radius)Creates a corner radius applying the same value to all four corners.
Top(double radius)Creates a corner radius rounding only the top corners, leaving the bottom corners square.
Bottom(double radius)Creates a corner radius rounding only the bottom corners, leaving the top corners square.
double TopLeft
double TopRight
double BottomRight
double BottomLeft

UIGridPlacement

A component's placement in the fixed-column grid: 1-based column/row, and how many columns/rows it spans.

MemberMeaning
At(int column, int row, int columnSpan = 1, int rowSpan = 1)Creates a placement at the given column and row with the given spans.
GridColumnsGets the number of columns in the standard UI grid.
int Column
int Row
int ColumnSpan
int RowSpan

UILayoutLength

Represents a layout length value.

MemberMeaning
Auto()Creates a layout length that sizes automatically to its content.
Absolute(double value)Creates a layout length with a fixed absolute value.
Fill()The whole of what the parent gives, less the component's own margin on that axis: a list with SetMargin(8) and a Fill height fits its parent with 8 px clear at either end rather than overflowing it by the margin.
UILayoutLengthKind KindWhether the length is absolute, the whole of what the parent gives, or the content's own.
double ValueThe length in pixels for UILayoutLengthKind.Absolute; -1 for the kinds that carry none.

UIProperty

Represents a UI component property key.

MemberMeaning
string NameThe property name.

UITextAppearance

Represents a text's typography: either a semantic UITextType role, or an explicit UITextAppearance.Size override.

UITextAppearance.Weight, UITextAppearance.LineHeight and UITextAppearance.LetterSpacing are read only alongside an explicit UITextAppearance.Size.

MemberMeaning
FromRole(UITextType role)Creates a text appearance tracking the given semantic UITextType role live.
Custom(double size, int? weight = null, double? lineHeight = null, double? letterSpacing = null)Creates a text appearance from an explicit font size, optionally overriding weight, line-height, and letter-spacing.
DisplayThe largest, most prominent typographic role, for hero-style text, tracked live via UITextAppearance.FromRole.
TitleThe typographic role for primary headings, tracked live via UITextAppearance.FromRole.
SubtitleThe typographic role for secondary headings, tracked live via UITextAppearance.FromRole.
BodyThe typographic role for regular body text, tracked live via UITextAppearance.FromRole.
CaptionThe typographic role for small, supplementary text, tracked live via UITextAppearance.FromRole.
OverlineThe typographic role for small label text placed above content, tracked live via UITextAppearance.FromRole.
UITextType? RoleThe semantic role sizing the text; used only while Size is unset.
double? SizeAn explicit size, in pixels, which wins over the role.
int? WeightAn explicit font weight.
double? LineHeightAn explicit line height, in pixels.
double? LetterSpacingAn explicit letter spacing, in pixels.

UIThemeColor

Represents a themed color: either a semantic UIColorStyle role, or an explicit UIThemeColor.Light/UIThemeColor.Dark override, which wins when set.

MemberMeaning
FromStyle(UIColorStyle style)Creates a theme color tracking the given semantic UIColorStyle role live.
FromColorVariant(ColorName name, ColorAdjustment adjustment = ColorAdjustment.None, int factor = 0, byte opacity = 255)Creates a theme color from a fixed color variant, used identically in both light and dark mode.
FromColorVariant(ColorVariant color)Creates a theme color from a fixed color variant, used identically in both light and dark mode.
Create(ColorVariant? light, ColorVariant? dark)Creates a theme color from explicit light and dark overrides.
TryParse(string? text, UIThemeColor color)Reads the canonical wire form a client sends back: @Role for a semantic role, #RRGGBBAA for an explicit colour, or Name/Adjustment/factor/opacity for a palette variant.
DefaultPresets mirroring each UIColorStyle role, theme-aware via UIThemeColor.FromStyle.
PrimaryThe theme's primary brand color, tracked live via UIThemeColor.FromStyle.
AccentThe theme's secondary accent color, tracked live via UIThemeColor.FromStyle.
BackgroundThe page/surface background color, tracked live via UIThemeColor.FromStyle.
SurfaceA raised surface's background color (e.g. a card), tracked live via UIThemeColor.FromStyle.
OnPrimaryA color intended to sit on top of UIThemeColor.Primary, tracked live via UIThemeColor.FromStyle.
OnAccentA color intended to sit on top of UIThemeColor.Accent, tracked live via UIThemeColor.FromStyle.
OnBackgroundA color intended to sit on top of UIThemeColor.Background, tracked live via UIThemeColor.FromStyle.
OnSurfaceA color intended to sit on top of UIThemeColor.Surface, tracked live via UIThemeColor.FromStyle.
InfoThe informational status color, tracked live via UIThemeColor.FromStyle.
WarningThe warning status color, tracked live via UIThemeColor.FromStyle.
SuccessThe success status color, tracked live via UIThemeColor.FromStyle.
DangerThe danger/error status color, tracked live via UIThemeColor.FromStyle.
OnInfoA color intended to sit on top of UIThemeColor.Info, tracked live via UIThemeColor.FromStyle.
OnWarningA color intended to sit on top of UIThemeColor.Warning, tracked live via UIThemeColor.FromStyle.
OnSuccessA color intended to sit on top of UIThemeColor.Success, tracked live via UIThemeColor.FromStyle.
OnDangerA color intended to sit on top of UIThemeColor.Danger, tracked live via UIThemeColor.FromStyle.
MutedA dimmed variant of the ambient color, for secondary/de-emphasized text, tracked live via UIThemeColor.FromStyle.
SelectedThe chrome token indicating a selected item or state, tracked live via UIThemeColor.FromStyle.
FocusRingThe focus indicator ring color, tracked live via UIThemeColor.FromStyle.
BorderThe default border color, tracked live via UIThemeColor.FromStyle.
MarkThe edge that says a control is there, reading 3:1 on its ground, tracked live via UIThemeColor.FromStyle.
ShadowThe drop shadow color, tracked live via UIThemeColor.FromStyle.
OverlayThe modal/scrim overlay color, tracked live via UIThemeColor.FromStyle.
TransparentNo fill: a colour of no opacity, the same in both themes. A background written it shows what is behind it, and what stands on it takes the page's ink, as on the page's own grounds.
UIColorStyle? StyleThe semantic role the palette resolves the colour from.
ColorVariant? LightAn explicit colour for the light theme.
ColorVariant? DarkAn explicit colour for the dark theme.

UIThickness

Thickness values, in pixels, for a rectangular UI element's four sides.

MemberMeaning
All(double left, double top, double right, double bottom)Creates a thickness with an independent value for each side.
Uniform(double value)Creates a thickness applying the same value to all four sides.
Symmetric(double horizontal, double vertical)Creates a thickness applying one value to the left/right sides and another to the top/bottom sides.
double Left
double Top
double Right
double Bottom

UIValidationMessage

A validation message a controller puts on an input: the severity and the words. Null on the property means none.

The words are translatable as a label is: a text is looked up as a plain value on a translatable property is — under key prefixes only a prefixed one — and a UIPhrase always; the page shows them in its language and again after a switch.

MemberMeaning
Error(string message)A message that refuses the value.
Error(UIPhrase message)A message that refuses the value.
Warning(string message)A message that warns about the value without refusing it.
Warning(UIPhrase message)A message that warns about the value without refusing it.
Info(string message)A message that only tells the viewer something about the value.
Info(UIPhrase message)A message that only tells the viewer something about the value.
UIValidationSeverity SeverityHow the message is drawn and whether it refuses a submit.
UIPhrase MessageThe words shown under the input, or in its marker's tooltip: the author's text (UIPhrase.IsText) or a phrase.

Enums

ColorAdjustment

From NE.Colors, a package of its own: the names are listed here, and what they mean is in its own repository.

MemberMeaning
None
Shade
Tint

ColorName

From NE.Colors, a package of its own: the names are listed here, and what they mean is in its own repository.

MemberMeaning
IronFog
SilverNight
BronzeDusk
StellarRed
NebulaRose
LunarPink
PulsarMagenta
SolarAmber
NebulaLemon
LunarYellow
SolarGold
EclipseOlive
NebulaLime
LunarSage
AuroraGreen
NebulaMint
LunarFern
AstralTeal
NebulaCyan
LunarMoss
QuantumBlue
NebulaAqua
LunarAzure
NovaPurple
NebulaViolet
LunarLavender
Comet
Flare
Ember
Photon
Vortex
Halo

UIActionArgumentKind

Defines how an interaction action argument is resolved.

MemberMeaning
LiteralThe argument value is a fixed literal.
CurrentItemThe argument value is the current item of the enclosing items scope.
CurrentItemKeyThe argument value is the key of the current item of the enclosing items scope.
BindingThe argument value is resolved from a binding.
EventKeyThe argument value is one key of the event's own chain, by its place in it — for an event that names its keys itself.
EventValueThe argument value is what the event carries after the keys that address its component — the place a dragged row was dropped at.
GroupKeyThe argument value is the group of the current item — in a group header, the group the header heads.

UIActionBarAlignment

How a component's action bar lines up with it (SetActionBar): the bar floats above the component, under it where there is no room above, aligned with its end, its start or its middle. Start and end follow the page's direction, so a right-to-left page mirrors them.

MemberMeaning
EndAligned with the end edge, where a messenger puts a message's actions.
StartAligned with the start edge.
CenterCentred on the component, as over a node on a canvas.

UIAlignment

Defines cross-axis or main-axis alignment for UI layout.

MemberMeaning
StartAligns content to the start of the axis.
CenterAligns content to the center of the axis.
EndAligns content to the end of the axis.
StretchStretches content to fill the axis.

UIBadgeFill

Defines how a badge spends its colour: on its ground, on a light tint of it, or on its edge alone.

MemberMeaning
FilledThe colour as the ground, with the words in the colour that reads on it.
TintedA light tint of the colour as the ground, with the words in the colour's ink.
OutlineNo ground, a thin edge in the colour, and the words in the colour's ink.

UIBadgeVariant

Defines visual variants for badge-like components.

MemberMeaning
PrimaryThe theme's primary brand color variant.
AccentThe theme's secondary accent color variant.
InfoThe informational status color variant.
WarningThe warning status color variant.
SuccessThe success status color variant.
DangerThe danger/error status color variant.
SurfaceA card-like distinct background variant with no color accent.
PlainThe content alone, with no ground, edge or padding, in the muted ink; a reachable one brightens under the pointer and the keyboard.

UIBindingMode

Defines how data flows between a binding source and a UI target.

MemberMeaning
OneWayUpdates flow only from the binding source to the UI target.
TwoWayUpdates flow in both directions between the binding source and the UI target.
OneWayToSourceUpdates flow only from the UI target to the binding source.
OnSubmitTarget-to-source updates are buffered until an explicit submit occurs.

UIBindingScope

Defines the component context used to resolve a binding path.

MemberMeaning
RelativeResolves the binding path relative to the component's own context.
ParentResolves the binding path in the scope around the component's own: up past the nearest component that defines a context (a row's template, a menu's entry), one step out — so a control straight in a row reaches the list's scope, not the row.
RootResolves the binding path relative to the root context.

UIColorStyle

Defines semantic color roles used by UI components.

MemberMeaning
DefaultNo explicit color override; inherits the ambient color.
PrimaryThe theme's primary brand color.
AccentThe theme's secondary accent color.
BackgroundThe page/surface background color.
SurfaceA raised surface's background color (e.g. a card).
OnPrimaryA color intended to sit on top of UIColorStyle.Primary.
OnAccentA color intended to sit on top of UIColorStyle.Accent.
OnBackgroundA color intended to sit on top of UIColorStyle.Background.
OnSurfaceA color intended to sit on top of UIColorStyle.Surface.
InfoThe informational status color.
WarningThe warning status color.
SuccessThe success status color.
DangerThe danger/error status color.
OnInfoA color intended to sit on top of UIColorStyle.Info.
OnWarningA color intended to sit on top of UIColorStyle.Warning.
OnSuccessA color intended to sit on top of UIColorStyle.Success.
OnDangerA color intended to sit on top of UIColorStyle.Danger.
MutedA dimmed variant of the ambient color, for secondary/de-emphasized text.
SelectedThe color indicating a selected item or state.
FocusRingThe color of the focus indicator ring around focused elements.
BorderThe default border color.
ShadowThe color used for drop shadows.
OverlayThe color used for modal/scrim overlay backgrounds.
MarkThe edge that says a control is there (a field's border, an unchecked box's ring), reading 3:1 on its ground.

UIComparisonOperator

Defines comparison operators used by UI validation and interaction rules.

MemberMeaning
RequiredThe value must be present: not null, not false, and not empty or whitespace text.
EqualThe value must equal the comparison value.
NotEqualThe value must not equal the comparison value.
GreaterThe value must be greater than the comparison value.
GreaterOrEqualThe value must be greater than or equal to the comparison value.
LessThe value must be less than the comparison value.
LessOrEqualThe value must be less than or equal to the comparison value.
LikeThe value must contain the comparison value as a substring.
InThe value (or at least one element when the value is a collection) must be contained in the comparison value's collection.
RegexThe value must match the comparison value as a regular expression.
LikeIgnoreCaseThe value must contain the comparison value as a substring, ignoring case.
RegexEachEvery item of a list value must match the comparison value as a regular expression — a multi-select's each key; a value that is no list is one item, and nothing is an empty list.

UIFieldBoxAlignment

Which field boxes a panel stands level with, or none.

MemberMeaning
NoneStands where it is laid out.
SmallLevel with small field boxes (UISize.Small).
MediumLevel with medium field boxes (UISize.Medium).
LargeLevel with large field boxes (UISize.Large).

UIGraphDirection

Which way the layered layout runs, from what nothing feeds to what feeds nothing.

MemberMeaning
LeftToRightThe layers stand side by side, the first at the left.
TopToBottomThe layers stand one under another, the first at the top.
RightToLeftThe layers stand side by side, the first at the right — read from what feeds nothing back to what nothing feeds.
BottomToTopThe layers stand one under another, the first at the bottom.

UIGraphEdgeShape

How an edge is drawn between two pins.

MemberMeaning
BezierA curve leaving each pin sideways.
StraightA straight line from pin to pin.
OrthogonalHorizontal and vertical runs with square corners.

UIGraphNodeShape

How a graph's node is drawn.

MemberMeaning
CardA card: the icon or picture, the title and the line under it, and the badge at its end.
IconA circle holding the node's picture, or its icon when it has none, with the title standing under it and as its tooltip.

UILayoutLengthKind

Defines the kind of layout length value.

MemberMeaning
AutoThe length is determined automatically based on content.
AbsoluteThe length is a fixed value expressed in device-independent units.
FillThe whole of what the parent gives: a page that fills the viewport, a pane that fills its track. A component's own margin on that axis comes out of it, so a filled box with a margin still fits its parent.

UILoadingStyle

The shape a spinner or a loading component draws while work is under way.

MemberMeaning
RingA turning circular ring.
DotsThree dots animated by a periodic vertical wave.

UIPopupPlacement

Defines where a popup prefers to sit relative to its anchor; a side with no room for it flips to its opposite, and with room on neither, to a side across, so the popup never covers its own anchor where one of the four sides has room.

MemberMeaning
BottomStartBelow the anchor, aligned to its start edge.
BottomBelow the anchor, centered on it.
BottomEndBelow the anchor, aligned to its end edge.
TopStartAbove the anchor, aligned to its start edge.
TopAbove the anchor, centered on it.
TopEndAbove the anchor, aligned to its end edge.
LeftStartTo the left of the anchor, aligned to its start edge.
LeftTo the left of the anchor, centered on it.
LeftEndTo the left of the anchor, aligned to its end edge.
RightStartTo the right of the anchor, aligned to its start edge.
RightTo the right of the anchor, centered on it.
RightEndTo the right of the anchor, aligned to its end edge.

UIProductionMode

Which of its two uses a production graph is put to.

MemberMeaning
ConstructorThe catalogue as it is: every resource and craft, one run's amounts on the edges, edited where the graph allows it.
PlanA plan over the catalogue: the viewer names target amounts, and the graph draws the crafts and resources that reach them.

UIShape

The shape a picture is drawn in — an image standing alone, or an icon that is a picture; a glyph keeps its own whatever the shape.

MemberMeaning
DefaultThe picture's own: an image in the box the layout gives it, its corners as BorderRadius says; an icon's picture as it is, its corners slightly rounded.
CircleA circle the picture fills, a picture of another proportion cropped to its middle (an image's Fit may say otherwise) — a person, a team.

UISize

How much room a control or a glyph takes, independent of what it holds: one scale for a button, a field, an icon and an indicator.

MemberMeaning
SmallSized to sit inside a row, a toolbar, a list or a dense surface (a node on a canvas, a cell) without setting its height.
MediumThe ordinary size — a button or a field standing on its own.
LargeA call to action, where the control is the point of what it sits in.

UITextBadgePlacement

Defines where a badge in text content is placed.

MemberMeaning
InlineThe badge is placed inline within the text content.
TrailingThe badge is placed after the text content.

UITextType

Defines semantic text roles used by text components.

MemberMeaning
DisplayThe largest, most prominent typographic role, for hero-style text.
TitleThe typographic role for primary headings.
SubtitleThe typographic role for secondary headings.
BodyThe typographic role for regular body text.
CaptionThe typographic role for small, supplementary text.
OverlineThe typographic role for small label text placed above content.

UIThemeMode

The two themes a surface can be forced into. null means "inherit" on a component and "follow the platform" on a session.

MemberMeaning
LightAlways uses the light theme.
DarkAlways uses the dark theme.

UIValidationPresentation

Where a field's validation message goes: a line under the field, or a mark at its edge that speaks in a tooltip.

MemberMeaning
AutoA line under the field, except where the field sits in a table's cell, where it is a mark; an open key-value row keeps the line.
MessageA line under the field, wherever the field is.
MarkerA mark at the field's edge, the message in its tooltip; the field keeps its height.

UIValidationSeverity

What a validation message means: an error stops a submit, a warning and an info only say something.

MemberMeaning
ErrorBlocks a submit and draws both the required marker and the field's edge.
WarningColours the field's edge but never blocks a submit.
InfoSpeaks only under the field, without touching its edge or blocking a submit.

UIValidationTrigger

Defines when a UI validation rule is evaluated.

MemberMeaning
ChangeThe rule is evaluated whenever the value changes.
BlurThe rule is evaluated when the input loses focus.
SubmitThe rule is evaluated when the form is submitted.

UIVisibility

Defines what a component does with the room it was given: fills it, keeps it empty, or gives it back.

MemberMeaning
VisibleDrawn, and taking part in everything: layout, hit-testing, focus and assistive technology.
HiddenNot drawn, but still holding its place — the layout around it does not move.
CollapsedGone from the layout as well: everything after it closes the gap.