The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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.

Inheritance

MapItem
ChoroplethMapItem

constructor

Initializes a new instance of the ChoroplethMapItem class.

Declaration

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

Optional Parameters

Type Name Default Description
any modelJson null

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

DxDesigner.Analytics.Utils.ModelSerializer serializer null

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

Properties

attributeDimension Property

Declaration

attributeDimension: KnockoutObservable<Dimension>

Property Value

Type Description
KnockoutObservable<Dimension>

attributeName Property

Declaration

attributeName: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<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: KnockoutObservable<boolean>

Property Value

Type Description
KnockoutObservable<boolean>

maps Property

Declaration

maps: KnockoutObservableArray<ChoroplethMap>

Property Value

Type Description
KnockoutObservableArray<ChoroplethMap>

tooltipAttributeName Property

Declaration

tooltipAttributeName: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationsInfo