Type alias KpiTitleStyleOptions

KpiTitleStyleOptions: object

Configuration that defines styling of the KPI card title.

Type declaration

align

align?: KpiTitleAlign

Horizontal alignment of the title section's content — the title text and the category caption.

Default

'space-between'

enabled

enabled?: boolean

Boolean flag that defines whether the whole title section (title text and category caption) is shown.

Default

true

showCategoryTitle

showCategoryTitle?: boolean

Boolean flag that defines whether the current category bucket caption (e.g. 'DEC 2013' for a date category, or the bucket's own text — 'FEMALE' — for one that isn't) is shown within the title section. Applicable when KpiChartDataOptions.category is set.

Default

true

showValueTitle

showValueTitle?: boolean

Boolean flag that defines whether the title text (the text override, or the value measure's title) is shown within the title section.

Default

true

text

text?: string

Title text.

Default

the value measure's title

textStyle

textStyle?: KpiTextStyle

Typography of the title text (not the category caption).

The default uppercase rendering comes with a 0.06em letter-spacing; any other textTransform renders with normal letter-spacing.

Default

{ fontWeight: '600', fontStyle: 'normal', textTransform: 'uppercase' } with the theme font