DashboardFrame
ConsoleMonster.Frames
A static dashboard frame for summary output: title line, meters, Needs attention, overview sections packed side by side, detail sections, legend and footer. It prints once and scrolls like any output. The frame applies the width tiers, the length preference, the ordering and the footer hint, so every product frame follows the same rules.
Inheritance
- object
- DashboardFrame
Usage
Explore 38 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 18
- Extension method DashboardFrame.AddMeter
- Extension method DashboardFrame.AddMeters
- Extension method DashboardFrame.AddSection
- Extension method DashboardFrame.AddSections
- Extension method DashboardFrame.Attention
- Extension method DashboardFrame.Configure
- Extension method DashboardFrame.Footer
- Extension method DashboardFrame.Header
- Extension method DashboardFrame.Length
- Method DashboardFrameFluent.AddMeter
- Method DashboardFrameFluent.AddMeters
- Method DashboardFrameFluent.AddSection
- Method DashboardFrameFluent.AddSections
- Method DashboardFrameFluent.Attention
- Method DashboardFrameFluent.Configure
- Method DashboardFrameFluent.Footer
- Method DashboardFrameFluent.Header
- Method DashboardFrameFluent.Length
Accepted by parameters 20
- Extension method DashboardFrame.AddMeter
- Extension method DashboardFrame.AddMeters
- Extension method DashboardFrame.AddSection
- Extension method DashboardFrame.AddSections
- Extension method DashboardFrame.Attention
- Extension method DashboardFrame.Configure
- Extension method DashboardFrame.Configure
- Extension method DashboardFrame.Footer
- Extension method DashboardFrame.Header
- Extension method DashboardFrame.Length
- Method DashboardFrameFluent.AddMeter
- Method DashboardFrameFluent.AddMeters
- Method DashboardFrameFluent.AddSection
- Method DashboardFrameFluent.AddSections
- Method DashboardFrameFluent.Attention
- Method DashboardFrameFluent.Configure
- Method DashboardFrameFluent.Configure
- Method DashboardFrameFluent.Footer
- Method DashboardFrameFluent.Header
- Method DashboardFrameFluent.Length
Constructors
public DashboardFrame(string title) #Creates a frame.
Parameters
- title string
- The literal title, usually the view name.
Methods
public Size Measure(Constraints constraints, RenderContext context) #Returns the size the widget wants within the constraints.
Parameters
- constraints ConsoleMonster.Layout.Constraints
- The space offered.
- context ConsoleMonster.Canvas.RenderContext
- Profile, theme and glyphs.
public void Render(Region region, RenderContext context) #Renders into a region. The region may be smaller or larger than the measured size.
Parameters
- region ConsoleMonster.Canvas.Region
- The target region.
- context ConsoleMonster.Canvas.RenderContext
- Profile, theme and glyphs.
Inherited Methods
Properties
public AttentionList Attention { get; } #The attention list; it prints first in the summary rows whenever it has items.
public IList<FrameSection> Sections { get; } #Overview and detail sections, in the order they print.
public ConsoleViewLength? Length { get; set; } #An explicit length; null uses the session preference or Standard.
public Func<FrameScale, IWidget>? Compact { get; set; } #The type's compact view for narrow terminals; null stacks the frame's own sections. The compact view replaces the title line, attention list and sections, so it must carry its own title line and list every problem; the frame adds the meter counts and the footer.
Extension Methods
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 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 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 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);