SharinPix Documentation

SharinPix documentation

SharinPix Map To Album

Note:

This component is dependent on the SharinPix Map component.
Click here for more information on the SharinPix Map component.

The SharinPix Map To Album component permits the extraction of a Map as an image from the SharinPix Map component and save it in a specific SharinPix album.

Information:

This feature is only available on Lightning. It can be used on:

On Page Builder
On Desktop
In Flows (but not in Field Service Mobile Flow)
In Salesforce Community
In your own Lightning Component development

Getting Started

To use the SharinPix Map To Album component, you simply need to drag and drop the component from the Lightning App Builder onto your page layout.

Lightning Component Parameters

Generate Map Button Label: Used to specify the button's label. The default value is Export Map to Album.
Map Record Id Field API Name: API name of field containing the record ID of the object from which the map data will be retrieved. Leave blank to use current object record's ID.
Map Data Field API Name: Map Data Field API name used to store Google Maps data. The map will be generated with data saved in this field if it is available. The value entered in this field should be the same as the SharinPix Map's Map Data Field API Name.
Map Type: The type of map to be exported (roadmap, satellite, hybrid, terrain).
Album ID: Used to specify the album ID to which images will be saved. To use the current record ID, leave this field blank.
Polygon Options: Options to apply to polygon objects. Value should be in JSON object format. Leave blank for none. Example:

{ "strokeColor": "Green", "strokeOpacity": 0.8, "strokeWeight": 2, "fillColor": "Yellow", "fillOpacity": 0.35, "labelColor": "Red", "fontSize": "20px" }

Marker Options: The marker's appearance. The value entered in this field should be in a JSON format as demonstrated in the example below:
{ "size": 5, "showLabel": true, "defaultColor": "#ff4646" }

Note: The marker label is configured only in the Marker Options (JSON) parameter. Here, the actual marker label name is retrieved from the map data.

Tag: The tag to be applied on all images generated from the SharinPix Map to Album component. For no tag application, leave this field blank.
Component ID: Component ID to be matched by SharinPix components on the page. This is any text which will be common between this component and the SharinPix Album component. It allows for matching components to communicate in case some components need to be repeated on the same record page. Example: Set 'sharinpix-1' as Target Component ID here and also on SharinPix Album component's Component ID field.

Note:

For a map image to be inserted in the SharinPix Album automatically, you need to make sure that the ComponentId of this component and that of SharinPix Album have the same value.
For the SharinPix Image Sync feature to be activated on the destination album when the image is exported from the Map to Album component, you should specify a value for the Component ID parameter on the Map to Album component and use the same value for the SharinPix Album's Component ID parameter.