The requested page is not available for the requested platform. You are viewing the content for Default platform.

ChoroplethMapItem Class

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

Declaration

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

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

Optional Parameters

Name Type Default Description
modelJson any null

A JSON object used for a dashboard deserialization. Do not pass this parameter directly.

serializer DxDesigner.Analytics.Utils.ModelSerializer null

An object used for a dashboard deserialization. Do not pass this parameter directly.

Properties

attributeDimension Property

Declaration

attributeDimension: ko.Observable<Dimension>

Property Value

Type Description
ko.Observable<Dimension>

attributeName Property

Declaration

attributeName: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

choroplethMapTypesMap Property

Declaration

static choroplethMapTypesMap: {
    "ValueMap": {
        constructor: typeof ValueMap;
        displayName: string;
        icon: string;
    };
    "DeltaMap": {
        constructor: typeof DeltaMap;
        displayName: string;
        icon: string;
    };
}

Property Value

Type Description
{constructor: DeltaMap, displayName: string, icon: string}
{constructor: ValueMap, displayName: string, icon: string}

includeSummaryValueToShapeTitle Property

Declaration

includeSummaryValueToShapeTitle: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

maps Property

Declaration

maps: ko.ObservableArray<ChoroplethMap>

Property Value

Type Description
ko.ObservableArray<ChoroplethMap>

tooltipAttributeName Property

Declaration

tooltipAttributeName: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray