Skip to main content

TemplateElement

A TemplateElement is a field or other entity (text box, signature, label, checkbox) placed on a Template page. Each element is assigned to a signer via the signer index so the correct participant sees their fields.

Fields

Position & Layout

FieldTypeDescription
idID!Unique identifier
pageIntPage number
axFloatStart X coordinate
ayFloatStart Y coordinate
bxFloatEnd X coordinate
byFloatEnd Y coordinate
alignStringText alignment (left, right, centre)
hideBorderBooleanHide the field border
fieldOrderIntTab order (null = automatic flow)

Type & Validation

FieldTypeDescription
elementTypeString!Field type (e.g. SIGNATURE, TEXT, admin for sender fields)
formElementTypeStringCalculated form element type
formElementDescriptionStringSubtype description (e.g. "Currency")
validationIntValidation rule ID
optionalBooleanWhether the field is optional
substantiveBooleanWhether the field is substantive

Content

FieldTypeDescription
labelStringField label
labelExtraStringAdditional label text
helpTextStringHelp text for the signer
valueStringDefault value
optionsStringOptions (for dropdowns/radio buttons)

Assignment

FieldTypeDescription
signerIntSigner index this field is assigned to
roleStringRole name

Styling

FieldTypeDescription
fontNameStringFont name
fontSizeIntFont size in pixels

Logic

FieldTypeDescription
logicGroupStringLogic group identifier
logicActionIntLogic action
mapToStringMap-to field identifier

Query

TemplateElements are accessed via Template.elementConnection:

query GetTemplateElements {
template(id: "dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx") {
elementConnection {
templateElements {
id
elementType
ax
ay
bx
by
page
label
optional
signer
validation
value
}
totalCount
}
}
}
  • Template — the template these elements belong to
  • DocumentElement — the sent-document equivalent
  • Role — roles determine which signer sees which elements

Export This Article

Save a copy of this page as PDF or plain text.