Data Types
VertiGIS Studio Workflow uses of a variety of custom data types, described below.
DataRef
The DataRef data type represents a data object.
DataRef properties
|
type |
|
Type: String An indicator of the type of object, such as |
|
data |
|
Type: Object The data object. VertiGIS Studio Mobile does not use the "data" property like other viewers. Instead, the properties of the data are directly attached to the DataRef itself. |
DateRangeRef
The DateRangeRef data type represents a date range.
DateRangeRef properties
startDate |
Type: Date The lower end of the date range. The time is set to midnight local time, based on the user's time zone. |
endDate |
Type: Date The upper end of the date range. The time is set to midnight local time, based on the user's time zone. |
DateTimeRef
The DateTimeRef data type represents a date-time value.
DateTimeRef properties
format |
Type: "app" | "device" | { locale: string, timezone: string } References the date/time format criteria. If the value is "app" the workflow will use its own calendar. If the value is "device" the workflow will use the browser's native calendar. If the value is an object, the workflow will use its own calendar with the specified locale and timezone. |
display |
Type: String Indicates the display form for the date/time value. |
value |
Type: Number Indicates the value for the date/time value. |
DurationRef
The DurationRef data type represents a period of time.
DurationRef properties
unit |
Type: "d" | "h" | "m" | "s" | "ms" The unit of measure for the value. The value "d" represents days. The value "h" represents hours. The value "m" represents minutes. The value "s" represents seconds. The value "ms" represents milliseconds. |
value |
Type: Number The amount of time. |
FilesRef
The FilesRef data type represents files.
FilesRef properties
files |
Type: File[] Indicates the files. |
GeometryRef
The GeometryRef data type represents geometries.
GeometryRef properties
format |
Type: "polygon" | "polyline" | "point" | "polygon-freehand" | "polyline-freehand" | "extent" | "line" Indicates the format of the value. |
geometry |
Type: esri.Geometry[] (3.x, 4.x)* Indicates the geometries. |
* VertiGIS Studio Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of host application. See Underlying Technologies for information.
ItemsRef
The ItemsRef data type represents form element items.
ItemsRef properties
items |
Type: Item[] The selected items. |
MapInfo
The MapInfo data type represents information about a map, such as the map's scale and extent.
MapInfo methods
getCenter() |
Gets the center of the map. |
getExtent() |
Gets the extent of the map. |
getScale() |
Type: Number Gets the scale of the map. |
getSpatialReference() |
Type: esri.SpatialReference (3.x, 4.x)* Gets the map's spatial reference. |
* VertiGIS Studio Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of host application. See Underlying Technologies for information.
MarkdownRef
The MarkdownRef data type represents text that is formatted using Markdown.
MarkdownRef properties
markdown |
Type: String A string to be parsed as markdown. |
NumberFormat
The NumberFormat data type represents the format criteria for NumberRef values.
NumberFormat properties
lowerBound |
Type: Number Indicates the lower bound. |
upperBound |
Type: Number Indicates the upper bound. |
step |
Type: Number Indicates the step size. The step size is the amount to increment or decrement. |
precision |
Type: Number Indicates the minimum increment or decrement as well as the precision of values. |
NumberRef
The NumberRef data type represents a number with a display format.
NumberRef properties
format |
Type: NumberFormat Indicates the format of the value. |
display |
Type: String Indicates the display value. |
numeric |
Type: Number Indicates the numeric value. |
ScanRef
The ScanRef data type represents a scanned value.
ScanRef properties
scanType |
Type: "barcode" | "qrcode" | Indicates the type of code that was scanned. If the code was typed, then |
entryMethod |
Type: "camera" | "manual" Indicates the method used to enter the code, either scanned by the device's camera or entered manually by the user. |
value |
Type: String Indicates the value of the code that was scanned or entered manually. |
SignatureRef
The SignatureRef data type represents a user's signature.
SignatureRef properties
dataUrl |
Type: String A Data URL describing the image as a PNG. |
file |
Type: File A File object for a PNG image of the signature. |
Text
The Text data type accepts either a String (plain text) or a value of type MarkdownRef.
WebmapPrintParameters
The WebmapPrintParameters data type represents the information this is required for including a map in a report.
WebmapPrintParameters properties
extent |
The extent of the map in the WGS84 (4326) spatial reference. |
mapName |
Type: String The name of the map control in the report or print template. |
scale |
Type: Number The scale of the map in the report or print template. |
webmap |
Type: Object The webmap. |
* VertiGIS Studio Workflow uses different versions of Esri's ArcGIS API for JavaScript depending on the type of host application. See Underlying Technologies for information.