API Reference
ChartGrid
Describes a dependency-free small-multiple report made from multiple charts.
Inheritance
- Object
- ChartGrid
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Accepted by parameters
- Method ChartExtensions.AddChartGrid
- Method ChartExtensions.AddChartGrid
- Method ChartExtensions.Save
- Method ChartExtensions.SaveBmp
- Method ChartExtensions.SaveHtml
- Method ChartExtensions.SavePng
- Method ChartExtensions.SavePpm
- Method ChartExtensions.SaveRasterImage
- Method ChartExtensions.SaveRasterImage
- Method ChartExtensions.SaveSvg
- Method ChartExtensions.SaveTiff
- Method ChartExtensions.ToBmp
- Method ChartExtensions.ToHtmlFragment
- Method ChartExtensions.ToHtmlFragment
- Method ChartExtensions.ToHtmlPage
- Method ChartExtensions.ToPng
- Method ChartExtensions.ToPpm
- Method ChartExtensions.ToRasterImage
- Method ChartExtensions.ToRgbaImage
- Method ChartExtensions.ToSvg
- Method ChartExtensions.ToSvg
- Method ChartExtensions.ToTiff
- Method ChartExtensions.WithBrandKit
- Method ChartExtensions.WithTheme
- Method ChartExtensions.WriteBmp
- Method ChartExtensions.WritePpm
- Method ChartExtensions.WriteRasterImage
- Method ChartExtensions.WriteTiff
- Method ImageComposition.DrawChartGrid
- Method ImageComposition.DrawChartGrid
- Method HtmlChartGridRenderer.RenderFragment
- Method HtmlChartGridRenderer.RenderFragment
- Method HtmlChartGridRenderer.RenderPage
- Method PngChartGridRenderer.Render
- Method SvgChartGridRenderer.Render
- Method SvgChartGridRenderer.Render
Methods
Add(ChartForgeX.Core.Chart chart) #Adds a chart to the grid.
Parameters
- chart ChartForgeX.Core.Chart
- The chart to add.
Returns
The current chart grid.
Add(ChartForgeX.Core.Chart chart, System.Int32 columnSpan, System.Int32 rowSpan) #Adds a chart to the grid with a panel span.
Parameters
- chart ChartForgeX.Core.Chart
- The chart to add.
- columnSpan System.Int32
- The number of columns occupied by the chart panel.
- rowSpan System.Int32
- The number of rows occupied by the chart panel.
Returns
The current chart grid.
FromFacets``2(ChartForgeX.Data.ChartDataset{``0} arg1, System.Func{``0,``1} arg2, System.Func{``1,ChartForgeX.Data.ChartDataset{``0},ChartForgeX.Core.Chart} arg3, System.Int32 arg4, System.Collections.Generic.IEqualityComparer{``1} arg5) #Builds a small-multiple grid from deterministic dataset groups.
Parameters
- arg1 ChartForgeX.Data.ChartDataset{``0}
- arg2 System.Func{``0,``1}
- arg3 System.Func{``1,ChartForgeX.Data.ChartDataset{``0},ChartForgeX.Core.Chart}
- arg4 System.Int32
- arg5 System.Collections.Generic.IEqualityComparer{``1}
WithAutomaticPanelSize() #Clears the fixed panel size so composed exports use the largest chart dimensions.
Returns
The current chart grid.
WithAutomaticTheme() #Clears the grid theme so renderers use the first chart theme.
Returns
The current chart grid.
WithColumns(System.Int32 columns) #Sets the preferred number of columns on wide viewports.
Parameters
- columns System.Int32
- The preferred column count.
Returns
The current chart grid.
WithGap(System.Int32 gap) #Sets the gap between charts in pixels.
Parameters
- gap System.Int32
- The gap in pixels.
Returns
The current chart grid.
WithPadding(System.Int32 padding) #Sets the outer padding around exported grid content in pixels.
Parameters
- padding System.Int32
- The padding in pixels.
Returns
The current chart grid.
WithPanelFit(ChartForgeX.Primitives.VisualPanelFit fit) #Sets how charts fit inside fixed-size grid panels.
Parameters
- fit ChartForgeX.Primitives.VisualPanelFit
- The panel fit behavior.
Returns
The current chart grid.
WithPanelSize(System.Int32 width, System.Int32 height) #Sets a fixed panel size for composed SVG and PNG grid exports.
Parameters
- width System.Int32
- The panel width in pixels.
- height System.Int32
- The panel height in pixels.
Returns
The current chart grid.
WithPanelSpan(System.Int32 chartIndex, System.Int32 columnSpan, System.Int32 rowSpan) #Sets the panel span for an existing chart in the grid.
Parameters
- chartIndex System.Int32
- The zero-based chart index.
- columnSpan System.Int32
- The number of columns occupied by the chart panel.
- rowSpan System.Int32
- The number of rows occupied by the chart panel.
Returns
The current chart grid.
WithPngOutputScale(System.Int32 scale) #Sets the output pixel multiplier used by composed PNG grid exports.
Parameters
- scale System.Int32
- The output scale from one to four. Higher values emit larger PNG dimensions with the same logical grid layout.
Returns
The current chart grid.
WithPngOutputScale(ChartForgeX.Core.ChartPngOutputScale scale) #Sets the output pixel multiplier used by composed PNG grid exports using a named density preset.
Parameters
- scale ChartForgeX.Core.ChartPngOutputScale
- The output density preset.
Returns
The current chart grid.
WithSubtitle(System.String subtitle) #Sets the report subtitle.
Parameters
- subtitle System.String
- The report subtitle.
Returns
The current chart grid.
WithSubtitleStyle(System.Action{ChartForgeX.Typography.TextStyleOverride} configure) #Configures grid subtitle text styling.
Parameters
- configure System.Action{ChartForgeX.Typography.TextStyleOverride}
- The style configuration callback.
Returns
The current chart grid.
WithTheme(ChartForgeX.Themes.ChartTheme theme) #Sets the theme used by the grid background and heading.
Parameters
- theme ChartForgeX.Themes.ChartTheme
- The grid theme.
Returns
The current chart grid.
WithTitle(System.String title) #Sets the report title.
Parameters
- title System.String
- The report title.
Returns
The current chart grid.
WithTitleStyle(System.Action{ChartForgeX.Typography.TextStyleOverride} configure) #Configures grid title text styling.
Parameters
- configure System.Action{ChartForgeX.Typography.TextStyleOverride}
- The style configuration callback.
Returns
The current chart grid.
Properties
Title #Gets or sets the report title.
Subtitle #Gets or sets the report subtitle.
Columns #Gets or sets the preferred number of columns on wide viewports.
Gap #Gets or sets the gap between charts in pixels.
Padding #Gets or sets the outer padding around exported grid content in pixels.
PngOutputScale #Gets or sets the output pixel multiplier used by composed PNG grid exports.
PanelSize #Gets or sets the optional fixed panel size used by composed SVG and PNG grid exports.
PanelFit #Gets or sets how charts fit inside fixed-size grid panels.
Theme #Gets or sets the optional theme used by the grid background and heading.
TitleStyle #Gets the text style used for the grid title.
SubtitleStyle #Gets the text style used for the grid subtitle.
Charts #Gets the charts included in the grid.
PanelSpans #Gets the panel spans for charts included in the grid.