Data Functions

A set of convenient functions for working with and manipulating various types of data values.

Attachments - Console - Count - Dictionary - Distinct - Domain - DomainCode - DomainName - Feature - FeatureSet - FeatureSetByAssociation - FeatureSetById - FeatureSetByName - FeatureSetByPortalItem - FeatureSetByRelationshipName - Filter - First - GroupBy - Guid - HasKey - IndexOf - IsNan - NextSequenceValue - Number - OrderBy - Portal - Reverse - Schema - Sort - SubtypeCode - SubtypeName - Subtypes - Text - Top - TypeOf

Attachments

Attachments( feature, options? ) -> Attachment[]

Since version 1.6

Profiles: Field Calculate | Attribute Rules

Returns a list of attachments associated with the input feature. Each result includes the name of the attachment, the content type, id, and size in bytes.

Returns: Attachment[]

Example

Returns the number of attachments associated with the feature

// Returns the number of attachments associated with the feature
Count(Attachments($feature))

Console

Console( message [,obj,text, ...objN,textN] ) -> Text

Logs a message in the messages window for debugging purposes. This function can be especially useful for inspecting variable values within a custom function at runtime. Unlike other functions and the return statement, Console() doesn't actually return a value; rather, it logs messages in a separate window for inspection purposes only. The successful use of this function has no computational impact on the evaluation of the expression.

Returns: Text

Example

Prints the value of max for each iteration of the loop within the function

// The messages window will log the following:
// 'current item is: 10, but max = 10'
// 'current item is: 0, but max = 10'
// 'current item is: 84, but max = 84'
// 'current item is: 30, but max = 84'

// The expression evaluates to 84
function findMax(yourArray) {
  var max = -Infinity;
  for (var i in yourArray) {
    max = IIf(yourArray[i] > max, yourArray[i], max);
    Console('current item is: ' + i + ', but max = ' + max);
  }
  return max;
}
var myArray = [ 10, 0, 84, 30];
findMax(myArray);

Count

Count( values ) -> Number

Returns the number of items in an array or FeatureSet, or the number of characters in a string.

Returns: Number

Example

Returns 6

Count([12,21,32,44,58,63])

Returns 13

Count('Graham County')

Returns the number of features in a layer

Count($layer)

Dictionary

This function has 2 signatures:

• Dictionary( name1?, value1?, [...nameN, compareN]? ) -> Dictionary
• Dictionary( json? ) -> Dictionary

Dictionary( name1?, value1?, [...nameN, compareN]? ) -> Dictionary

Returns a new dictionary based on the provided arguments. The arguments are name/value pairs. e.g. dictionary('field1',val,'field2',val2,...).

Returns: Dictionary

Example

prints 3

var d = Dictionary('field1', 1, 'field2', 2)
return d.field1 + d.field2

Dictionary( json? ) -> Dictionary

Since version 1.8

Returns a new dictionary from stringified JSON.

Returns: Dictionary

Example

Creates a dictionary from stringified JSON

var extraInfo = '{"id": 1, "population": 200, "city": "Spencer, ID"}'
var spencerIDdata = Dictionary(extraInfo)
spencerIDdata.population // Returns 200

Distinct

This function has 2 signatures:

• Distinct( values ) -> Array
• Distinct( featureset, fields ) -> FeatureSet

Distinct( values ) -> Array

Since version 1.1

Returns a set of distinct, or unique, values for a given array or list of values.

Returns: Array

Example

Distinct([1,1,2,1,1,2,2,3,4,5])
// Returns [1,2,3,4,5]

Distinct('high','medium','low',0,'high','high','low')
// Returns ['high','medium','low',0]

Distinct( featureset, fields ) -> FeatureSet

Since version 1.8

Profiles: Attribute Rules | Field Calculate | Popup

Returns a set of distinct, or unique, values from a FeatureSet.

Returns: FeatureSet

Example

Returns a FeatureSet with a 'Status' column. Each row of the feature set contains a unique stats value

Distinct($layer, 'Status')

Returns a FeatureSet with a 'Status' and a 'Type' column. Each row of the feature set contains a unique combination of 'Status' and 'Type' values

Distinct($layer, ['Status', 'Type'])

Returns FeatureSet with a Density column with rows that may contain values of Low, High, or N/A

Distinct($layer, {name:'Density', expression:"CASE WHEN PopDensity < 100 THEN 'Low' WHEN PopDensity >= 100 THEN 'High' ELSE 'N/A' END" })

Returns FeatureSet with a Score and a Type column

Distinct($layer, [
  { name: 'Score', expression: 'POPULATION_DENSITY * 0.65 + Status_Code * 0.35' }
  { name: 'Type', expression: 'Category' }
])

