Docspring.Model.FieldInput (docspring v4.2.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 template's fields are all on page 1, and their placement and style settings aren't used.

Summary

Types

t()

@type t() :: %Docspring.Model.FieldInput{
  alignment: Docspring.Model.TextAlignment.t() | nil,
  auto_calculate_max_length: boolean() | nil,
  background_color: String.t() | nil,
  background_color_field_name: String.t() | nil,
  background_color_field_required: boolean() | nil,
  barcode_symbology: Docspring.Model.BarcodeSymbology.t() | nil,
  bold: boolean() | nil,
  character_spacing: number() | nil,
  check_character: Docspring.Model.CheckCharacter.t() | nil,
  check_color: String.t() | nil,
  check_color_field_name: String.t() | nil,
  check_color_field_required: boolean() | nil,
  color: String.t() | nil,
  color_field_name: String.t() | nil,
  color_field_required: boolean() | nil,
  comb: boolean() | nil,
  comb_number_of_cells: integer() | nil,
  comb_value_offset: integer() | nil,
  combined_field_format: String.t() | nil,
  combined_field_names: String.t() | nil,
  combined_field_separator: String.t() | nil,
  combined_field_type: Docspring.Model.CombinedFieldType.t() | nil,
  condition: String.t() | nil,
  currency: boolean() | nil,
  date_time_format: String.t() | nil,
  decimal_places: integer() | nil,
  default: String.t() | nil,
  dependencies: Docspring.Model.FieldDependencyInput.t() | nil,
  description: String.t() | nil,
  display_type: Docspring.Model.FieldDisplayType.t() | nil,
  editable: boolean() | nil,
  exclusive_maximum: boolean() | nil,
  exclusive_minimum: boolean() | nil,
  false_text: String.t() | nil,
  font_size: integer() | nil,
  height: number() | nil,
  hidden: boolean() | nil,
  id: integer() | nil,
  image_gravity: Docspring.Model.ImageGravity.t() | nil,
  image_scale_type: Docspring.Model.ImageScaleType.t() | nil,
  include_time: boolean() | nil,
  integer: boolean() | nil,
  invert_boolean_condition: boolean() | nil,
  keep_leading_spaces: boolean() | nil,
  max_length: integer() | nil,
  maximum: number() | nil,
  metadata: String.t() | nil,
  min_length: number() | nil,
  minimum: number() | nil,
  multiline: boolean() | nil,
  multiline_lines: integer() | nil,
  name: String.t() | nil,
  number_condition_range_exclusive_max: boolean() | nil,
  number_condition_range_exclusive_min: boolean() | nil,
  number_condition_range_max: number() | nil,
  number_condition_range_min: number() | nil,
  number_condition_type: Docspring.Model.NumberConditionType.t() | nil,
  opacity: number() | nil,
  option_list: String.t() | nil,
  overflow: Docspring.Model.TextOverflow.t() | nil,
  page: integer() | nil,
  placeholder: String.t() | nil,
  qrcode_color: String.t() | nil,
  qrcode_color_field_name: String.t() | nil,
  qrcode_color_field_required: boolean() | nil,
  required: boolean() | nil,
  rotation: number() | nil,
  shape_border_color: String.t() | nil,
  shape_border_color_field_name: String.t() | nil,
  shape_border_color_field_required: boolean() | nil,
  shape_border_width: integer() | nil,
  shape_fill_color: String.t() | nil,
  shape_fill_color_field_name: String.t() | nil,
  shape_fill_color_field_required: boolean() | nil,
  shape_sides: integer() | nil,
  shape_type: Docspring.Model.ShapeType.t() | nil,
  signature_allow_draw: boolean() | nil,
  signature_allow_type: boolean() | nil,
  static: boolean() | nil,
  strikethrough: boolean() | nil,
  string_condition_type: Docspring.Model.StringConditionType.t() | nil,
  title: String.t() | nil,
  true_text: String.t() | nil,
  type: Docspring.Model.FieldType.t() | nil,
  typeface: Docspring.Model.Typeface.t() | nil,
  uppercase: boolean() | nil,
  v_alignment: Docspring.Model.TextVerticalAlignment.t() | nil,
  width: number() | nil,
  x: number() | nil,
  y: number() | nil
}

Functions

decode(value)