Interface DocType

interface DocType {
    actions?: DocTypeAction[];
    actions_section?: void;
    advanced?: void;
    allow_auto_repeat?: boolean;
    allow_copy?: boolean;
    allow_events_in_timeline?: boolean;
    allow_guest_to_view?: boolean;
    allow_import?: boolean;
    allow_rename?: boolean;
    autoname?: string;
    beta?: boolean;
    cb01?: void;
    color?: string;
    column_break_15?: void;
    column_break_23?: void;
    column_break_29?: void;
    column_break_51?: void;
    connections_tab?: void;
    creation?: string;
    custom?: boolean;
    default_email_template?: string;
    default_print_format?: string;
    default_view?: string;
    description?: string;
    docstatus?: number;
    doctype?: string;
    document_states_section?: void;
    document_type?:
        | ""
        | "Document"
        | "Setup"
        | "System"
        | "Other";
    documentation?: string;
    editable_grid?: boolean;
    email_append_to?: boolean;
    email_settings_sb?: void;
    engine?: "InnoDB" | "MyISAM";
    fields?: DocField[];
    fields_section?: void;
    force_re_route_to_default_view?: boolean;
    form_builder?: string;
    form_builder_tab?: void;
    form_settings_section?: void;
    has_web_view?: boolean;
    hide_toolbar?: boolean;
    icon?: string;
    idx?: number;
    image_field?: string;
    in_create?: boolean;
    index_web_pages_for_search?: boolean;
    is_calendar_and_gantt?: boolean;
    is_published_field?: string;
    is_submittable?: boolean;
    is_tree?: boolean;
    is_virtual?: boolean;
    issingle?: boolean;
    istable?: boolean;
    links?: DocTypeLink[];
    links_section?: void;
    make_attachments_public?: boolean;
    max_attachments?: number;
    migration_hash?: string;
    modified?: string;
    modified_by?: string;
    module: string;
    name?: string;
    naming_rule?:
        | ""
        | "Set by user"
        | "Autoincrement"
        | "By fieldname"
        | "By \"Naming Series\" field"
        | "Expression"
        | "Expression (old style)"
        | "Random"
        | "By script";
    nsm_parent_field?: string;
    owner?: string;
    parent?: string;
    parentfield?: string;
    parenttype?: string;
    permissions?: DocPerm[];
    queue_in_background?: boolean;
    quick_entry?: boolean;
    read_only?: boolean;
    restrict_to_domain?: string;
    route?: string;
    sb0?: void;
    sb1?: void;
    sb2?: void;
    search_fields?: string;
    sender_field?: string;
    sender_name_field?: string;
    settings_tab?: void;
    show_name_in_global_search?: boolean;
    show_preview_popup?: boolean;
    show_title_field_in_link?: boolean;
    sort_field?: string;
    sort_order?: "ASC" | "DESC";
    states?: DocTypeState[];
    subject_field?: string;
    timeline_field?: string;
    title_field?: string;
    track_changes?: boolean;
    track_seen?: boolean;
    track_views?: boolean;
    translated_doctype?: boolean;
    view_settings?: void;
    web_view?: void;
    website_search_field?: string;
}

Properties

actions? actions_section? advanced? allow_auto_repeat? allow_copy? allow_events_in_timeline? allow_guest_to_view? allow_import? allow_rename? autoname? beta? cb01? color? column_break_15? column_break_23? column_break_29? column_break_51? connections_tab? creation? custom? default_email_template? default_print_format? default_view? description? docstatus? doctype? document_states_section? document_type? documentation? editable_grid? email_append_to? email_settings_sb? engine? fields? fields_section? force_re_route_to_default_view? form_builder? form_builder_tab? form_settings_section? has_web_view? hide_toolbar? icon? idx? image_field? in_create? index_web_pages_for_search? is_calendar_and_gantt? is_published_field? is_submittable? is_tree? is_virtual? issingle? istable? links? links_section? make_attachments_public? max_attachments? migration_hash? modified? modified_by? module name? naming_rule? nsm_parent_field? owner? parent? parentfield? parenttype? permissions? queue_in_background? quick_entry? read_only? restrict_to_domain? route? sb0? sb1? sb2? search_fields? sender_field? sender_name_field? settings_tab? show_name_in_global_search? show_preview_popup? show_title_field_in_link? sort_field? sort_order? states? subject_field? timeline_field? title_field? track_changes? track_seen? track_views? translated_doctype? view_settings? web_view? website_search_field?

Properties

Optionalactions

actions?: DocTypeAction[]

Optionalactions_section

actions_section?: void

Optionaladvanced

advanced?: void

Optionalallow_auto_repeat

allow_auto_repeat?: boolean

Optionalallow_copy

allow_copy?: boolean

Optionalallow_events_in_timeline

allow_events_in_timeline?: boolean

Optionalallow_guest_to_view

allow_guest_to_view?: boolean

Optionalallow_import

allow_import?: boolean

Optionalallow_rename

allow_rename?: boolean

Optionalautoname

autoname?: string

Optionalbeta

beta?: boolean

Optionalcb01

cb01?: void

Optionalcolor

color?: string

Optionalcolumn_break_15

column_break_15?: void

Optionalcolumn_break_23

column_break_23?: void

Optionalcolumn_break_29

column_break_29?: void

Optionalcolumn_break_51

column_break_51?: void

Optionalconnections_tab

connections_tab?: void

Optionalcreation

creation?: string

Optionalcustom

custom?: boolean

Optionaldefault_email_template

