EclairGeoData

Represents an Analytics custom map chart. Custom maps are user-defined maps that are uploaded to Analytics and are used just as standard maps are. Custom maps are accessed in Analytics from the list of maps available with the map chart type.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type 

This type extends MetadataWithContent and inherits its fields.

File Suffix and Directory Location 

EclairGeoData components have the suffix geodata and are stored in the eclair folder.

Version 

Introduced in API version 39.0.

Fields 

maps 

  • Type: EclairMap[]
  • Required: No
  • Description: A list of EclairMap objects. Each EclairMap object specifies the bounding box (if any) and the map name that appears in the user interface.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. Label for this object. This display value is the internal label that is not translated.

EclairMap Type 

Fields 

boundingBoxBottom 

  • Type: double
  • Required: No
  • Description: When bounding-box coordinates are used, this contains the bottom coordinate.

boundingBoxLeft 

  • Type: double
  • Required: No
  • Description: When bounding-box coordinates are used, this contains the left side coordinate.

boundingBoxRight 

  • Type: double
  • Required: No
  • Description: When bounding-box coordinates are used, this contains the right side coordinate.

boundingBoxTop 

  • Type: double
  • Required: No
  • Description: When bounding-box coordinates are used, this contains the top coordinate.

mapLabel 

  • Type: string
  • Required: No
  • Description: Required. The user-interface name of the map. This name appears in the maps list for the map chart in Analytics.

mapName 

  • Type: string
  • Required: Yes
  • Description: Required. Label for this object. This display value is the internal label that is not translated.

projection 

  • Type: string

  • Required: Yes

  • Description: Required. The type of map projection used to create the map. Valid values are:

    • Equirectangular
    • Mercator
    • AlbersUSA

Declarative Metadata Sample Definition 

The following is an example of an EclairGeoData component:

1<EclairGeoData xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2            <content xsi:nil="true"/>            
3            <maps>              
4              <boundingBoxBottom>0.0</boundingBoxBottom>              
5              <boundingBoxLeft>100.0</boundingBoxLeft>              
6              <boundingBoxRight>100.0</boundingBoxRight>              
7              <boundingBoxTop>0.0</boundingBoxTop>              
8              <mapLabel>WorldMap0 Label</mapLabel>              
9              <mapName>WorldMap0</mapName>              
10              <projection>Equirectangular</projection>
11            </maps>
12            <maps>
13              <boundingBoxBottom>1.0</boundingBoxBottom>
14              <boundingBoxLeft>101.0</boundingBoxLeft>
15              <boundingBoxRight>101.0</boundingBoxRight>
16              <boundingBoxTop>1.0</boundingBoxTop>
17              <mapLabel>WorldMap1 Label</mapLabel>
18              <mapName>WorldMap1</mapName>
19              <projection>Mercator</projection>
20            </maps>
21            <masterLabel>WorldMapGeoDataToCreate Label</masterLabel>
22          </EclairGeoData>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2        <Package xmlns="http://soap.sforce.com/2006/04/metadata">
3          <types>
4            <members>*</members>
5            <name>EclairGeoData</name>
6          </types>
7          <version>39.0</version>
8        </Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.