Module Form

Adds a photo to the currently displayed form.

example

if (JMap.Form.hasDisplayedForm() && JMap.Form.hasDisplayedFormAPhotoField()) {
 // returns the photos of the currently displayed form
 const newPhoto = JMap.Form.addDisplayedFormPhoto({
   url: "https://your-url/myphoto.jpeg",
   title: "My photo",
   fileName: "myphoto.jpeg",
   comment: undefined,
   metadata: {
     projectionType: "none"
   },
   imageBase64: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABEAYAAABPhRjKAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw1AUhU9TpSIVhVYQcchQnSyISnHUKhShQqgVWnUweekfNGlIUlwcBdeCgz+LVQcXZ10dXAVB8AfE0clJ0UVKvK8ptIjxwuN9nHfP4b37AKFeZprVNQFoum2mEnExk10VA6/wIYRBxDAgM8uYk6QkPOvrnrqp7qI8y7vvz+pTcxYDfCLxLDNMm3iDOLZpG5z3icOsKKvE58TjJl2Q+JHristvnAtNFnhm2Eyn5onDxGKhg5UOZkVTI54mjqiaTvlCxmWV8xZnrVxlrXvyFwZz+soy12mNIIFFLEGCCAVVlFCGjSjtOikWUnQe9/APN/0SuRRylcDIsYAKNMhNP/gf/J6tlZ+adJOCcaD7xXE+RoHALtCoOc73seM0TgD/M3Clt/2VOjDzSXqtrUWOgP5t4OK6rSl7wOUOMPRkyKbclPy0hHweeD+jb8oCoVugd82dW+scpw9AmmaVvAEODoGxAmWve7y7p3Nu//a05vcDhJpyruvcgbwAAAAGYktHRAD/AP8A/6C9p5MAAAAJcEhZcwAALiMAAC4jAXilP3YAAAAHdElNRQfmARsTORZSgY7TAAAAGXRFWHRDb21tZW50AENyZWF0ZWQgd2l0aCBHSU1QV4EOFwAAAAtJREFUCNdjYIACAAAJAAFjKhYNAAAAAElFTkSuQmCC"
 })
 ...
}

Returns true if current user can create element on the given form.

example

// returns true if current user can create element on form id=1 of layer id=3.
JMap.Form.canCreateElementOnForm({
 layerId: 3,
 formId: 1
})

Returns true if current user can delete element on the given form.

example

// returns true if current user can delete element on form id=1 of layer id=3.
JMap.Form.canDeleteElementOnForm({
 layerId: 3,
 formId: 1
})

Returns true if current user can update element on the given form.

example

// returns true if current user can udpate element on form id=1 of layer id=3.
JMap.Form.canUpdateElementOnForm({
 layerId: 3,
 formId: 1
})

Checks if the schemas are valid, corrects them when possible, throws for non-repairable errors

example

const schema = ...
const uiSchema = ...
// checks the schemas, corrects them when possible, throws for non-repairable errors
JMap.Form.checkAndCorrectSchemas(schema, uiSchema)

Closes the currently displayed form.

Do nothing if no form displayed.

example

 // closes currently displayed form
 JMap.Form.closeCurrentDisplayedDialog()

Creates an attribute form element.

Works only for attribute form.

throws

if layer not found, if form not found, or form is not an attribute form, or invalid parameter

example

// returns the new created feature
JMap.Form
 .createAttributeFormElement({
   layerId: 3,
   formId: 4,
   attributeValueByName: {
     color: "green",
     type: "tree"
   },
   geometry: {
     type: "Point",
     coordinates: [43.55843, 6.55121]
   }
 })
 .then(feature => console.log("New feature created:", feature))
 .catch(error => console.error("An error occurred while creating new feature", error))

Creates an external or sub form entry.

Works only for external or sub forms.

throws

if layer not found, if form not found, or form is not an external or sub form, or invalid parameter

example

// returns the new created entries
JMap.Form
 .createDatabaseFormEntry({
   layerId: 3,
   formId: 5,
   parentId: 3,
   parentAttributeValueByName: {
     jmap_id: 3,
     color: "green",
     type: "tree"
   },
   attributeValueByName: {
     name: "bird",
     type: "nest"
   },
   elementId: 3
 })
 .then(entry => console.log("New entry created:", entry))
 .catch(error => console.error("An error occurred while creating new entry", error))