default_email_template?: string

Optionaldefault_print_format

default_print_format?: string

Optionaldefault_view

default_view?: string

Optionaldescription

description?: string

Optionaldocstatus

docstatus?: number

Optionaldoctype

doctype?: string

Optionaldocument_states_section

document_states_section?: void

Optionaldocument_type

document_type?:
    | ""
    | "Document"
    | "Setup"
    | "System"
    | "Other"

Optionaldocumentation

documentation?: string

Optionaleditable_grid

editable_grid?: boolean

Optionalemail_append_to

email_append_to?: boolean

Optionalemail_settings_sb

email_settings_sb?: void

Optionalengine

engine?: "InnoDB" | "MyISAM"

Optionalfields

fields?: DocField[]

Optionalfields_section

fields_section?: void

Optionalforce_re_route_to_default_view

force_re_route_to_default_view?: boolean

Optionalform_builder

form_builder?: string

Optionalform_builder_tab

form_builder_tab?: void

Optionalform_settings_section

form_settings_section?: void

Optionalhas_web_view

has_web_view?: boolean

Optionalhide_toolbar

hide_toolbar?: boolean

Optionalicon

icon?: string

Optionalidx

idx?: number

Optionalimage_field

image_field?: string

Optionalin_create

in_create?: boolean

Optionalindex_web_pages_for_search

index_web_pages_for_search?: boolean

Optionalis_calendar_and_gantt

is_calendar_and_gantt?: boolean

Optionalis_published_field

is_published_field?: string

Optionalis_submittable

is_submittable?: boolean

Optionalis_tree

is_tree?: boolean

Optionalis_virtual

is_virtual?: boolean

Optionalissingle

issingle?: boolean

Optionalistable

istable?: boolean

Optionallinks

links?: DocTypeLink[]

Optionallinks_section

links_section?: void

Optionalmake_attachments_public

make_attachments_public?: boolean

Optionalmax_attachments

max_attachments?: number

Optionalmigration_hash

migration_hash?: string

Optionalmodified

modified?: string

Optionalmodified_by

modified_by?: string

module

module: string

Optionalname

name?: string

Optionalnaming_rule

naming_rule?:
    | ""
    | "Set by user"
    | "Autoincrement"
    | "By fieldname"
    | "By \"Naming Series\" field"
    | "Expression"
    | "Expression (old style)"
    | "Random"
    | "By script"

Optionalnsm_parent_field

nsm_parent_field?: string

Optionalowner

owner?: string

Optionalparent

parent?: string

Optionalparentfield

parentfield?: string

Optionalparenttype

parenttype?: string

Optionalpermissions

permissions?: DocPerm[]

Optionalqueue_in_background

queue_in_background?: boolean

Optionalquick_entry

quick_entry?: boolean

Optionalread_only

read_only?: boolean

Optionalrestrict_to_domain

restrict_to_domain?: string

Optionalroute

route?: string

Optionalsb0

sb0?: void

Optionalsb1

sb1?: void

Optionalsb2

sb2?: void

Optionalsearch_fields

search_fields?: string

Optionalsender_field

sender_field?: string

Optionalsender_name_field

sender_name_field?: string

Optionalsettings_tab

settings_tab?: void

Optionalshow_name_in_global_search

show_name_in_global_search?: boolean

Optionalshow_preview_popup

show_preview_popup?: boolean

Optionalshow_title_field_in_link

show_title_field_in_link?: boolean

Optionalsort_field

sort_field?: string

Optionalsort_order

sort_order?: "ASC" | "DESC"

Optionalstates

states?: DocTypeState[]

Optionalsubject_field

subject_field?: string

Optionaltimeline_field

timeline_field?: string

Optionaltitle_field

title_field?: string

Optionaltrack_changes

track_changes?: boolean

Optionaltrack_seen

track_seen?: boolean

Optionaltrack_views

track_views?: boolean

Optionaltranslated_doctype

translated_doctype?: boolean

Optionalview_settings

view_settings?: void

Optionalweb_view

web_view?: void

Optionalwebsite_search_field

website_search_field?: string

Settings

Member Visibility

On This Page

Properties
actionsactions_sectionadvancedallow_auto_repeatallow_copyallow_events_in_timelineallow_guest_to_viewallow_importallow_renameautonamebetacb01colorcolumn_break_15column_break_23column_break_29column_break_51connections_tabcreationcustomdefault_email_templatedefault_print_formatdefault_viewdescriptiondocstatusdoctypedocument_states_sectiondocument_typedocumentationeditable_gridemail_append_toemail_settings_sbenginefieldsfields_sectionforce_re_route_to_default_viewform_builderform_builder_tabform_settings_sectionhas_web_viewhide_toolbariconidximage_fieldin_createindex_web_pages_for_searchis_calendar_and_ganttis_published_fieldis_submittableis_treeis_virtualissingleistablelinkslinks_sectionmake_attachments_publicmax_attachmentsmigration_hashmodifiedmodified_bymodulenamenaming_rulensm_parent_fieldownerparentparentfieldparenttypepermissionsqueue_in_backgroundquick_entryread_onlyrestrict_to_domainroutesb0sb1sb2search_fieldssender_fieldsender_name_fieldsettings_tabshow_name_in_global_searchshow_preview_popupshow_title_field_in_linksort_fieldsort_orderstatessubject_fieldtimeline_fieldtitle_fieldtrack_changestrack_seentrack_viewstranslated_doctypeview_settingsweb_viewwebsite_search_field