This is the documentation of version 0.58.1. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Variable AREA_ANALYTICS_DEFAULTSConst

    AREA_ANALYTICS_DEFAULTS: {
        activeMetric: "congestionLevel";
        displayMode: "hexgrid-3d";
        metricConfig: {
            congestionLevel: {
                color: {
                    stops: (
                        | { color: "#2dc653"; value: number }
                        | { color: "#f5a623"; value: number }
                        | { color: "#e03030"; value: number }
                    )[];
                    valueType: "raw";
                };
                height: {
                    maxHeightMeters: number;
                    minHeightMeters: number;
                    scaleMode: "predefinedRange";
                };
            };
            freeFlowSpeed: {
                color: {
                    stops: (
                        | { color: "#e03030"; value: number }
                        | { color: "#f5a623"; value: number }
                        | { color: "#2dc653"; value: number }
                    )[];
                    valueType: "relativeToPredefinedRangePCT";
                };
                height: {
                    maxHeightMeters: number;
                    minHeightMeters: number;
                    scaleMode: "predefinedRange";
                };
            };
            networkLength: {
                color: {
                    stops: (
                        | { color: "#2dc653"; value: number }
                        | { color: "#f5a623"; value: number }
                        | { color: "#e03030"; value: number }
                    )[];
                    valueType: "relativeToActualRangePCT";
                };
                height: {
                    maxHeightMeters: number;
                    minHeightMeters: number;
                    scaleMode: "currentRange";
                };
            };
            speed: {
                color: {
                    stops: (
                        | { color: "#e03030"; value: number }
                        | { color: "#f5a623"; value: number }
                        | { color: "#2dc653"; value: number }
                    )[];
                    valueType: "relativeToPredefinedRangePCT";
                };
                height: {
                    maxHeightMeters: number;
                    minHeightMeters: number;
                    scaleMode: "predefinedRange";
                };
            };
            travelTime: {
                color: {
                    stops: (
                        | { color: "#2dc653"; value: number }
                        | { color: "#f5a623"; value: number }
                        | { color: "#e03030"; value: number }
                    )[];
                    valueType: "relativeToPredefinedRangePCT";
                };
                height: {
                    maxHeightMeters: number;
                    minHeightMeters: number;
                    scaleMode: "predefinedRange";
                };
            };
        };
        regionPolygon: {
            fillOpacity: number;
            inverted: false;
            outlineOpacity: number;
            outlineWidth: number;
        };
        visible: true;
    } = ...

    Default values for all TrafficAreaAnalyticsModuleConfig options.

    Use these as a reference for what the module applies when a property is omitted, or spread them as a base when constructing a config programmatically.

    Type Declaration

    • activeMetric: "congestionLevel"
    • displayMode: "hexgrid-3d"
    • metricConfig: {
          congestionLevel: {
              color: {
                  stops: (
                      | { color: "#2dc653"; value: number }
                      | { color: "#f5a623"; value: number }
                      | { color: "#e03030"; value: number }
                  )[];
                  valueType: "raw";
              };
              height: {
                  maxHeightMeters: number;
                  minHeightMeters: number;
                  scaleMode: "predefinedRange";
              };
          };
          freeFlowSpeed: {
              color: {
                  stops: (
                      | { color: "#e03030"; value: number }
                      | { color: "#f5a623"; value: number }
                      | { color: "#2dc653"; value: number }
                  )[];
                  valueType: "relativeToPredefinedRangePCT";
              };
              height: {
                  maxHeightMeters: number;
                  minHeightMeters: number;
                  scaleMode: "predefinedRange";
              };
          };
          networkLength: {
              color: {
                  stops: (
                      | { color: "#2dc653"; value: number }
                      | { color: "#f5a623"; value: number }
                      | { color: "#e03030"; value: number }
                  )[];
                  valueType: "relativeToActualRangePCT";
              };
              height: {
                  maxHeightMeters: number;
                  minHeightMeters: number;
                  scaleMode: "currentRange";
              };
          };
          speed: {
              color: {
                  stops: (
                      | { color: "#e03030"; value: number }
                      | { color: "#f5a623"; value: number }
                      | { color: "#2dc653"; value: number }
                  )[];
                  valueType: "relativeToPredefinedRangePCT";
              };
              height: {
                  maxHeightMeters: number;
                  minHeightMeters: number;
                  scaleMode: "predefinedRange";
              };
          };
          travelTime: {
              color: {
                  stops: (
                      | { color: "#2dc653"; value: number }
                      | { color: "#f5a623"; value: number }
                      | { color: "#e03030"; value: number }
                  )[];
                  valueType: "relativeToPredefinedRangePCT";
              };
              height: {
                  maxHeightMeters: number;
                  minHeightMeters: number;
                  scaleMode: "predefinedRange";
              };
          };
      }
    • regionPolygon: {
          fillOpacity: number;
          inverted: false;
          outlineOpacity: number;
          outlineWidth: number;
      }

      AreaAnalyticsRegionPolygonConfig color is omitted — the layer builders apply a theme-adaptive default.

    • visible: true