API Reference
ChartPlotRegion
A passive, solid background rectangle bounded by Cartesian data coordinates.
Inheritance
- Object
- ChartPlotRegion
Remarks
Null bounds use the final axis domain. Regions never expand that domain. Reversal changes their painted position without changing authored bounds. Time coordinates use OLE Automation dates. Bounds follow physical X and Y: horizontal charts use value coordinates for X and linear category slots for Y.
Usage
Explore 2 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 1
- Property Chart.PlotRegions
Accepted by parameters 1
- Method Chart.AddPlotRegion
Constructors
public ChartPlotRegion(Int32 paletteIndex, Double? xMinimum = null, Double? xMaximum = null, Double? yMinimum = null, Double? yMaximum = null, String label = "", Double opacity = 0.14, ChartAxisSide yAxis = Primary, Boolean showLabel = true) #Creates a region whose color follows the active render theme's categorical palette.
Parameters
- paletteIndex System.Int32
- The zero-based palette index. Larger indices wrap to the active palette length.
- xMinimum System.Double? = null
- The inclusive lower X bound, or null for the domain minimum.
- xMaximum System.Double? = null
- The inclusive upper X bound, or null for the domain maximum.
- yMinimum System.Double? = null
- The inclusive lower Y bound, or null for the domain minimum.
- yMaximum System.Double? = null
- The inclusive upper Y bound, or null for the domain maximum.
- label System.String = ""
- An optional interior caption retained in semantic metadata.
- opacity System.Double = 0.14
- The fill opacity from zero through one.
- yAxis ChartForgeX.Core.ChartAxisSide = Primary
- The Y axis that owns the region's coordinates.
- showLabel System.Boolean = true
- Whether to paint the caption when it fits within the visible region.
public ChartPlotRegion(ChartColor color, Double? xMinimum = null, Double? xMaximum = null, Double? yMinimum = null, Double? yMaximum = null, String label = "", Double opacity = 0.14, ChartAxisSide yAxis = Primary, Boolean showLabel = true) #Creates a region. A missing bound extends to that end of the selected axis domain.
Parameters
- color ChartForgeX.Primitives.ChartColor
- The solid background color.
- xMinimum System.Double? = null
- The inclusive lower X bound, or null for the domain minimum.
- xMaximum System.Double? = null
- The inclusive upper X bound, or null for the domain maximum.
- yMinimum System.Double? = null
- The inclusive lower Y bound, or null for the domain minimum.
- yMaximum System.Double? = null
- The inclusive upper Y bound, or null for the domain maximum.
- label System.String = ""
- An optional interior caption retained in semantic metadata.
- opacity System.Double = 0.14
- The fill opacity from zero through one.
- yAxis ChartForgeX.Core.ChartAxisSide = Primary
- The Y axis that owns the region's coordinates.
- showLabel System.Boolean = true
- Whether to paint the caption when it fits within the visible region.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public ChartColor? Color { get; } #Gets the authored literal fill color, or null when ChartPlotRegion.PaletteIndex selects a theme color.
public Int32? PaletteIndex { get; } #Gets the categorical palette index resolved at preparation, or null for a literal color.
public Double? XMinimum { get; } #Gets the authored lower X bound, or null for the domain minimum.
public Double? XMaximum { get; } #Gets the authored upper X bound, or null for the domain maximum.
public Double? YMinimum { get; } #Gets the authored lower Y bound, or null for the domain minimum.
public Double? YMaximum { get; } #Gets the authored upper Y bound, or null for the domain maximum.
public String Label { get; } #Gets the original caption, including when hidden, shortened or outside the domain.
public ChartAxisSide YAxis { get; } #Gets the Y axis that owns these data coordinates.
public Boolean ShowLabel { get; } #Gets whether to paint an interior caption when space permits.