Domain

This function has 2 signatures:

• Domain( feature, fieldName ) -> Dictionary
• Domain( featureSet, fieldName, subtype? ) -> Dictionary

Domain( feature, fieldName ) -> Dictionary

Since version 1.11

Returns the domain assigned to the given field of the provided feature. If the feature belongs to a class with a subtype, this returns the domain assigned to the subtype.

Returns:

Return Object Specification Table

Example

The domain assigned to the feature's subtype

var d = Domain($feature, "poleType")
// the poleType field has a coded value domain called poleTypes
// the value of d will be
// {
//   type: "codedValue" ,
//   name: "poleTypes",
//   dataType: "number",
//   codedValues: [
//     { name: "Unknown", code: 0 },
//     { name: "Wood", code: 1 },
//     { name: "Steel", code: 2 }
//   ]
// }

Domain( featureSet, fieldName, subtype? ) -> Dictionary

Since version 1.11

Profiles: Attribute Rules | Popup | Field Calculate

Returns the domain assigned to the given field of the provided featureSet. If the featureSet belongs to a class with a subtype, this returns the domain assigned to the subtype.

Returns:

Return Object Specification Table

Example

The domain assigned to the feature's subtype

var fsPole = FeatureSetByName($datastore, "Pole", 1);
var d = Domain(fsPole, "poleType")
// the poleType field has a coded value domain called poleTypes
// the value of d will be
// {
//   type: "codedValue" ,
//   name: "poleTypesThreePhase",
//   dataType: "number",
//   codedValues: [
//     { name: "Unknown", code: 0 },
//     { name: "Wood", code: 1 },
//     { name: "Steel", code: 2 }
//     { name: "Reinforced Steel", code: 3 }
//   ]
// }

DomainCode

DomainCode( feature, fieldName, value, subtype ) -> Text

Since version 1.7

Returns the code of an associated domain description in a feature.

Returns: Text

Example

prints the domain description for the field referenced.

DomainCode($feature, 'Enabled', 'True')

DomainName

DomainName( feature, fieldName, code, subtype? ) -> Text

Since version 1.7

Returns the descriptive name for a domain code in a feature.

Returns: Text

Example

prints the domain description for the referenced field

DomainName($feature, 'fieldName')

Feature

Feature( geometry, name1, value1, [... nameN, valueN]? ) -> Feature

Creates a new feature. Alternatively, it can be called with object notation: Feature({geometry: {}, attributes: {...}}) or with two parameters: Feature(geometry, attributes);.

Returns: Feature

Example

Feature(pointGeometry, 'city_name', 'Spokane', 'population', 210721)

Create a feature from another feature.

var dict = { hello:10 }
var p = point({x:10, y:20, spatialReference:{wkid:102100}})
var ftr1 = Feature(p,dict)
var ftr2 = Feature(ftr1)

Create a feature from a JSON string.

var JSONString = "{'geometry':{'x':10,'y':20,'spatialReference':{'wkid':102100}},'attributes':{'hello':10}}"
var feature = Feature(JSONString)

FeatureSet

FeatureSet( definition ) -> FeatureSet

Since version 1.5

Profiles: Attribute Rules | Popup | Field Calculate

Creates a new FeatureSet from JSON according to the ArcGIS REST spec. See the snippet below for an example of this.

Returns: FeatureSet

Example

Create a FeatureSet from JSON.

// JSON representation of the feature used in the snippet below
// {
//   'fields': [{
//     'alias': 'RANK',
//     'name': 'RANK',
//     'type': 'esriFieldTypeInteger'
//   }, {
//     'alias': 'ELEV_m',
//     'name': 'ELEV_m',
//     'type': 'esriFieldTypeInteger'
//   }],
//   'spatialReference': { 'wkid': 4326 },
//   'geometryType': 'esriGeometryPoint',
//   'features': [{
//     'geometry': {
//       'spatialReference': { 'wkid': 4326 },
//       'x': -151.0063,
//       'y': 63.069
//     },
//     'attributes': {
//       'RANK': 1,
//       'ELEV_m': 6168
//     }
//   }]
// };
// The Dictionary representation of the FeatureSet must be a stringified object
var features = FeatureSet('{"fields":[{"alias":"RANK","name":"RANK","type":"esriFieldTypeInteger"},{"alias":"ELEV_m","name":"ELEV_m","type":"esriFieldTypeInteger"}],"spatialReference":{"wkid":4326},"geometryType":"esriGeometryPoint","features":[{"geometry":{"spatialReference":{"wkid":4326},"x":-151.0063,"y":63.069},"attributes":{"RANK":1,"ELEV_m":6168}}]}')

