Bluestep JS Documentation
    Preparing search index...

    Interface CreateDocumentLinkThumbnailFieldProperties

    Properties for creating a document link thumbnail field.

    interface CreateDocumentLinkThumbnailFieldProperties {
        autoCopy?: boolean;
        columnSpan?: number;
        defaultFolder?: string;
        defaultValueType?: string;
        deleteRefrencedDocuments?: boolean;
        deprecated?: boolean;
        documentFormatType: "THUMBNAIL";
        fieldControlFieldTopId?: string;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        fieldControlView?: "READONLY"
        | "HIDDEN";
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        height: number;
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        longLabel?: boolean;
        name: string;
        neverHideHelpText?: boolean;
        openInline?: boolean;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        thumbnailFit?: "CROP_TO_FILL" | "SCALE_TO_FIT";
        typeScriptDeclarations?: string;
        useDocumentLibrary?: boolean;
        userUpdateable?: boolean;
        width: number;
    }

    Hierarchy (View Summary)

    Index
    autoCopy? columnSpan? defaultFolder? defaultValueType? deleteRefrencedDocuments? deprecated? documentFormatType fieldControlFieldTopId? fieldControlType? fieldControlValue? fieldControlView? formula? formulaId? frozen? height helpText? hiddenFromSupers? label? longLabel? name neverHideHelpText? openInline? popupHint? reportLabel? required? styleClass? thumbnailFit? typeScriptDeclarations? useDocumentLibrary? userUpdateable? width
    autoCopy?: boolean

    Whether to automatically copy this field's value when cloning a record

    columnSpan?: number

    How many of its row's columns this field spans: 0 for the whole row, 1-4 for that many columns. An explicit null clears it, leaving the field type's default placement. Read by layout clients; legacy form pages do not apply it.

    defaultFolder?: string

    The document field's typed default: the library folder uploads to this field are filed under, e.g. Intake/Scans (legacy's Default Folder). Any text is accepted, as legacy accepts it; a leading and trailing / are implied. It stores the same value as the generic defaultValue on updateRelateFieldWrapper, so a write through either one reads back through both. Null or an empty string removes it, filing uploads at the library's root.

    defaultValueType?: string

    Default document source type

    deleteRefrencedDocuments?: boolean

    Whether to delete uploaded documents when the record is deleted

    deprecated?: boolean

    Whether this field is deprecated and hidden from new configurations

    documentFormatType: "THUMBNAIL"

    Format type discriminant.

    fieldControlFieldTopId?: string

    ID of the field a CUSTOM fieldControlType watches: another checkbox, radio, signature or single-select field on the same form. Null or an empty ID removes it.

    fieldControlType?:
        | "NORMAL"
        | "HIDDEN_DEFAULT"
        | "READONLY_DEFAULT"
        | "SMART_HIDE"
        | "READONLY_WHEN_COMPLETED"
        | "CUSTOM"

    Visibility/editability control mode for this field

    fieldControlValue?: string

    The watched field's value at which a CUSTOM fieldControlType applies: true or false for a checkbox or radio, signed or unsigned for a signature, one of its option IDs for a single-select (an empty string, accepted for legacy compatibility, stores no value).

    fieldControlView?: "READONLY" | "HIDDEN"

    What a CUSTOM fieldControlType does to this field while its condition holds. A header, spacer, static content or merge report field can only be HIDDEN, which writing its condition stores.

    formula?: string

    BlueStep formula expression for computed field values

    formulaId?: string

    Optional script/merge variable name (the 'Field Identifier' in the admin UI) used to reference this field from formula, endpoint, and merge-report code. Leave unset for a data-entry-only field that is not referenced from code — like the UI, it is not required.

    frozen?: boolean

    Whether this field is locked from editing by non-admin users

    height: number

    Thumbnail height in pixels (16-400)

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    label?: string

    Display label shown to users on the form

    longLabel?: boolean

    Whether the label spans the full width above the field instead of beside it

    name: string

    Field name.

    neverHideHelpText?: boolean

    Whether to always show help text (never collapse it)

    openInline?: boolean

    Whether to display the document inline instead of as a download link

    popupHint?: boolean

    Whether to show help text as a popup tooltip instead of inline

    reportLabel?: string

    Alternate label used in reports and exports

    required?: boolean

    Whether this field must have a value before the record can be saved

    styleClass?: string

    CSS class name(s) applied to the field for custom styling

    thumbnailFit?: "CROP_TO_FILL" | "SCALE_TO_FIT"

    How the image fills the width x height frame when their aspect ratios differ: CROP_TO_FILL covers the frame and clips the overflow (Zoom & Crop), SCALE_TO_FIT shows the whole image and leaves the rest of the frame empty (Show Entire Image). Reads CROP_TO_FILL when never set. Cannot be cleared: an explicit null is refused. Honoured by API clients only; legacy pages ignore it and always shrink the image to fit inside the frame.

    typeScriptDeclarations?: string

    Type script declarations

    useDocumentLibrary?: boolean

    Whether to allow selecting from the shared document library

    userUpdateable?: boolean

    Whether end users can edit this field value (false = system-managed)

    width: number

    Thumbnail width in pixels (16-600)

    Settings
    Member Visibility

    On This Page
    Properties