Skip to main content

MapItem Class

#Declaration

TypeScript
export abstract class MapItem extends DataDashboardItem

#constructor

Initializes a new instance of the MapItem class.

#Declaration

TypeScript
constructor(
    modelJson?: any,
    serializer?: DevExpress.Analytics.Utils.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

TypeScript
area: ko.Observable<DevExpress.Dashboard.Model.ShapefileArea>

#Property Value

Type
Observable<ShapefileArea>

#customShapefile Property

Specifies a shapefile used to provide a custom map.

#Declaration

TypeScript
customShapefile: DevExpress.Dashboard.Model.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

TypeScript
interactivityOptions: DevExpress.Dashboard.Model.DashboardItemMasterFilterInteractivityOptions

#Property Value

Type
DashboardItemMasterFilterInteractivityOptions

#lockNavigation Property

#Declaration

TypeScript
lockNavigation: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#shapeTitleAttributeName Property

#Declaration

TypeScript
shapeTitleAttributeName: ko.Observable<string>

#Property Value

Type
Observable<string>

#tooltipMeasures Property

#Declaration

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

#Property Value

Type
ObservableArray<Measure>

#viewport Property

#Declaration

TypeScript
viewport: DevExpress.Dashboard.Model.MapViewport

#Property Value

Type
MapViewport