TTMSFNCDataGridOverlayInfo Record
Result of an overlay query for one cell. A renderer paints a data bar or an icon glyph from the values in this record, using the visual settings on
Rule.
API unit family: TMSFNCDataGridConditionalFormatting
Syntax
TTMSFNCDataGridOverlayInfo = record
Remarks
Returned by TTMSFNCDataGridConditionalFormatting.GetOverlayInfo. Only the fields relevant to Kind are meaningful.
Fields and properties
| Name | Type | Description |
|---|---|---|
AxisFraction |
Double |
For a data bar, the normalized position (0..1) of the zero axis. |
BarFraction |
Double |
For a data bar, the normalized distance (0..1) from the zero axis to the value. |
Fraction |
Double |
For a data bar, the fraction (0..1) of the bar's axis-extended value range that the cell value fills. |
IconCount |
Integer |
For an icon set, the number of glyphs in the selected icon family. |
IconIndex |
Integer |
For an icon set, the zero-based index of the icon to draw, where 0 is the lowest band. |
Kind |
TTMSFNCDataGridOverlayKind |
The kind of overlay to paint (data bar, icon set, or none). |
Negative |
Boolean |
For a data bar, True when the cell value is negative. |
Rule |
TTMSFNCDataGridFormatRuleItem |
The rule that produced this overlay, carrying the DataBar / IconSet visual settings. |