Skip to main content
Table of Contents

TTMSFNCDataGridDataBarSettings Class

Data-bar configuration used by a grtDataBar rule, painted as a cell overlay.

API unit family: TMSFNCDataGridConditionalFormatting Inherits from: TPersistent

Syntax

GeneratedPascalC++
TTMSFNCDataGridDataBarSettings = class(TPersistent)

class PASCALIMPLEMENTATION TTMSFNCDataGridDataBarSettings : public System::Classes::TPersistent

Remarks

Owned by TTMSFNCDataGridFormatRuleItem.DataBar; never free it yourself. Raises OnChange whenever a setting (including a change inside Fill, NegativeFill or Border) changes so the owning rule can invalidate its cells.

The bar spans from the zero axis to the cell value within the range resolved from MinKind/MinValue and MaxKind/MaxValue; the computed fractions are reported in TTMSFNCDataGridOverlayInfo. Only numeric cells get a bar.

Properties

Name Description
Border The stroke used to outline the bar. Default is a solid gcDarkgray stroke.
Direction The direction the bar grows from its origin. Default is bdLeftToRight.
Fill The fill used to paint the bar for non-negative values. Default is a solid gcDodgerblue fill.
MaxKind How MaxValue is interpreted when computing the bar's high bound. Default is bbkAuto.
MaxValue The literal number, percentage, or percentile used for the bar's high bound, depending on MaxKind. Default is 0.
MinKind How MinValue is interpreted when computing the bar's low bound. Default is bbkAuto.
MinValue The literal number, percentage, or percentile used for the bar's low bound, depending on MinKind. Default is 0.
NegativeFill The fill used to paint the bar for negative values, which extend to the other side of the zero axis. Default is a solid gcRed fill.
ShowBarOnly When True, only the bar is drawn, filling the full cell height, and the cell's text, background fill and border are suppressed. Default is False.
ShowValue When True, the cell's text value stays visible and the bar is drawn as a thin strip along the bottom of the cell. Default is True.

Events

Name Description
OnChange Occurs after any published setting changes, including changes inside the fills and the border.

Used by