FeatureSetByAssociation

FeatureSetByAssociation( feature, associationType, terminalName? ) -> FeatureSet

Since version 1.9

Profiles: Attribute Rules | Popup

Returns all the features associated with the input feature as a FeatureSet. This is specific to Utility Network workflows.

Returns:

Return Object Specification Table

Example

Returns all assets that have connectivity associations with the low side terminal of the transformer.

FeatureSetByAssociation($feature, 'connected', 'Low');

Returns the number of electric devices associated with the feature

var allContent = FeatureSetByAssociation ($feature, "content");
var devicesRows = Filter(allContent, "className = 'Electric Device'");
var devicesCount = Count(devicesRows);
return devicesCount;

FeatureSetById

FeatureSetById( map, id, fieldList?, includeGeometry? ) -> FeatureSet

Since version 1.5

Profiles: Attribute Rules | Popup | Field Calculate

Creates a FeatureSet from a Feature Layer based on its layer ID within a map or feature service. Limiting the number of fields in the request and excluding the geometry can improve the performance of the script.

Returns: FeatureSet

Example

Returns the number of features in the layer with the id DemoLayerWM_1117 in the given map.

var features = FeatureSetById($map,'DemoLayerWM_1117', ['*'], true);
Count( features );

FeatureSetByName

FeatureSetByName( map, title, fieldList?, includeGeometry? ) -> FeatureSet

Since version 1.5

Profiles: Attribute Rules | Popup | Field Calculate

Creates a FeatureSet from a Feature Layer based on its name within a map or feature service. Keep in mind this name is not necessarily unique. It is therefore more appropriate to create a FeatureSet using FeatureSetById(). Limiting the number of fields in the feature set and excluding the geometry can improve the performance of the script.

Returns: FeatureSet

Example

Returns the number of features in the layer with the title 'Bike routes' in the given map.

var features = FeatureSetByName($map,'Bike routes', ['*'], true);
Count( features );

FeatureSetByPortalItem

FeatureSetByPortalItem( portal, itemId, layerId, fieldList?, includeGeometry? ) -> FeatureSet

Since version 1.8

Profiles: Field Calculate | Popup

Creates a FeatureSet from a Feature Layer in a portal item from a given Portal. Limiting the number of fields in the feature set and excluding the geometry can improve the performance of the script.

Returns: FeatureSet

Example

Returns the number of features in the layer from a different portal than the feature in the map

var portal = Portal('https://www.arcgis.com');
var features = FeatureSetByPortalItem(portal, '7b1fb95ab77f40bf8aa09c8b59045449', 0, ['Name', 'Count'], false);
Count( features );

FeatureSetByRelationshipName

FeatureSetByRelationshipName( feature, relationshipName, fields?, includeGeometry? ) -> FeatureSet

Since version 1.8

Profiles: Attribute Rules | Field Calculate | Popup

Returns the related records for a given feature as a FeatureSet.

Returns: FeatureSet

Example

Returns the sum of several fields across all related records

var results = FeatureSetByRelationshipName($feature, 'Election_Results', ['*'], false)
Sum(results, 'democrat + republican + other')

Filter

Filter( featureSet, filter ) -> FeatureSet

Since version 1.5

Profiles: Attribute Rules | Popup | Field Calculate

Filters a FeatureSet based on a SQL92 expression.

Returns: FeatureSet

Example

Filter features using a SQL92 expression

// Returns all features with a Population greater than 10,000
var result = Filter($layer, 'POPULATION > 10000');

Filter features using a SQL92 expression with a variable substitute

// Returns all features with a Population greater than the dataset average
var averageValue = Average($layer, 'POPULATION')
var result = Filter($layer, 'POPULATION > @averageValue');

First

First( items ) -> *

Returns the first element in an array or FeatureSet. Returns null if the array or FeatureSet is empty.

Returns: *

Example

prints 'orange'

First(['orange', 'purple', 'gray'])

returns the area of the first feature in the layer.

Area( First($layer) )

GroupBy

GroupBy( featureset, groupByFields, statistics ) -> FeatureSet

Since version 1.8

Profiles: Attribute Rules | Field Calculate | Popup

Returns statistics as a FeatureSet for a set of grouped or distinct values.

Returns: FeatureSet

Example

Returns the count of each tree type

var treeStats = GroupBy($layer, 'TreeType', { name: 'NumTrees', expression: '1', statistic: 'COUNT' });
// treeStats contains features with columns TreeType and NumTrees
// Each unique tree type will have a count

Returns the count and the average height of each tree type

