Skip to main content

TextBoxItem Class

A Text Box dashboard item used to display rich text within a dashboard.

#Declaration

TypeScript
export class TextBoxItem extends DataDashboardItem

#Remarks

The Text Box dashboard item is used to display rich text within a dashboard. You can either add a static text or you can use the Text Box as a detail item along with the Master Filtering feature.

wdd-text-box-rtf-example

The following documentation is available: Web Dashboard - Creating a Text Box.

#constructor

Initializes a new instance of the TextBoxItem class.

#Declaration

TypeScript
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

#Declaration

TypeScript
interactivityOptions: DevExpress.Dashboard.Model.DashboardItemBaseInteractivityOptions

#Property Value

Type
DashboardItemBaseInteractivityOptions

#text Property

#Declaration

TypeScript
text: ko.Observable<string>

#Property Value

Type
Observable<string>

#values Property

#Declaration

TypeScript
values: ko.ObservableArray<DevExpress.Dashboard.Model.Measure>

#Property Value

Type
ObservableArray<Measure>