Appearance
a11ydocs / FlowSignatureFieldOptions
Interface: FlowSignatureFieldOptions
Defined in: src/types.ts:1300
Options for placing a signature form field through the flow layout API.
Extends
Omit<SignatureFieldOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | SignatureFieldOptions.actions | src/types.ts:2895 |
appearance? | string | Custom appearance stream content for the signature field. Example: "1 0 0 rg 0 0 100 20 re f" | SignatureFieldOptions.appearance | src/types.ts:2890 |
borderWidth? | number | Annotation or field border width in PDF points. | SignatureFieldOptions.borderWidth | src/types.ts:2875 |
description? | string | Field description, emitted as /TU (the field's user-facing name). Assistive technology reads it as the field's accessible name, and it satisfies the "form fields have a description" accessibility check. | SignatureFieldOptions.description | src/types.ts:2865 |
encrypt? | boolean | Whether the field value follows document encryption. When false, the field value is not encrypted (useful for searchable fields). Defaults to true (follow document encryption). | SignatureFieldOptions.encrypt | src/types.ts:2885 |
height | number | Height in PDF points. | SignatureFieldOptions.height | src/types.ts:2873 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1137 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1143 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1145 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1141 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1139 |
readOnly? | boolean | Whether the form field is read-only. | SignatureFieldOptions.readOnly | src/types.ts:2877 |
required? | boolean | Whether the form field is required. | SignatureFieldOptions.required | src/types.ts:2879 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | SignatureFieldOptions.structure | src/types.ts:2899 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | SignatureFieldOptions.tag | src/types.ts:2897 |
width? | number | Width override in PDF points. | - | src/types.ts:1307 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1303 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1305 |