var treeStats = GroupBy($layer,
  [  // fields/expressions to group statistics by
    { name: 'Type', expression: 'TreeType'},
    { name: 'Status', expression: 'TreeStatus'}
  ], 
  [  // statistics to return for each unique category
    { name: 'Total', expression: '1', statistic: 'COUNT' }, 
    { name: 'AvgHeight', expression: 'Height', statistic: 'AVG' }, 
    { name: 'MaxPercentCoverage', expression: 'CoverageRatio * 100', statistic: 'MAX' }
  ]
);
// treeStats contains features with columns Type, Status, Total, AvgHeight, MaxPercentCoverage
// Each unique tree type (combination of type and status) will have a count, average height, and maximum value of percent coverage

Guid

Guid( format? ) -> Text

Since version 1.3

Returns a random GUID as a string.

Returns: Text

Example

Returns a value similar to {db894515-ed21-4df1-af67-36232256f59a}

Guid()

Returns a value similar to d00cf4dffb184caeb8ed105b2228c247

Guid('digits')

HasKey

HasKey( feature, key ) -> Boolean

Indicates whether a dictionary or feature has the input key.

Returns: Boolean

Example

prints true

var d = Dictionary('Port Hope', 16214,  'Grafton', '<1000', 'Cobourg', 18519);
HasKey(d, 'Cobourg');

IndexOf

IndexOf( inputArray, item ) -> Number

Returns the zero-based index location of the input item in an array. If item does not exist, then -1 is returned.

Returns: Number

Example

prints 2

var array = [1,2,3,4];
return indexof(array, 3);

IsNan

IsNan( value ) -> Boolean

Since version 1.5

Indicates whether the input value is not a number (NaN). A number is considered NaN in one of the following scenarios:

• 0/0
• Infinity / Infinity
• Infinity * 0
• Any operation in which NaN is an operand
• Casting a non-numeric string or undefined to a number

Returns: Boolean

Example

// Returns true
IsNan(Infinity / Infinity)

// Returns false
IsNan('4')

NextSequenceValue

NextSequenceValue( inputSequenceName ) -> Number

Since version 1.4

Profiles: Attribute Rule Calculation

Returns the next sequence value from the database sequence specified. If inputSequenceName does not exist, the expression will error.

Returns: Number

Example

Returns a number with the next sequence value

NextSequenceValue('PipeIDSeq')

Number

Number( value, pattern? ) -> Number

Parses the input value to a number.

Returns: Number

Example

Parses a number using a grouping separator appropriate for the local in which the expression is executed

returns 1365

Number('1,365', ',###')

Remove strings from number.

prints 10

Number('abc10def', 'abc##def')

Specify minimum digits past 0 as two and maximum digits past 0 as 4.

prints 10.456

Number('10.456','00.00##')

Specify minimum digits past 0 as two and maximum digits past 0 as 4. The left and right side of the function must match or NaN is returned.

prints NaN

Number('10.4','00.00##')

Indicate the size of the repeated group and the final group size of the input value.

prints 1212456

Number('12,12,456', ',##,###')

If there is a negative subpattern, it serves only to specify the negative prefix and suffix.

prints -1223345

Number('-12,23,345', ',##,###;-,##,###')

Divide by 100. Maximum of three decimal places can be input.

prints 0.9999

Number('99.99%', '#.##%')

OrderBy

OrderBy( featureSet, expression ) -> FeatureSet

Since version 1.5

Profiles: Attribute Rules | Popup | Field Calculate

Orders a FeatureSet by using a SQL92 OrderBy clause.

Returns: FeatureSet

Example

Order features by population where features with the highest population are listed first

OrderBy($layer, 'POPULATION DESC')

Order features by rank in ascending order

OrderBy($layer, 'Rank ASC')

Portal

Portal( url ) -> Portal

Since version 1.8

Profiles: Field Calculate | Popup

Creates a reference to an ArcGIS Portal.

Returns: Portal

Example

Query features from a portal item in ArcGIS Online

var portal = Portal('https://www.arcgis.com');
var features = FeatureSetByPortalItem(portal, '7b1fb95ab77f40bf8aa09c8b59045449', 0, ['Name', 'Count'], false);

Enterprise Portal

Portal('https://www.example.com/arcgis')

Reverse

Reverse( inputArray ) -> Array

Reverses the contents of the array in place.

Returns: Array

Example

returns ['grey', 'purple', 'orange']

Reverse(['orange', 'purple', 'grey'])

Schema

Schema( featureSet ) -> Dictionary

Since version 1.11

Profiles: Attribute Rules | Popup | Field Calculate

Returns the schema description of the provided FeatureSet.

Returns:

Return Object Specification Table

