BadgeStyleDefinition

Defines a Badge Style

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
ExpressionAdaptableBooleanQuery
IconPropertiesBadgeIconPropertiesSettings for Icon to display alongside badge text
PillStyleBadgePillStyleStyle for the Badge pill (cut-down version of Adaptable Style)
PredicateBadgeStylePredicateOptional Rule for deciding whether Badge is displayed
ShapeBadgeShapeVisual shape of the Badge's corner radius'Rounded'

Property Details

Expression

TypeScript
Expression?: AdaptableBooleanQuery;
Property Value

AdaptableBooleanQuery

IconProperties

Settings for Icon to display alongside badge text

TypeScript
IconProperties?: BadgeIconProperties;
Property Value

BadgeIconProperties

PillStyle

Style for the Badge pill (cut-down version of Adaptable Style)

TypeScript
PillStyle?: BadgePillStyle;
Property Value

BadgePillStyle

Predicate

Optional Rule for deciding whether Badge is displayed

TypeScript
Predicate?: BadgeStylePredicate;
Property Value

BadgeStylePredicate

Shape

Visual shape of the Badge's corner radius

TypeScript
Shape?: BadgeShape;
Default Value

'Rounded'

Property Value

BadgeShape