Skip to main content

ChoroplethMapItem Class

A Choropleth Map dashboard item that colors areas depending on the provided values.

#Declaration

TypeScript
export class ChoroplethMapItem extends MapItem

#Remarks

The Choropleth Map dashboard item allows you to colorize required areas in proportion to the provided values. For instance, you can visualize a sales amount or population density.

wdd-dashboard-items-choropleth-map

See Web Dashboard - Creating a Choropleth Map to learn more about the Choropleth Map.

#constructor

Initializes a new instance of the ChoroplethMapItem 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

#attributeDimension Property

#Declaration

TypeScript
attributeDimension: ko.Observable<DevExpress.Dashboard.Model.Dimension>

#Property Value

Type
Observable<Dimension>

#attributeName Property

#Declaration

TypeScript
attributeName: ko.Observable<string>

#Property Value

Type
Observable<string>

#choroplethMapTypesMap Property

#Declaration

TypeScript
static choroplethMapTypesMap: {
    ValueMap: {
        constructor: typeof DevExpress.Dashboard.Model.ValueMap;
        displayName: string;
        icon: string;
    };
    DeltaMap: {
        constructor: typeof DevExpress.Dashboard.Model.DeltaMap;
        displayName: string;
        icon: string;
    };
}

#Property Value

Name Type
DeltaMap {constructor: typeof DeltaMap, displayName: string, icon: string}
ValueMap {constructor: typeof ValueMap, displayName: string, icon: string}

#includeSummaryValueToShapeTitle Property

#Declaration

TypeScript
includeSummaryValueToShapeTitle: ko.Observable<boolean>

#Property Value

Type
Observable<boolean>

#maps Property

#Declaration

TypeScript
maps: ko.ObservableArray<DevExpress.Dashboard.Model.ChoroplethMap>

#Property Value

Type
ObservableArray<ChoroplethMap>

#tooltipAttributeName Property

#Declaration

TypeScript
tooltipAttributeName: ko.Observable<string>

#Property Value

Type
Observable<string>