Deletes entries of an attribute form.

Works only for attribute form.

throws

if layer not found, if form not found, or form is not an attribute form, or invalid parameter

example

// returns delete result
JMap.Form
 .deleteDatabaseFormEntries({
   layerId: 3,
   formId: 4,
   elements: [{
     id: 3,
     parentId: 3,
     elementId: 3,
     attributeValueByName: {
       name: "bee",
       type: "nest"
     },
     parentAttributeValueByName: {
       jmap_id: 3,
       color: "red",
       type: "tree"
     }
   }]
 })
 .then(result => console.log("Deleted entries result:", result))
 .catch(error => console.error("An error occurred while deleting entries", error))

Returns the active tab index.

If no form, or sub form is displayed, returns 0.

example

if (JMap.Form.hasDisplayedForm()) {
 // reset currently displayed form values
 const currentTabIndex = JMap.Form.getActiveTabIndex()
 ...
}

Returns the current layer forms metadata.

If no layer form displayed, returns an empty array.

example

 // returns the current layer forms metadata
 const formsMetadata = JMap.Form.getAllFormsMetaDataForCurrentLayer()
}

Returns attribute form of currently displayed layer.

throws

if layer has no attribute form

example

 // returns attribute form of currently displayed layer
 const attributeForm = JMap.Form.getAttributeForm()
}

Returns the default data values of the form.

The result is an object where :

• key is the attribute id
• value the default value

example

const form = ...
const defaultValues = JMap.Form.getDefaultValues(form)

Returns the currently displayed form.

Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.

throws

if no layer is displayed

example

if (JMap.Form.hasDisplayedForm()) {
 // returns the currently displayed form
 const form = JMap.Form.getDisplayedForm()
 ...
}

Returns the photo of the currently displayed form.

example

if (JMap.Form.hasDisplayedForm() && JMap.Form.hasDisplayedFormAPhotoField()) {
 // returns the photos of the currently displayed form
 const photos = JMap.Form.getDisplayedFormPhotos()
 ...
}

Returns form data of an element from given parameters.

Works only for attribute forms.

throws

if layer not found, if form not found, or form is not an attribute form

example

// returns element form data for layer id=3, form id=2, and element id=245
JMap.Form
 .getElement({
   layerId: 3,
   formId: 2,
   elementId: 245
 })
 .then(element => console.log("Element:", element))
 .catch(error => console.error("An error occurred when getting element data", error))

Returns form data of multiple elements from given parameters.

Works only for attribute forms.

throws

if layer not found, if form not found, or form is not an attribute form

example

// returns elements form data for layer id=3, form id=2, and elements id=245,236
JMap.Form
 .getElements({
   layerId: 3,
   formId: 2,
   elementIds: [245, 236]
 })
 .then(elements => console.log("Elements:", elements))
 .catch(error => console.error("An error occurred when getting elements data", error))

Returns form data of multiple entries from given parameters.

Works only for external and sub forms.

throws

if layer not found, if form not found, or form is not an external or sub form

example

// returns entries form data for layer id=3, form id=4, and elements id=5
JMap.Form
 .getEntries({
   layerId: 3,
   formId: 4,
   elementId: 5,
   parentId: 2,
   parentFormAttributesValuesByName: { jmap_id: 2, name: "Yellow" },
 })
 .then(entries => console.log("Entries:", entries))
 .catch(error => console.error("An error occurred when getting entries data", error))

Returns external forms of currently displayed layer.

example

 // returns external forms of currently displayed layer
 const externalForms = JMap.Form.getExternalForms()
}

Returns form metadata of the currently displayed layer and given form id.

throws

if form not found

example

 // returns the form metadata of currently displayed layer and form id=2
 const formMetadata = JMap.Form.getAllFormsMetaDataForCurrentLayer(2)
}

Returns default values if form has not been edited, else form values.

This is a technical method used by JMap App, you should never have to use this function

example

 const form = ...
 // returns the form values
 JMap.Form.getFormValues(form)

Returns all forms metadata for a given layer id.

Fecthes data from server first time, then keeps it in cache for the next time.

throws

if layer not found

example

// returns all forms metadata for layer id=3
JMap.Form
 .getFormsMetaDataByLayerId(3)
 .then(formsMetadata => console.log("Forms metatada of layer 3", formsMetadata))
 .catch(error => console.error("An error occurred when getting form metadata", error))

Returns the next view id.

This is a technical method that you should never have to use.

example

// returns the next view id
JMap.Form.getNextViewId()

This function prepare the data, it returns a copy object containing the values formatted in a way that fit the server needs.

It's not mandatory to use this function but it's highly recommended to use it before :

• sending them to the server ()
• validating them using JMap.Form.getPreparedData (change values to fit the )

It returns another object without modifing the passed object.

Use to set the correct type (number if a string number is passed), and many other things.

example

const data = ...
const form = ...
const preparedData = JMap.Form.getPreparedData(form, data)
const errors = JMap.Form.validateData(form, preparedData)

Returns sub forms of currently displayed layer.

example

 // returns sub forms of currently displayed layer
 const subForms = JMap.Form.getSubForms()
}

Returns true if the currently displayed layer has an attribute form.

example

 // returns true if the currently displayed layer has an attribute form
 JMap.Form.hasAttributeForm()
}

Returns true if a form is currently displayed.

example

// returns true if a form is currently displayed, else false
JMap.Form.hasDisplayedForm()

Returns true if currently displayed form has a photo field.

example

// returns true if currently displayed form has a photo field
JMap.Form.hasDisplayedFormAPhotoField()

Returns true if current user has the right to edit all given elements.

example

// returns true if current user has the right to edit all given elements
JMap.Form.hasEditOwnRightsForAllElements({
 layerId: 3,
 formId: 1,
 elements: [{
   id: 3,
   attributeValueByName: {
     author: "administrator",
     jmap_id: 3,
     color: "white",
     type: "tree"
   }
 }, {
   id: 4,
   attributeValueByName: {
     author: "administrator",
     jmap_id: 4,
     color: "red",
     type: "tree"
   }
 }]
})

Increments the next view id.

This is a technical method that you should never have to use.

example

// increments the next view id
JMap.Form.incrementNextViewId()

Returns true if all given elements respect edit own permission.

Works only for attribute form elements, edit own permission are not supported for external or sub forms.

example

const formElements = ... // get attribute form elements
// returns true if all elements respect edit own permission
JMap.Form.isOwnPermissionRespectedForAllElements(3, elements)

Opens the form creation dialog.

throws

if layer not found, or invalid geometry, or layer has no form

example

 // opens the form creation dialog for layer id=3
 JMap.Form
   .openCreationDialogForLayer(
     3,
     {
       type: "Point",
       coordinates: [43.55843, 6.55121]
     }
   )
   .then(formsMetadata => console.log("Creation form dialog opened", formsMetadata))
   .catch(error => console.error(error))

Opens the sub form creation dialog.

throws

if no form dialog currently opened, or sub form not found, or no sub form table field in currently displayed form, or invalid parameters

example

 // opens the form creation dialog for layer id=3
 JMap.Form
   .openCreationDialogForSubForm(
     4,
     [
       id: 3,
       attributeValueByName: {
         jmap_id: 3,
         color: "red",
         type: "tree"
       }
     ]
   )
   .then(formMetadata => console.log("Creation sub form dialog opened", formMetadata))
   .catch(error => console.error(error))

Opens the form update dialog.

throws

if layer not found, or layer has no form

example

 const layerId = 3
 const featureId = 4
 // in this exemple we fetch the feature from the server, but we could get from the map
 // with the following method <a href="jmap.map.html#getrenderedfeatures">JMap.Map.getRenderedFeatures</a>
 const feature = await JMap.Feature.getById(layerId, featureId)
 // opens form update dialog for one element of layer id=3
 JMap.Form
   .openUpdateDialogForLayer(
     layerId,
     [{
       id: featureId,
       attributeValueByName: feature.properties
     }]
   )
   .then(formsMetadata => console.log("Update form dialog opened", formsMetadata))
   .catch(error => console.error(error))

Opens the sub form creation dialog.

throws

if no form dialog currently opened, or sub form not found, or no sub form table field in currently displayed form, or invalid parameters

example

 // opens the form creation dialog for layer id=3
 JMap.Form
   .openCreationDialogForSubForm(
     4,
     [
       id: 4,
       parentId: 3,
       elementId: 3,
       parentAttributeValueByName: {
         jmap_id: 3,
         color: "red",
         type: "tree"
       },
       attributeValueByName: {
         id: 4,
         name: "bee",
         type: "nest"
       }
     ]
   )
   .then(formMetadata => console.log("Update sub form dialog opened", formMetadata))
   .catch(error => console.error(error))

Processes a JSON Logic rule and returns the result, or undefined if rules are not correct.

https://github.com/jwadhams/json-logic-js#readme

example

// returns "banana"
JMap.Form.processRule({"var" : 1 }, [ "apple", "banana", "carrot" ])

Deletes a photo on the currently displayed form, for a given photo id.

throws

if invalid id passed, or photo not found

example

if (JMap.Form.hasDisplayedForm() && JMap.Form.hasDisplayedFormAPhotoField()) {
 const photos = getDisplayedFormPhotos()
 if (photos.length > 0) {
   JMap.Form.removeDisplayedFormPhotoById(photos[0].id)
 }
}

Resets the currently displayed form.

Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.

throws

if no layer is displayed

example

if (JMap.Form.hasDisplayedForm()) {
 // reset currently displayed form values
 JMap.Form.resetDisplayedForm()
 ...
}

Set the active tab index.

Works only for attribute form that have at least one external form.

Index starts at 0 (attribute form), 1 (first external form), etc...

Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.

throws

if no layer is displayed, if index is invalid.

example

if (JMap.Form.hasDisplayedForm()) {
 // reset currently displayed form values
 JMap.Form.setActiveTabIndex(1)
 ...
}

Set form values of the given form.

example

 const form = JMap.Form.getAttributeForm()
 // set values of the attribute form
 JMap.Form.setFormValues(form, {
   color: "white",
   type: "tree"
 })

Submit the currently displayed form.

throws

if no form displayed

example

 const layerId = 3
 const featureId = 4
 const feature = await JMap.Feature.getById(layerId, featureId)
 // opens form update dialog for one element of layer id=3
 await JMap.Form.openUpdateDialogForLayer(
   layerId,
   [{
     id: featureId,
     attributeValueByName: feature.properties
   }]
 )
 const form = JMap.Form.getAttributeForm()
 // change some values of the attribute form
 JMap.Form.setFormValues(form, {
   color: "white",
   type: "tree"
 })
 JMap.Form
   .submit()
   .then(result => console.log("Submit result", result))
   .catch(error => console.error(error))

Updates an attribute form element.

Works only for attribute form.

throws

if layer not found, if form not found, or form is not an attribute form, or invalid parameter

example

// returns update result
JMap.Form
 .updateAttributeFormElements({
   layerId: 3,
   formId: 4,
   elements: [{
     id: 3,
     attributeValueByName: {
       color: "red",
       type: "tree"
     },
     parentAttributeValueByName: {}
   }]
 })
 .then(result => console.log("Element updated:", result))
 .catch(error => console.error("An error occurred while updating elements", error))

Updates an external or sub form entry.

Works only for external or sub form.

throws

if layer not found, if form not found, or form is not an external or sub form, or invalid parameter

example

// returns update result
JMap.Form
 .updateDatabaseFormEntries({
   layerId: 3,
   formId: 4,
   elements: [{
     id: 3,
     parentId: 3,
     elementId: 3,
     attributeValueByName: {
       name: "bee",
       type: "nest"
     },
     parentAttributeValueByName: {
       jmap_id: 3,
       color: "red",
       type: "tree"
     }
   }]
 })
 .then(entries => console.log("Updated entries:", entries))
 .catch(error => console.error("An error occurred while updating entries", error))

Updates a photo to the currently displayed form.

throws

if invalid params passed, or if title AND comments are not or empty string

example

if (JMap.Form.hasDisplayedForm() && JMap.Form.hasDisplayedFormAPhotoField()) {
 const photos = getDisplayedFormPhotos()
 if (photos.length > 0) {
   JMap.Form.updateDisplayedFormPhoto({
     photoId: photos[0].id,
     title: "My new title !",
     comment: "My new comment"
   })
 ...
 }
}

Returns errors for the given form id and data.

If no error validation, it returns an empty object.

The result is an object where :

• key is the attribute id
• value is the validation error message, translated in the user locale

example

const form = ...
 const data = {
  name: "Jack"
}
// returns {} if no error, else could returns { age: "required field" }
const errors = JMap.Form.validateData(form, data)