Interface DocField

interface DocField {
    allow_bulk_edit?: boolean;
    allow_in_quick_entry?: boolean;
    allow_on_submit?: boolean;
    bold?: boolean;
    collapsible?: boolean;
    collapsible_depends_on?: string;
    column_break_13?: void;
    column_break_18?: void;
    column_break_22?: void;
    column_break_28?: void;
    column_break_35?: void;
    column_break_38?: void;
    column_break_6?: void;
    columns?: number;
    constraints_section?: void;
    creation?: string;
    default?: string;
    defaults_section?: void;
    depends_on?: string;
    description?: string;
    display?: void;
    docstatus?: number;
    doctype?: string;
    documentation_url?: string;
    fetch_from?: string;
    fetch_if_empty?: boolean;
    fieldname?: string;
    fieldtype:
        | "Autocomplete"
        | "Attach"
        | "Attach Image"
        | "Barcode"
        | "Button"
        | "Check"
        | "Code"
        | "Color"
        | "Column Break"
        | "Currency"
        | "Data"
        | "Date"
        | "Datetime"
        | "Duration"
        | "Dynamic Link"
        | "Float"
        | "Fold"
        | "Geolocation"
        | "Heading"
        | "HTML"
        | "HTML Editor"
        | "Icon"
        | "Image"
        | "Int"
        | "JSON"
        | "Link"
        | "Long Text"
        | "Markdown Editor"
        | "Password"
        | "Percent"
        | "Phone"
        | "Read Only"
        | "Rating"
        | "Section Break"
        | "Select"
        | "Signature"
        | "Small Text"
        | "Tab Break"
        | "Table"
        | "Table MultiSelect"
        | "Text"
        | "Text Editor"
        | "Time";
    hidden?: boolean;
    hide_border?: boolean;
    hide_days?: boolean;
    hide_seconds?: boolean;
    idx?: number;
    ignore_user_permissions?: boolean;
    ignore_xss_filter?: boolean;
    in_filter?: boolean;
    in_global_search?: boolean;
    in_list_view?: boolean;
    in_preview?: boolean;
    in_standard_filter?: boolean;
    is_virtual?: boolean;
    label?: string;
    label_and_type?: void;
    length?: number;
    link_filters?: string;
    list__search_settings_section?: void;
    mandatory_depends_on?: string;
    max_height?: string;
    modified?: string;
    modified_by?: string;
    name?: string;
    no_copy?: boolean;
    non_negative?: boolean;
    oldfieldname?: string;
    oldfieldtype?: string;
    options?: string;
    owner?: string;
    parent?: string;
    parentfield?: string;
    parenttype?: string;
    permissions?: void;
    permlevel?: number;
    precision?:
        | ""
        | "0"
        | "1"
        | "2"
        | "3"
        | "4"
        | "5"
        | "6"
        | "7"
        | "8"
        | "9";
    print_hide?: boolean;
    print_hide_if_no_value?: boolean;
    print_width?: string;
    read_only?: boolean;
    read_only_depends_on?: string;
    remember_last_selected_value?: boolean;
    report_hide?: boolean;
    reqd?: boolean;
    search_index?: boolean;
    set_only_once?: boolean;
    show_dashboard?: boolean;
    sort_options?: boolean;
    translatable?: boolean;
    unique?: boolean;
    visibility_section?: void;
    width?: string;
}

Properties

allow_bulk_edit? allow_in_quick_entry? allow_on_submit? bold? collapsible? collapsible_depends_on? column_break_13? column_break_18? column_break_22? column_break_28? column_break_35? column_break_38? column_break_6? columns? constraints_section? creation? default? defaults_section? depends_on? description? display? docstatus? doctype? documentation_url? fetch_from? fetch_if_empty? fieldname? fieldtype hidden? hide_border? hide_days? hide_seconds? idx? ignore_user_permissions? ignore_xss_filter? in_filter? in_global_search? in_list_view? in_preview? in_standard_filter? is_virtual? label? label_and_type? length? link_filters? list__search_settings_section? mandatory_depends_on? max_height? modified? modified_by? name? no_copy? non_negative? oldfieldname? oldfieldtype? options? owner? parent? parentfield? parenttype? permissions? permlevel? precision? print_hide? print_hide_if_no_value? print_width? read_only? read_only_depends_on? remember_last_selected_value? report_hide? reqd? search_index? set_only_once? show_dashboard? sort_options? translatable? unique? visibility_section? width?

Properties

Optionalallow_bulk_edit

allow_bulk_edit?: boolean

Optionalallow_in_quick_entry

allow_in_quick_entry?: boolean

Optionalallow_on_submit

allow_on_submit?: boolean

Optionalbold

bold?: boolean

Optionalcollapsible

collapsible?: boolean

Optionalcollapsible_depends_on

collapsible_depends_on?: string

Optionalcolumn_break_13

column_break_13?: void

Optionalcolumn_break_18

column_break_18?: void

Optionalcolumn_break_22

column_break_22?: void

Optionalcolumn_break_28

column_break_28?: void

Optionalcolumn_break_35

column_break_35?: void

Optionalcolumn_break_38

column_break_38?: void

Optionalcolumn_break_6

column_break_6?: void

Optionalcolumns

columns?: number

Optionalconstraints_section

constraints_section?: void

Optionalcreation

creation?: string

Optionaldefault

default?: string

Optionaldefaults_section

defaults_section?: void

Optionaldepends_on

depends_on?: string

Optionaldescription

description?: string

Optionaldisplay

display?: void

Optionaldocstatus

docstatus?: number

Optionaldoctype

doctype?: string

Optionaldocumentation_url

documentation_url?: string

Optionalfetch_from

fetch_from?: string

Optionalfetch_if_empty

fetch_if_empty?: boolean

Optionalfieldname

fieldname?: string

fieldtype

fieldtype:
    | "Autocomplete"
    | "Attach"
    | "Attach Image"
    | "Barcode"
    | "Button"
    | "Check"
    | "Code"
    | "Color"
    | "Column Break"
    | "Currency"
    | "Data"
    | "Date"
    | "Datetime"
    | "Duration"
    | "Dynamic Link"
    | "Float"
    | "Fold"
    | "Geolocation"
    | "Heading"
    | "HTML"
    | "HTML Editor"
    | "Icon"
    | "Image"
    | "Int"
    | "JSON"
    | "Link"
    | "Long Text"
    | "Markdown Editor"
    | "Password"
    | "Percent"
    | "Phone"
    | "Read Only"
    | "Rating"
    | "Section Break"
    | "Select"
    | "Signature"
    | "Small Text"
    | "Tab Break"
    | "Table"
    | "Table MultiSelect"
    | "Text"
    | "Text Editor"
    | "Time"

Optionalhidden

hidden?: boolean

Optionalhide_border

hide_border?: boolean

Optionalhide_days

hide_days?: boolean

Optionalhide_seconds

hide_seconds?: boolean

Optionalidx

idx?: number

Optionalignore_user_permissions

ignore_user_permissions?: boolean

Optionalignore_xss_filter

ignore_xss_filter?: boolean

Optionalin_filter

in_filter?: boolean

Optionalin_global_search

in_global_search?: boolean

Optionalin_list_view

in_list_view?: boolean

Optionalin_preview

in_preview?: boolean

Optionalin_standard_filter

in_standard_filter?: boolean

Optionalis_virtual

is_virtual?: boolean

Optionallabel

label?: string

Optionallabel_and_type

label_and_type?: void

Optionallength

length?: number

Optionallink_filters

link_filters?: string

Optionallist__search_settings_section

list__search_settings_section?: void

Optionalmandatory_depends_on

mandatory_depends_on?: string

Optionalmax_height

max_height?: string

Optionalmodified

modified?: string

Optionalmodified_by

modified_by?: string

Optionalname

name?: string

Optionalno_copy

no_copy?: boolean

Optionalnon_negative

non_negative?: boolean

Optionaloldfieldname

oldfieldname?: string

Optionaloldfieldtype

oldfieldtype?: string

Optionaloptions

options?: string

Optionalowner

owner?: string

Optionalparent

parent?: string

Optionalparentfield

parentfield?: string

Optionalparenttype

parenttype?: string

Optionalpermissions

permissions?: void

Optionalpermlevel

permlevel?: number

Optionalprecision

precision?:
    | ""
    | "0"
    | "1"
    | "2"
    | "3"
    | "4"
    | "5"
    | "6"
    | "7"
    | "8"
    | "9"

Optionalprint_hide

print_hide?: boolean

Optionalprint_hide_if_no_value

print_hide_if_no_value?: boolean

Optionalprint_width

print_width?: string

Optionalread_only

read_only?: boolean

Optionalread_only_depends_on

read_only_depends_on?: string

Optionalremember_last_selected_value

remember_last_selected_value?: boolean

Optionalreport_hide

report_hide?: boolean

Optionalreqd

reqd?: boolean

Optionalsearch_index

search_index?: boolean

Optionalset_only_once

set_only_once?: boolean

Optionalshow_dashboard

show_dashboard?: boolean

Optionalsort_options

sort_options?: boolean

Optionaltranslatable

translatable?: boolean

Optionalunique

unique?: boolean

Optionalvisibility_section

visibility_section?: void

Optionalwidth

width?: string

Settings

Member Visibility

On This Page

Properties
allow_bulk_editallow_in_quick_entryallow_on_submitboldcollapsiblecollapsible_depends_oncolumn_break_13column_break_18column_break_22column_break_28column_break_35column_break_38column_break_6columnsconstraints_sectioncreationdefaultdefaults_sectiondepends_ondescriptiondisplaydocstatusdoctypedocumentation_urlfetch_fromfetch_if_emptyfieldnamefieldtypehiddenhide_borderhide_dayshide_secondsidxignore_user_permissionsignore_xss_filterin_filterin_global_searchin_list_viewin_previewin_standard_filteris_virtuallabellabel_and_typelengthlink_filterslist__search_settings_sectionmandatory_depends_onmax_heightmodifiedmodified_bynameno_copynon_negativeoldfieldnameoldfieldtypeoptionsownerparentparentfieldparenttypepermissionspermlevelprecisionprint_hideprint_hide_if_no_valueprint_widthread_onlyread_only_depends_onremember_last_selected_valuereport_hidereqdsearch_indexset_only_onceshow_dashboardsort_optionstranslatableuniquevisibility_sectionwidth