CustomShapefile Class

A custom shapefile that is used to provide a map for the map dashboard items (such as Choropleth or Geo Point maps).

Declaration

export class CustomShapefile extends SerializableModel

Remarks

To load the existing shapefile, set the MapItem.area property to js-DevExpress.Dashboard.Model.ShapefileArea.Custom and use the MapItem.customShapefile property. There are two ways to provide the custom shapefile.

• Use the CustomShapefile.Url property to specify the path to the shapefile.
• Create the CustomShapefileData object, specify its CustomShapefileData.shapeData and CustomShapefileData.attributeData (optionally) properties and assign this object to the CustomShapefile.data property.

constructor

Initializes a new instance of the CustomShapefile class.

Declaration

constructor(
    modelJson?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer
)

Parameters

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

data Property

Declaration

data: CustomShapefileData

Property Value

Type
CustomShapefileData

url Property

Declaration

url: ko.Observable<string>

Property Value

Type
Observable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationInfoArray