MapItem Class

Declaration

export abstract class MapItem extends DataDashboardItem

Inherited Members

DevExpress.Dashboard.Model.DataDashboardItem.componentName
DevExpress.Dashboard.Model.DataDashboardItem.customProperties
DevExpress.Dashboard.Model.DataDashboardItem.name
DevExpress.Dashboard.Model.DataDashboardItem.parentContainer
DevExpress.Dashboard.Model.DataDashboardItem.showCaption
DevExpress.Dashboard.Model.DataDashboardItem.getInfo
DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix

constructor

Initializes a new instance of the MapItem class.

Declaration

constructor(
    modelJson?: any,
    serializer?: ModelSerializer
)

Parameters

Name Type Description
modelJson 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

area Property

Declaration

area: ko.Observable<ShapefileArea>

Property Value

Type
Observable<ShapefileArea>

customShapefile Property

Specifies a shapefile used to provide a custom map.

Declaration

customShapefile: CustomShapefile

Property Value

Type Description
CustomShapefile

A CustomShapefile object that is a shapefile used to provide a custom map.

Remarks

Dashboard map items provide the capability to display maps within a dashboard. You can use the following options to display a map in the dashboard map item.

  • Select one of predefined maps that ship with the DevExpress Dashboard. Use the MapItem.area property to do this.
  • Set the MapItem.area property to ShapefileArea.Custom and use the CustomShapefile property to specify the existing shapefile.

There are two ways to provide a custom shapefile.

Note

Note that custom maps created in the Cartesian coordinate system are not supported.

interactivityOptions Property

Declaration

interactivityOptions: DashboardItemMasterFilterInteractivityOptions

Property Value

Type
DashboardItemMasterFilterInteractivityOptions

lockNavigation Property

Declaration

lockNavigation: ko.Observable<boolean>

Property Value

Type
Observable<boolean>

shapeTitleAttributeName Property

Declaration

shapeTitleAttributeName: ko.Observable<string>

Property Value

Type
Observable<string>

tooltipMeasures Property

Declaration

tooltipMeasures: ko.ObservableArray<Measure>

Property Value

Type
ObservableArray<Measure>

viewport Property

Declaration

viewport: MapViewport

Property Value

Type
MapViewport