TextBoxItem Class
A Text Box dashboard item used to display rich text within a dashboard.
Declaration
export class TextBoxItem extends DataDashboardItemRemarks
The Text Box dashboard item can display static or data-bound text with rich formatting.
For example, the “Bug Count” text box displays summarized bug report information. The key performance indicators also serve as a color legend for the Chart dashboard item:
You can enable the Text Editor functionality to edit the Text Box content in the pop-up editor. See TextBoxItemEditorExtension for details.
The following documentation is available: Text Box.
Inherited Members
Inheritance
constructor
Initializes a new instance of the TextBoxItem class.
Declaration
constructor(
dashboardItemJSON?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)Parameters
| Name | Type | Description |
|---|---|---|
| dashboardItemJSON | any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
| serializer | ModelSerializer | An object used for dashboard deserialization. Do not pass this parameter directly. |
Properties
interactivityOptions Property
Provides access to the interactivity options of the TextBoxItem.
Declaration
interactivityOptions: DashboardItemBaseInteractivityOptionsProperty Value
| Type | Description |
|---|---|
| DashboardItemBaseInteractivityOptions | A DashboardItemBaseInteractivityOptions object that defines interactivity options. |
text Property
Specifies a string that is a text box item content as a plain text.
Declaration
text: ko.Observable<string>Property Value
| Type | Description |
|---|---|
| Observable<string> | A string that contains a text box item content as a plain text. |
values Property
Gets the collection of measures that provide data used to calculate values displayed in the current TextBoxItem.
Declaration
values: ko.ObservableArray<Measure>Property Value
| Type | Description |
|---|---|
| ObservableArray<Measure> | A collection of measures that provide data used to calculate values displayed in the current TextBoxItem. |
Methods
getInfo Method
For internal use.
Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArrayReturns
| Type | Description |
|---|---|
| ISerializationInfoArray | An array of objects that provide serialization info. |