TextBoxItem Class
A Text Box dashboard item used to display rich text within a dashboard.
Declaration
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.
The following documentation is available: Web Dashboard - Creating a Text Box.
Inherited Members
DevExpress.Dashboard.Model.DataDashboardItem.componentName
DevExpress.Dashboard.Model.DataDashboardItem.name
DevExpress.Dashboard.Model.DataDashboardItem.parentContainer
DevExpress.Dashboard.Model.DataDashboardItem.showCaption
DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix
Inheritance
DataDashboardItem
TextBoxItem
constructor
Initializes a new instance of the TextBoxItem
class.
Declaration
constructor(
dashboardItemJSON?: any,
serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)
Parameters
Name | Type | Description |
---|---|---|
dashboardItemJSON | any | A JSON object used for a dashboard deserialization. Do not pass this parameter directly. |
serializer | DxDesigner.Analytics.Utils.ModelSerializer | An object used for a dashboard deserialization. Do not pass this parameter directly. |
Properties
interactivityOptions Property
Declaration
interactivityOptions: DashboardItemBaseInteractivityOptions
Property Value
Type |
---|
DashboardItemBaseInteractivityOptions |
text Property
Declaration
text: ko.Observable<string>
Property Value
Type |
---|
Observable<string> |
values Property
Declaration
values: ko.ObservableArray<Measure>
Property Value
Type |
---|
ObservableArray<Measure> |
Methods
getInfo Method
For internal use.
Declaration
getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray
Returns
Type | Description |
---|---|
DxDesigner.Analytics.Utils.ISerializationInfoArray |
|