FramesFluent
ConsoleMonster.Frames
The fluent methods of DashboardFrame, generated from its public properties: A property-named method sets a property and Add... adds to a collection, both returning the same instance.
Inheritance
- object
- FramesFluent
Methods
public static FrameHeader AddFact(FrameHeader frameHeader, string item) #Adds an item to FrameHeader.Facts: Literal facts in order: scope first, then counts. Empty facts are skipped.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- item string
- The item.
public static FrameSection AddFact(FrameSection frameSection, string item) #Adds an item to FrameSection.Facts: Literal Muted facts after the title.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- item string
- The item.
public static FrameHeader AddFacts(FrameHeader frameHeader, params string[] items) #Adds items to FrameHeader.Facts: Literal facts in order: scope first, then counts. Empty facts are skipped.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- items string[]
- The items, in order.
public static FrameHeader AddFacts(FrameHeader frameHeader, IEnumerable<string> items) #Adds items to FrameHeader.Facts: Literal facts in order: scope first, then counts. Empty facts are skipped.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
public static FrameSection AddFacts(FrameSection frameSection, params string[] items) #Adds items to FrameSection.Facts: Literal Muted facts after the title.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- items string[]
- The items, in order.
public static FrameSection AddFacts(FrameSection frameSection, IEnumerable<string> items) #Adds items to FrameSection.Facts: Literal Muted facts after the title.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
public static AttentionList AddItem(AttentionList attentionList, AttentionItem item) #Adds an item to AttentionList.Items: The items, in any order.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- item ConsoleMonster.Frames.AttentionItem
- The item.
public static AttentionList AddItems(AttentionList attentionList, params AttentionItem[] items) #Adds items to AttentionList.Items: The items, in any order.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- items ConsoleMonster.Frames.AttentionItem[]
- The items, in order.
public static AttentionList AddItems(AttentionList attentionList, IEnumerable<AttentionItem> items) #Adds items to AttentionList.Items: The items, in any order.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Frames.AttentionItem>
- The items, in order.
public static DashboardFrame AddMeter(DashboardFrame dashboardFrame, Meter item) #Adds an item to DashboardFrame.Meters: Headline meters, in priority order.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- item ConsoleMonster.Frames.Meter
- The item.
public static DashboardFrame AddMeters(DashboardFrame dashboardFrame, params Meter[] items) #Adds items to DashboardFrame.Meters: Headline meters, in priority order.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- items ConsoleMonster.Frames.Meter[]
- The items, in order.
public static DashboardFrame AddMeters(DashboardFrame dashboardFrame, IEnumerable<Meter> items) #Adds items to DashboardFrame.Meters: Headline meters, in priority order.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Frames.Meter>
- The items, in order.
public static DashboardFrame AddSection(DashboardFrame dashboardFrame, FrameSection item) #Adds an item to DashboardFrame.Sections: Overview and detail sections, in the order they print.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- item ConsoleMonster.Frames.FrameSection
- The item.
public static DashboardFrame AddSections(DashboardFrame dashboardFrame, params FrameSection[] items) #Adds items to DashboardFrame.Sections: Overview and detail sections, in the order they print.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- items ConsoleMonster.Frames.FrameSection[]
- The items, in order.
public static DashboardFrame AddSections(DashboardFrame dashboardFrame, IEnumerable<FrameSection> items) #Adds items to DashboardFrame.Sections: Overview and detail sections, in the order they print.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Frames.FrameSection>
- The items, in order.
public static FrameHeader AddState(FrameHeader frameHeader, FrameState item) #Adds an item to FrameHeader.States: States; the frame sorts them worst first and drops zero counts.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- item ConsoleMonster.Frames.FrameState
- The item.
public static FrameSection AddState(FrameSection frameSection, FrameState item) #Adds an item to FrameSection.States: The section's states at its right edge, worst first.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- item ConsoleMonster.Frames.FrameState
- The item.
public static FrameHeader AddStates(FrameHeader frameHeader, params FrameState[] items) #Adds items to FrameHeader.States: States; the frame sorts them worst first and drops zero counts.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- items ConsoleMonster.Frames.FrameState[]
- The items, in order.
public static FrameHeader AddStates(FrameHeader frameHeader, IEnumerable<FrameState> items) #Adds items to FrameHeader.States: States; the frame sorts them worst first and drops zero counts.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Frames.FrameState>
- The items, in order.
public static FrameSection AddStates(FrameSection frameSection, params FrameState[] items) #Adds items to FrameSection.States: The section's states at its right edge, worst first.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- items ConsoleMonster.Frames.FrameState[]
- The items, in order.
public static FrameSection AddStates(FrameSection frameSection, IEnumerable<FrameState> items) #Adds items to FrameSection.States: The section's states at its right edge, worst first.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- items System.Collections.Generic.IEnumerable<ConsoleMonster.Frames.FrameState>
- The items, in order.
public static AttentionItem AddValue(AttentionItem attentionItem, string item) #Adds an item to AttentionItem.Values: Short literal values between identity and reason, aligned across items (ages, counts).
Parameters
- attentionItem ConsoleMonster.Frames.AttentionItem
- The instance.
- item string
- The item.
public static AttentionItem AddValues(AttentionItem attentionItem, params string[] items) #Adds items to AttentionItem.Values: Short literal values between identity and reason, aligned across items (ages, counts).
Parameters
- attentionItem ConsoleMonster.Frames.AttentionItem
- The instance.
- items string[]
- The items, in order.
public static AttentionItem AddValues(AttentionItem attentionItem, IEnumerable<string> items) #Adds items to AttentionItem.Values: Short literal values between identity and reason, aligned across items (ages, counts).
Parameters
- attentionItem ConsoleMonster.Frames.AttentionItem
- The instance.
- items System.Collections.Generic.IEnumerable<string>
- The items, in order.
public static DashboardFrame Attention(DashboardFrame dashboardFrame, Action<AttentionList> configure) #Configures DashboardFrame.Attention in place: The attention list; it prints first in the summary rows whenever it has items.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- configure System.Action<ConsoleMonster.Frames.AttentionList>
- Configures the value.
public static Distribution BarWidth(Distribution distribution, int value) #Sets Distribution.BarWidth: The bar width the distribution would like (default 25).
Parameters
- distribution ConsoleMonster.Frames.Distribution
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Frames.Distribution { BarWidth = value }; distribution.BarWidth(value);public static DashboardFrame Configure(DashboardFrame dashboardFrame, Action<DashboardFrame> configure) #Assigns callbacks and related configuration without invoking delegate-valued properties.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- configure System.Action<ConsoleMonster.Frames.DashboardFrame>
- Assignments applied in order.
Examples
// C# initializer or property // C# fluent
dashboardFrame.Compact = value; dashboardFrame.Configure(configured => configured.Compact = value);public static FrameSection FullWidth(FrameSection frameSection, bool value) #Sets FrameSection.FullWidth: Whether the section always takes a row of its own.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- value bool
- The value.
Examples
// C# initializer or property // C# fluent
frameSection.FullWidth = value; frameSection.FullWidth(value);public static FrameSection FullWidth(FrameSection frameSection) #Sets FrameSection.FullWidth to true.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance to configure.
public static AttentionList GroupAtLeast(AttentionList attentionList, int value) #Sets AttentionList.GroupAtLeast: Identical state and reason for this many items or more become one grouped item (default 3).
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- value int
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Frames.AttentionList { GroupAtLeast = value }; attentionList.GroupAtLeast(value);public static FrameSection Grow(FrameSection frameSection, double value) #Sets FrameSection.Grow: Share of leftover row width; zero keeps the section at its natural width.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- value double
- The value.
Examples
// C# initializer or property // C# fluent
frameSection.Grow = value; frameSection.Grow(value);public static DashboardFrame Header(DashboardFrame dashboardFrame, Action<FrameHeader> configure) #Configures DashboardFrame.Header in place: The title line.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- configure System.Action<ConsoleMonster.Frames.FrameHeader>
- Configures the value.
public static DashboardFrame Length(DashboardFrame dashboardFrame, ConsoleViewLength? value) #Sets DashboardFrame.Length: An explicit length; null uses the session preference or Standard.
Parameters
- dashboardFrame ConsoleMonster.Frames.DashboardFrame
- The instance.
- value ConsoleMonster.Views.ConsoleViewLength?
- The value.
Examples
// C# initializer or property // C# fluent
dashboardFrame.Length = value; dashboardFrame.Length(value);public static FrameSection MaxWidth(FrameSection frameSection, int? value) #Sets FrameSection.MaxWidth: The widest the section may become, or null for no limit.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- value int?
- The value.
Examples
// C# initializer or property // C# fluent
frameSection.MaxWidth = value; frameSection.MaxWidth(value);public static FrameSection Meta(FrameSection frameSection, string? value) #Sets FrameSection.Meta: Literal Muted meta at the right edge when there is no state (log axis).
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
frameSection.Meta = value; frameSection.Meta(value);public static FrameSection MinWidth(FrameSection frameSection, int? value) #Sets FrameSection.MinWidth: The narrowest useful width; null uses the content's natural width, so the section never shrinks below it.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- value int?
- The value.
Examples
// C# initializer or property // C# fluent
frameSection.MinWidth = value; frameSection.MinWidth(value);public static AttentionList Noun(AttentionList attentionList, string value) #Sets AttentionList.Noun: The singular noun for the items, for example partnership.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- value string
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Frames.AttentionList { Noun = value }; attentionList.Noun(value);public static FrameHeader ObservedAt(FrameHeader frameHeader, DateTimeOffset? value) #Sets FrameHeader.ObservedAt: When the data was observed; shown as local time, with the date when it is not today.
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- value System.DateTimeOffset?
- The value.
Examples
// C# initializer or property // C# fluent
frameHeader.ObservedAt = value; frameHeader.ObservedAt(value);public static AttentionList OutOf(AttentionList attentionList, long? value) #Sets AttentionList.OutOf: The total the items come from, for 3 of 12 partnerships; null shows only the item count.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- value long?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Frames.AttentionList { OutOf = value }; attentionList.OutOf(value);public static FrameSection Placement(FrameSection frameSection, FramePlacement value) #Sets FrameSection.Placement: Summary or detail.
Parameters
- frameSection ConsoleMonster.Frames.FrameSection
- The instance.
- value ConsoleMonster.Frames.FramePlacement
- The value.
Examples
// C# initializer or property // C# fluent
frameSection.Placement = value; frameSection.Placement(value);public static AttentionList PluralNoun(AttentionList attentionList, string? value) #Sets AttentionList.PluralNoun: The plural noun; null adds an s.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- value string?
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Frames.AttentionList { PluralNoun = value }; attentionList.PluralNoun(value);public static AttentionList Title(AttentionList attentionList, string value) #Sets AttentionList.Title: The section title.
Parameters
- attentionList ConsoleMonster.Frames.AttentionList
- The instance.
- value string
- The value.
Examples
// C# initializer or property // C# fluent
new global::ConsoleMonster.Frames.AttentionList { Title = value }; attentionList.Title(value);public static FrameHeader Title(FrameHeader frameHeader, string value) #Sets FrameHeader.Title: The literal title, usually the view name (Replication).
Parameters
- frameHeader ConsoleMonster.Frames.FrameHeader
- The instance.
- value string
- The value.
Examples
// C# initializer or property // C# fluent
frameHeader.Title = value; frameHeader.Title(value);