API Reference
Class
SegmentedMetricBlock
A generic segmented metric block for progress rows, part-to-whole strips, and distribution rows.
Inheritance
- FactualVisualBlock<SegmentedMetricBlock>
- SegmentedMetricBlock
Usage
Explore 15 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 15
- Method SegmentedMetricBlock.AddItem
- Method SegmentedMetricBlock.Create
- Method SegmentedMetricBlock.WithCaption
- Method SegmentedMetricBlock.WithCard
- Method SegmentedMetricBlock.WithHeaderSymbol
- Method SegmentedMetricBlock.WithHostFrame
- Method SegmentedMetricBlock.WithMetric
- Method SegmentedMetricBlock.WithPadding
- Method SegmentedMetricBlock.WithPngOutputScale
- Method SegmentedMetricBlock.WithSize
- Method SegmentedMetricBlock.WithStyle
- Method SegmentedMetricBlock.WithSubtitle
- Method SegmentedMetricBlock.WithTheme
- Method SegmentedMetricBlock.WithTitle
- Method SegmentedMetricBlock.WithTransparentBackground
Constructors
public SegmentedMetricBlock() #Methods
AddItem 3 overloads
public SegmentedMetricBlock AddItem(String label, Double value, Double maximum = 100, Int32 segments = 40, ChartColor? color = null, VisualStatus status = None, ChartFillPattern pattern = None, String? delta = null, String? symbol = null, Object? displayValue = null, String? displayFormat = null) #Returns:
SegmentedMetricBlockAdds a generic segmented metric item.
Parameters
- label System.String
- value System.Double
- maximum System.Double = 100
- segments System.Int32 = 40
- color ChartForgeX.Primitives.ChartColor? = null
- status ChartForgeX.VisualBlocks.VisualStatus = None
- pattern ChartForgeX.Core.ChartFillPattern = None
- delta System.String? = null
- symbol System.String? = null
- displayValue System.Object? = null
- displayFormat System.String? = null
public SegmentedMetricBlock AddItem(SegmentedMetricItem item) #Returns:
SegmentedMetricBlockAdds a preconfigured segmented metric item.
Parameters
- item ChartForgeX.VisualBlocks.SegmentedMetricItem
public SegmentedMetricBlock AddItem(String label, Double value, Action<SegmentedMetricItem> configure) #Returns:
SegmentedMetricBlockAdds a segmented metric item and configures it with a callback.
Parameters
- label System.String
- value System.Double
- configure System.Action<ChartForgeX.VisualBlocks.SegmentedMetricItem>
public static SegmentedMetricBlock Create(SegmentedMetricStyle style = ProgressRows) #Returns:
SegmentedMetricBlockCreates a new segmented metric block.
Parameters
- style ChartForgeX.VisualBlocks.SegmentedMetricStyle = ProgressRows
public SegmentedMetricBlock WithCaption(String caption) #Returns:
SegmentedMetricBlockSets optional caption text.
Parameters
- caption System.String
public SegmentedMetricBlock WithHeaderSymbol(String symbol) #Returns:
SegmentedMetricBlockSets optional compact header symbol rendered in a badge.
Parameters
- symbol System.String
public SegmentedMetricBlock WithMetric(String label, Object? value, String? unit = null, String? caption = null, String? format = null) #Returns:
SegmentedMetricBlockSets the card metric label and value.
Parameters
- label System.String
- value System.Object?
- unit System.String? = null
- caption System.String? = null
- format System.String? = null
public SegmentedMetricBlock WithStyle(SegmentedMetricStyle style) #Returns:
SegmentedMetricBlockSets the segmented metric visual treatment.
Parameters
- style ChartForgeX.VisualBlocks.SegmentedMetricStyle
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public override RgbaImage RenderRgba() #Returns:
RgbaImageInherited from 0, Culture=neutral, PublicKeyToken=null]]
public override String RenderSvg(String idScope) #Returns:
StringInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- idScope String
public SegmentedMetricBlock WithCard(Boolean enabled = true) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
public SegmentedMetricBlock WithHostFrame(Boolean hostOwnsFrame = true) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- hostOwnsFrame Boolean = true
WithPadding 2 overloads
public SegmentedMetricBlock WithPadding(Double padding) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- padding Double
public SegmentedMetricBlock WithPadding(Double left, Double top, Double right, Double bottom) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- left Double
- top Double
- right Double
- bottom Double
public SegmentedMetricBlock WithPngOutputScale(Int32 scale) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Int32
public SegmentedMetricBlock WithSize(Int32 width, Int32 height) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- width Int32
- height Int32
public SegmentedMetricBlock WithSubtitle(String subtitle) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- subtitle String
public SegmentedMetricBlock WithTheme(ChartTheme theme) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- theme ChartTheme
public SegmentedMetricBlock WithTitle(String title) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title String
public SegmentedMetricBlock WithTransparentBackground(Boolean enabled = true) #Returns:
SegmentedMetricBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
Properties
public SegmentedMetricStyle Style { get; set; } #Gets or sets the visual treatment used for the items.
public IReadOnlyList<SegmentedMetricItem> Items { get; } #Gets metric items.
public String Label { get; set; } #Gets the metric label.
public String Value { get; set; } #Gets the metric value.
public String Unit { get; set; } #Gets the unit suffix rendered beside item values for composition-style blocks.
public String Caption { get; set; } #Gets optional caption text rendered beside the metric.
public String HeaderSymbol { get; set; } #Gets optional compact header symbol rendered in a badge.
Inherited Properties
public String Title { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public String Subtitle { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public VisualBlockOptions Options { get; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]
public virtual String AccessibleName { get; } #Inherited from 0, Culture=neutral, PublicKeyToken=null]]