Back to Devexpress

BoundImageItem Class

dashboard-js-devexpress-dot-dashboard-dot-model-c4d9e649.md

latest7.4 KB
Original Source

BoundImageItem Class

A Bound Image dashboard item.

Declaration

ts
export class BoundImageItem extends DataDashboardItem

Remarks

The Bound Image dashboard item can be bound to a set of images (for instance, stored in the database or accessible by the specified URI). You can use the Bound Image as a detail item along with the Master Filtering feature.

To learn how to create and fine-tune the Bound Image on the web, see the Web Dashboard - Images topic.

Inherited Members

colorScheme

coloringOptions

componentName

customProperties

dataItems

dataMember

dataSource

disposed

filterString

formatRules

hiddenDimensions

hiddenMeasures

isDisposed

isMasterFilterCrossDataSource

itemType

name

parentContainer

showCaption

visibleDataFilterString

dispose

getInfo

getUniqueNamePrefix

Inheritance

SerializableModel TypedSerializableModel DashboardItem DataDashboardItem BoundImageItem

constructor

Initializes a new instance of the BoundImageItem class.

Declaration

ts
constructor(
    dashboardItemJSON?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

Parameters

NameTypeDescription
dashboardItemJSONany

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

dataBindingMode Property

Declaration

ts
dataBindingMode: ko.Observable<DevExpress.Dashboard.Model.ImageDataBindingMode>

Property Value

Type
Observable<ImageDataBindingMode>

horizontalAlignment Property

Declaration

ts
horizontalAlignment: ko.Observable<string>

Property Value

Type
Observable<string>

imageAltTextItem Property

Specifies the dimension that provides data for the BoundImageItem alt text.

Declaration

ts
imageAltTextItem: ko.Observable<DevExpress.Dashboard.Model.Dimension>

Property Value

TypeDescription
Observable<Dimension>

A Dimension object that provides data for the BoundImageItem alt text.

|

Remarks

You can specify the alternative text that depends on the selected dimension. Alt text makes images accessible to users who cannot see them, especially those using screen readers.

For information on how to set alt text in the UI, refer to the following help topic: Add Alternative Text for Image and Bound Image Items in Web.

imageItem Property

Declaration

ts
imageItem: ko.Observable<DevExpress.Dashboard.Model.Dimension>

Property Value

Type
Observable<Dimension>

interactivityOptions Property

Declaration

ts
interactivityOptions: DevExpress.Dashboard.Model.DashboardItemBaseInteractivityOptions

Property Value

Type
DashboardItemBaseInteractivityOptions

sizeMode Property

Declaration

ts
sizeMode: ko.Observable<string>

Property Value

Type
Observable<string>

uriPattern Property

Declaration

ts
uriPattern: ko.Observable<string>

Property Value

Type
Observable<string>

verticalAlignment Property

Declaration

ts
verticalAlignment: ko.Observable<string>

Property Value

Type
Observable<string>