CustomShapefile Class
In This Article
A custom shapefile that is used to provide a map for the map dashboard items (such as Choropleth or Geo Point maps).
#Declaration
TypeScript
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.
#Inheritance
SerializableModel
CustomShapefile
#constructor
Initializes a new instance of the CustomShapefile
class.
#Declaration
TypeScript
constructor(
modelJson?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
#Parameters
Name | Type | Description |
---|---|---|
model |
any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
An object used for dashboard deserialization. Do not pass this parameter directly. |
#Properties
#data Property
#Declaration
TypeScript
data: DevExpress.Dashboard.Model.CustomShapefileData
#Property Value
Type |
---|
Custom |
#url Property
#Declaration
TypeScript
url: ko.Observable<string>
#Property Value
Type |
---|
Observable<string> |
#Methods
#getInfo Method
For internal use.
#Declaration
TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |