hatti.ona.forms — onaio/hatti 0.4.6

audio? cljs

(audio? field)

calculate? cljs

(calculate? field)

Checks whether a field is a calculate field

categorical? cljs

(categorical? field)

Checks whether a field is a category field (select one or multiple)

currency-regex cljs

default-geofield cljs

(default-geofield flat-form)

From a list of geofields, get the default one to map. Implementation: pick first geoshape if any, else pick first geofield.

default-lang cljs

(default-lang languages)

Get default language (English or alphabetical first) from within a list.

english? cljs

(english? language)

extra-submission-details cljs

field-name-in-set? cljs

(field-name-in-set? names field)

Helper function: is the :name of a field among a set of names

field-type-in-set? cljs

(field-type-in-set? types field)

Helper function: is the :type of a field among a set of types

flatten-form cljs

(flatten-form {:keys [children] :as form} & {:keys [flatten-repeats?]})

Input: map derived from form.json. Output: a flattened vector; each element is a field; a field is a {:name .. :label .. :type ..} map. By default, REPEAT BLOCKS ARE NOT FLATTENED, repeat blocks represent subforms, which need special handling in most cases. :flatten-repeats? overrides default behavior, also flattens repeats.

format-answer cljs

(format-answer field
               answer
               &
               {:keys [language compact? label field-key media record-modal?
                       media-count total-media]
                :or {field-key :name record-modal? false}})

String representation for a particular field datapoint (answer). re-formatting depends on field type, eg. name->label substitution. Optional: compact? should be true if a short string needs to be returned.

geofield? cljs

(geofield? field)

geofields cljs

(geofields flat-form)

Get just the geofields from the form.

geopoint? cljs

(geopoint? field)

geoshape? cljs

(geoshape? field)

geotrace? cljs

(geotrace? field)

get-column-class cljs

(get-column-class field)

Assign class according to field type category, e.g. integer & decimals are both in the numeric category

get-icon cljs

(get-icon field)

Get the icon relevant to the given field (depending on its type).

get-label cljs

(get-label {:keys [label name]} & [language])

Gets the label object out of a map with key :label (eg. a field). If multiple languages, and none specified, picks out alphabetically first.

get-languages cljs

(get-languages form)

Get the languages for a given form.

group? cljs

(group? field)

Checks whether a field in a form (ie, a field) is a group field

has-data? cljs

(has-data? field)

Returns false for fields such as note, group, etc. which don't have data

id-field cljs

image? cljs

(image? field)

infor-icon-component cljs

(infor-icon-component answer & {:keys [media-count total-media help-url]})

Returns an infor icon with a tooltip message

last_edited cljs

media-files-upload-error-component cljs

(media-files-upload-error-component answer
                                    &
                                    {:keys [help-url error-message
                                            record-modal?]})

Displays tip question and tooltip msg for failed media files uploads

media_received_field cljs

meta-fields cljs

(meta-fields flat-form
             &
             {:keys [relabel? with-submission-details?] :or {relabel? true}})

Get just the meta fields out of the form. Options to re-label meta fields, or include submission time in meta list.

meta? cljs

(meta? field)

multilingual? cljs

(multilingual? form)

Does this form contain labels in multiple languages?

name-label-map cljs

(name-label-map {:keys [children name label] :as child}
                prefix
                acc
                flatten-repeats?)

newline-regex cljs

no-answer cljs

non-meta-fields cljs

(non-meta-fields flat-form)

Get just the fields in this form that are not meta fields.

note? cljs

(note? field)

Checks whether a field in a form (a field) is a group field

numeric? cljs

(numeric? field)

Checks whether a field is a numeric field

osm? cljs

(osm? field)

relabel-meta-field cljs

(relabel-meta-field {:keys [label name type] :as field})

Try and produce a label for meta field if non-existent.

repeat? cljs

(repeat? field)

Checks whether a field in a form (ie, a field) is a repeat field

review-comment-field cljs

review-status-field cljs

select-all? cljs

(select-all? field)

Checks whether a field is a select multiple (select all that apply) field

select-one? cljs

(select-one? field)

Checks whether a field is a select one field

submission-time-field cljs

submitted-by-field cljs

text? cljs

(text? field)

Checks whether a field is a text / string field.

time-based? cljs

(time-based? field)

Checks whether a field is a date or a time field

uses-search-expression? cljs

(uses-search-expression? appearance-value)

Checks if the appearance-value has the search expression

video? cljs

(video? field)