Sort

Sort( inputArray, comparator? ) -> Array

Sorts an array by ASCII value. If all the items in the array are the same type, an appropriate sort function will be used. If they are different types, the items will be converted to strings. If the array contains objects, and no user defined function is provided, no sort will happen.

Returns: Array

Example

returns ['$', 1, 'A', 'a']

Sort([1, 'a', '$', 'A'])

Sort using a user defined function

returns '[{ 'AGE': 24, 'NAME': 'Emma' }, { 'AGE': 25, 'NAME': 'Sam' }, { 'AGE': 27, 'NAME': 'Bob' } ]'

var peopleArray = [{ 'NAME': 'Sam', 'AGE': 25 }, {'NAME': 'Bob', 'AGE': 27 },{ 'NAME': 'Emma', 'AGE': 24 }];
function compareAge(a,b){
  if (a['AGE']<b['AGE'])
    return -1;
  if (a['AGE']>b['AGE'])
    return 1;
  return 0;
}
return Sort(peopleArray, compareAge);

SubtypeCode

SubtypeCode( feature ) -> Number / Text / Date

Since version 1.11

Returns the subtype code for a given feature.

Returns: Number | Text | Date

Example

Returns the code of the subtype

// feature has a field named `assetGroup`
// with the subtype described in the Subtypes function example
SubtypeCode($feature)  // returns 1

SubtypeName

SubtypeName( feature ) -> Text

Since version 1.11

Returns the subtype name for a given feature.

Returns: Text

Example

Returns the name of the subtype

// feature has a field named `assetGroup`
// with the subtype described in the Subtypes function example
SubtypeName($feature) // returns "Single Phase"

Subtypes

Subtypes( feature ) -> Dictionary

Since version 1.11

Returns the subtype coded value Dictionary. Returns null when subtypes are not enabled on the layer.

Returns:

Return Object Specification Table

Example

Returns subtypes with coded values from a feature

Subtypes($feature)
// returns the following dictionary
// {
//   subtypeField: 'assetGroup',
//   subtypes: [
//     { name: "Unknown", code: 0 },
//     { name: "Single Phase", code: 1 },
//     { name: "Two Phase", code: 2 }
//   ]
// }

Returns subtypes with coded values from a feature set

var fsTransformer = FeatureSetByName($datastore, "Transformer")
Subtypes(fsTransformer)
// returns the following dictionary
// {
//   subtypeField: 'assetGroup',
//   subtypes: [
//     { name: "Unknown", code: 0 },
//     { name: "Single Phase", code: 1 },
//     { name: "Two Phase", code: 2 }
//   ]
// }

Text

Text( value, format? ) -> Text

Converts its argument into a string and optionally formats it. Returns null if it fails.

Returns: Text

Example

Pad the number to the left of the decimal

prints '0123'

Text(123, '0000')

Restrict the number to the left of the decimal

prints '23'

Text(123, '00')

Group the number by thousands

prints '1,234'

Text(1234, '#,###')

Round the number to two decimal places

prints '12,345,678.12'

Text(12345678.123, '#,###.00')

Format number as currency

prints '$1,234.55'

Text(1234.55, '$#,###.00')

Round the number to two decimal places

prints '1.24'

Text(1.236, '#.00')

Maintain significant digits and group by thousands

prints '1,234.568'

Text(1234.5678, '#,##0.00#')

Format the number and format positive/negative - if there is a negative subpattern, it serves only to specify the negative prefix and suffix

prints 'Basement 2'

Text(-2, 'Floor #;Basement #')

prints 'Floor 2'

Text(2, 'Floor #;Basement #')

Multiply by 100 and format as percentage

prints '30%'

Text(0.3, '#%')

Format date and time

prints the date at the moment. eg 'Tuesday, October 25, 2016 @ 08:43:11'

Text(Now(), 'dddd, MMMM D, Y @ h:m:s')

Top

Top( items, numElements ) -> Array / FeatureSet

Since version 1.3

Truncates the input array or FeatureSet and returns the first given number of elements.

Returns: Array | FeatureSet

Example

returns [ 43,32,19 ]

Top([ 43,32,19,0,3,55 ], 3)

Returns the top 5 features with the highest population

Top( OrderBy($layer, 'POPULATION DESC'), 5 )

TypeOf

TypeOf( value ) -> Text

Returns the type of the input value. Will return one of the following types: Array, Date, Text, Boolean, Number, Dictionary, Feature, Point, Polygon, Polyline, Multipoint, Extent, Function, Unrecognized Type.

Returns: Text

Example

prints 'Boolean'

TypeOf(true)

prints 'Date'

TypeOf(Now())