Optional clearIf the value of this field should be cleared when it is conditionally hidden.
Optional conditionalDetermines when this component should be added to the form for both processing and input.
Optional defaultOnly specified to be able to type the submission data value. We do not see a use case for pre-selecting a particular location on a map component, as the SDK asks the user for their location anyway.
Do not add the default value to the builder.
Optional defaultDefault zoom level, limited by Leaflet and the available tile service zoom levels.
Leaflet zoom level is a range of 1-20, but the Dutch tile service only supports up to level 13.
Make property required, which requires a data migration.
Optional descriptionOptional errorsAllows customizable errors to be displayed for each component when an error occurs. This is an object with the following keys: required min max minLength maxLength invalid_email invalid_date pattern custom
An object (keys listed above), values are the strings you wish to display. Each string has the {{ field }} to use within the string. Example. {"required": "{{ field }} is required. Try again."}
Optional hiddenDetermines if the component should be within the form, but not visible. This can be overridden with the conditionals.
Optional initialCoordinates to center the map on initially.
Optional lat?: numberOptional lng?: numberMake property required, which requires a data migration.
Optional interactionsInteractions users can use when working with the map component.
These interaction options are based on the options available in leaflet draw: https://leaflet.github.io/Leaflet.draw/docs/leaflet-draw-latest.html#drawoptions
Optional isOptional openOptional registrationOptional showOptional showOptional showOptional tileThe tile layer identifier used for the map component tile layer.
Optional tileThe url belonging to the connected tile layer object, determined by tileLayerIdentifier.
This value should not be definable by admins, but should be fetched from the related tile layer object. This happens when fetching the component from the backend.
Optional tooltipOptional translatedOptional useIf true, the backend must apply the globally configured defaults to a particular
map instance. This results in populating defaultZoom and initialCenter, so for
the SDK this property has no effect.
Make property required, which requires a data migration.
Optional validateOptional validateThis will perform the validation on either "change" or "blur" of the input element.
Generated using TypeDoc
Custom Formio component type.