Docspring.Model.Field (docspring v4.5.0)
A field of a template: the name of a value in submission data, and how and where it prints. Fields with the same name share one value and the settings the descriptions say are shared. A PDF template's fields are placed on its pages: x, y, width and height are in units where every page is 2480 wide, measured from the top-left corner of the field's page. To convert from PDF points, multiply by 2480 and divide by the page's width in points (document.page_dimensions on the template). An HTML or Word template's fields are all on page 1, and their placement and style settings aren't used: its HTML or Word document places and styles each value.
Summary
Types
@type t() :: %Docspring.Model.Field{ acroform_name: String.t() | nil, alignment: Docspring.Model.TextAlignment.t(), auto_calculate_max_length: boolean(), background_color: String.t() | nil, background_color_field_name: String.t() | nil, background_color_field_required: boolean(), barcode_symbology: Docspring.Model.BarcodeSymbology.t(), bold: boolean(), character_spacing: number(), check_character: Docspring.Model.CheckCharacter.t(), check_color: String.t() | nil, check_color_field_name: String.t() | nil, check_color_field_required: boolean(), color: String.t() | nil, color_field_name: String.t() | nil, color_field_required: boolean(), comb: boolean(), comb_number_of_cells: integer(), comb_value_offset: integer(), combined_field_format: String.t(), combined_field_names: String.t(), combined_field_separator: String.t(), combined_field_type: Docspring.Model.CombinedFieldType.t(), condition: String.t() | nil, currency: boolean(), date_time_format: String.t() | nil, decimal_places: integer() | nil, default: String.t() | nil, dependencies: Docspring.Model.FieldDependency.t() | nil, description: String.t(), display_type: Docspring.Model.FieldDisplayType.t(), editable: boolean(), exclusive_maximum: boolean(), exclusive_minimum: boolean(), false_text: String.t() | nil, font_size: integer() | nil, height: number(), hidden: boolean(), id: integer(), image_gravity: Docspring.Model.ImageGravity.t(), image_scale_type: Docspring.Model.ImageScaleType.t(), include_time: boolean() | nil, integer: boolean(), invert_boolean_condition: boolean(), keep_leading_spaces: boolean(), max_length: integer() | nil, maximum: number() | nil, metadata: String.t(), min_length: number(), minimum: number() | nil, multiline: boolean(), multiline_lines: integer() | nil, name: String.t() | nil, number_condition_range_exclusive_max: boolean(), number_condition_range_exclusive_min: boolean(), number_condition_range_max: number() | nil, number_condition_range_min: number() | nil, number_condition_type: Docspring.Model.NumberConditionType.t(), opacity: number(), option_list: String.t() | nil, overflow: Docspring.Model.TextOverflow.t(), page: integer(), placeholder: String.t(), qrcode_color: String.t() | nil, qrcode_color_field_name: String.t() | nil, qrcode_color_field_required: boolean(), required: boolean(), rotation: number(), shape_border_color: String.t(), shape_border_color_field_name: String.t() | nil, shape_border_color_field_required: boolean(), shape_border_width: integer(), shape_fill_color: String.t() | nil, shape_fill_color_field_name: String.t() | nil, shape_fill_color_field_required: boolean(), shape_sides: integer(), shape_type: Docspring.Model.ShapeType.t(), signature_allow_draw: boolean(), signature_allow_type: boolean(), static: boolean(), strikethrough: boolean(), string_condition_type: Docspring.Model.StringConditionType.t(), title: String.t(), true_text: String.t() | nil, type: Docspring.Model.FieldType.t(), typeface: Docspring.Model.Typeface.t() | nil, uppercase: boolean(), v_alignment: Docspring.Model.TextVerticalAlignment.t(), width: number(), x: number(), y: number() }