DynamicRecord

DynamicRecord

new DynamicRecord(layerClass, esriRequest, apiRef, config, esriLayer, epsgLookup)

Source:

Create a layer record with the appropriate geoApi layer type. Layer config should be fully merged with all layer options defined (i.e. this constructor will not apply any defaults).

Parameters:
Name Type Description
layerClass Object

the ESRI api object for dynamic layers

esriRequest Object

the ESRI api object for making web requests with proxy support

apiRef Object

object pointing to the geoApi. allows us to call other geoApi functions

config Object

layer config values

esriLayer Object

an optional pre-constructed layer

epsgLookup function

an optional lookup function for EPSG codes (see geoService for signature)

Methods

aliasedFieldName(attribName, childIndex) → {Promise}

Source:

Get the best user-friendly name of a field. Uses alias if alias is defined, else uses the system attribute name.

Parameters:
Name Type Description
attribName String

the attribute name we want a nice name for

childIndex String

index of the child layer whos attributes we are looking at

Returns:

resolves to the best available user friendly attribute name

Type
Promise

checkDateType(attribName, childIndex) → {Promise}

Source:

Check to see if the attribute in question is an esriFieldTypeDate type.

Parameters:
Name Type Description
attribName String

the attribute name we want to check if it's a date or not

childIndex String

index of the child layer whos attributes we are looking at

Returns:

resolves to true or false based on the attribName type being esriFieldTypeDate

Type
Promise

getChildProxy(featureIdx) → {Object}

Source:

Return a proxy interface for a child layer

Parameters:
Name Type Description
featureIdx Integer

index of child entry (leaf or group)

Returns:

proxy interface for given child

Type
Object

getFormattedAttributes(childIndex) → {Promise}

Source:

Retrieves attributes from a layer for a specified feature index

Parameters:
Name Type Description
childIndex String

index of the child layer to get attributes for

Returns:

promise resolving with formatted attributes to be consumed by the datagrid and esri feature identify

Type
Promise

DynamicRecord

new DynamicRecord()

Source:

Methods

aliasedFieldName(attribName, childIndex) → {Promise}

Source:

Get the best user-friendly name of a field. Uses alias if alias is defined, else uses the system attribute name.

Parameters:
Name Type Description
attribName String

the attribute name we want a nice name for

childIndex String

index of the child layer whos attributes we are looking at

Returns:

resolves to the best available user friendly attribute name

Type
Promise

checkDateType(attribName, childIndex) → {Promise}

Source:

Check to see if the attribute in question is an esriFieldTypeDate type.

Parameters:
Name Type Description
attribName String

the attribute name we want to check if it's a date or not

childIndex String

index of the child layer whos attributes we are looking at

Returns:

resolves to true or false based on the attribName type being esriFieldTypeDate

Type
Promise

getChildProxy(featureIdx) → {Object}

Source:

Return a proxy interface for a child layer

Parameters:
Name Type Description
featureIdx Integer

index of child entry (leaf or group)

Returns:

proxy interface for given child

Type
Object

getFormattedAttributes(childIndex) → {Promise}

Source:

Retrieves attributes from a layer for a specified feature index

Parameters:
Name Type Description
childIndex String

index of the child layer to get attributes for

Returns:

promise resolving with formatted attributes to be consumed by the datagrid and esri feature identify

Type
Promise