store Method

An object with properties that control the store operation. These properties are:

ignoreMapError — When true, errors that occur while updating the map in the diagram will be ignored. When a map update error occurs and this option is enabled, the stored diagram will not include the map.
The default value is false.

image — When true, a Base64 encoded image of the current diagram will be generated along with the diagram SVG string. This image will be returned via the onSuccess callback along with the SVG string.
The default is false.

includeFieldMeasurements — When set to true, shapes from the measurement layer will be included in the stored SVG and the generated image -- a JSON formatted string that contains the data values from the measurement layer will also be returned in the "diagram info" hash which is the second argument passed to the onSuccess callback.
If not specified, the corresponding value defined in userSettings will be used.

includeAttachments — When set to true, attachments will be visible in the stored diagram.
If not specified, the corresponding value defined in userSettings will be used.

includeViews — When set to true, views will be included in the stored diagram.
The default is true.

skipIfBusy — When true, the store will be skipped if the user is in the middle of a diagram update operation; I.E., drawing a shape, dragging in a new shape, moving shaped, etc. When the store is skipped, undefined will be returned via the onSuccess callback function instead of a diagram SVG string and information about the diagram. When false, any diagram update in progress will be aborted before saving the diagram.
The default is false.

This function will be called when diagram store completes successfully. It will be passed two parameters:

1. The stored diagram SVG string.
2. An object containing information related to the diagram. This object may include these properties:
   • image: a string containing a Base64 encoded image of the stored diagram. This is present when the image option is true. The image will have the format specified by the format option.
   • fieldMeasurements: an object containing the measurement data. This is present when the option includeFieldMeasurements is true. Here is an example of measurement data:

     {
       units: "feetAndInches",
       stationLines: [
     	{
     	  stationLineIncrement: 0,
     	  formattedStationLineIncrement: "0'",
     	  markers: [
     		{
     		  id: "1",
     		  description: "Station Line One",
     		  station: 10,
     		  formattedStation: "10'",
     		  distance: 10,
     		  formattedDistance: "10'",
     		  direction: "R"
     		}
     	  ]
     	}
       ],
       triangulationMeasurements: {
     	markerPoints: [
     	  {
     		id: "1",
     		description: "Measurement Point One",
     		refPt1: "A",
     		refPt2: "B",
     		distance1: 20,
     		formattedDistance1: "20'",
     		distance2: 20,
     		formattedDistance2: "20'",
     		direction: "L"
     	  }
     	]
       }
     }
     									

     Note: the measurement layer data includes formatted and numeric versions of length and distance values.
     
   • location: When a location defined for the diagram, an object containing the geographic center of the diagram. This is an object specifying a geographic location with the following properties:

     latitude: Number +/-90

     longitude: Number +/-180

   • vehicleData: an object containing information about the vehicle symbols in the diagram with attached metadata. Vehicles have attached metadata when they are defined via the editor property vehicleData. Metadata can be entered for vehicles symbols through the symbol property dialog. Here is an example of vehicle data:

     [
         {
             data: [
                 { name "VIN", value: "1G1YW2DW0A1JB9MJ9" },
                 { name "Type", value: "Coupe" },
                 { name "Year", value: "2010" },
                 { name "Make", value: "CHEVROLET" },
                 { name "Model", value: "Corvette" },
                 { name "Color", value: "green"
                 }
             ],
             location: {
     			latitude: 43.615789240432335, longitude: -116.20161872458031
             }
         },
         {
             data: [
                 { name "VIN", value: "JN1BZ36D69L7HLX6H" },
                 { name "Type", value: "Convertible/Cabriolet" },
                 { name "Year", value: "2009" },
                 { name "Make", value: "NISSAN" },
                 { name "Model", value: "350Z" },
                 { name "Color", value: "silver"
                 }
             ],
             location: {
     			latitude: 43.615790109279985, longitude: -116.20154530304812
             }
         },
         {
             data: [
                 { name "VIN", value: "4S6CK58W12U4HNUEM" },
                 { name "Type", value: "Sport Utility Vehicle (SUV)/M" },
                 { name "Year", value: "2002" },
                 { name "Make", value: "HONDA" },
                 { name "Model", value: "Passport" },
                 { name "Color", value: "black"
                 }
             ],
             location: {
     			latitude: 43.61579131999581, longitude: -116.20170057828369
             }
         }
     ]
     						

A function that accepts one parameter, an Error object. This function will be called if the store fails. The passed Error object indicates the nature of the failure. This function may return true to indicate that the error has been handled. If the function does not return true, the error will be passed on to the built-in error handler.