TextDefinitionCollection / PartialTextDefinitionCollection

Description

A TextDefinitionCollection represents a collection of key/value pairs, where key is a string used to identify the corresponding TextDefinition. It extends ResourceCollection<T>.

Properties

Property

Element

Type

Description

key

 

string

The identifier of the TextDefinition.

 

value

TextDefinition

Represent a text to customize.

Supported values

A this time, the following text elements can be customized:

Key

Default value

Target element

group-by-panel-empty

“Drag a column here to group”

GroupByPanel.

group-header-title-singular-form

“item”

The group title part of the GroupHeader

group-header-title-plural-form

“items”

The group title part of the GroupHeader

paginator-text-area-page-part

“page”

The "page" text part of the Paginator

paginator-text-area-of-part

“of”

The "of" text part of the Paginator

stat-result-not-supported

“N/A”

The aggregate is not supported by the DataProvider

stat-result-not-available

“N/A”

The "N/A" text when stat calculation cannot be done

stat-result-divide-by-zero

“DIV/0”

The "DIV/0" text when the stat calculation divides a value by 0

Example

const textDefinitions = {

  "group-by-panel-empty": { text: "Please drag a column here to group" },

};

Remarks

A partial type/interface is an object in which properties are optional.