|
- <!-- title: frappe.model.meta --><div class="dev-header">
-
- <a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
- Version 6.x.x</a>
-
-
- <a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/blob/develop/frappe/model/meta.py"
- target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
-
- </div>
-
-
-
-
-
-
-
- <h3 style="font-weight: normal;">Class <b>Meta</b></h3>
-
- <p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
-
- <div class="docs-attr-desc"><p></p>
- </div>
- <div style="padding-left: 30px;">
-
-
-
-
- <p class="docs-attr-name">
- <a name="__init__" href="#__init__" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>__init__</b>
- <i class="text-muted">(self, doctype)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="add_custom_fields" href="#add_custom_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>add_custom_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="apply_property_setters" href="#apply_property_setters" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>apply_property_setters</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_dynamic_link_fields" href="#get_dynamic_link_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_dynamic_link_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_field" href="#get_field" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_field</b>
- <i class="text-muted">(self, fieldname)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_fields_to_check_permissions" href="#get_fields_to_check_permissions" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_fields_to_check_permissions</b>
- <i class="text-muted">(self, user_permission_doctypes)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_high_permlevel_fields" href="#get_high_permlevel_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_high_permlevel_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p>Build list of fields with high perm level and all the higher perm levels defined.</p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_label" href="#get_label" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_label</b>
- <i class="text-muted">(self, fieldname)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_link_fields" href="#get_link_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_link_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_list_fields" href="#get_list_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_list_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_options" href="#get_options" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_options</b>
- <i class="text-muted">(self, fieldname)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_search_fields" href="#get_search_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_search_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_select_fields" href="#get_select_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_select_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_table_field_doctype" href="#get_table_field_doctype" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_table_field_doctype</b>
- <i class="text-muted">(self, fieldname)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_table_fields" href="#get_table_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_table_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_title_field" href="#get_title_field" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_title_field</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="get_valid_columns" href="#get_valid_columns" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>get_valid_columns</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="load_from_db" href="#load_from_db" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>load_from_db</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="process" href="#process" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>process</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="sort_fields" href="#sort_fields" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- <b>sort_fields</b>
- <i class="text-muted">(self)</i>
- </p>
- <div class="docs-attr-desc"><p>sort on basis of previous_field</p>
- </div>
- <br>
-
-
- </div>
- <hr>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.clear_cache" href="#frappe.model.meta.clear_cache" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>clear_cache</b>
- <i class="text-muted">(doctype=None)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.get_default_df" href="#frappe.model.meta.get_default_df" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>get_default_df</b>
- <i class="text-muted">(fieldname)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.get_field_currency" href="#frappe.model.meta.get_field_currency" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>get_field_currency</b>
- <i class="text-muted">(df, doc=None)</i>
- </p>
- <div class="docs-attr-desc"><p>get currency based on DocField options and fieldvalue in doc</p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.get_field_precision" href="#frappe.model.meta.get_field_precision" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>get_field_precision</b>
- <i class="text-muted">(df, doc=None, currency=None)</i>
- </p>
- <div class="docs-attr-desc"><p>get precision based on DocField options and fieldvalue in doc</p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.get_meta" href="#frappe.model.meta.get_meta" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>get_meta</b>
- <i class="text-muted">(doctype, cached=True)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.get_parent_dt" href="#frappe.model.meta.get_parent_dt" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>get_parent_dt</b>
- <i class="text-muted">(dt)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.get_table_columns" href="#frappe.model.meta.get_table_columns" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>get_table_columns</b>
- <i class="text-muted">(doctype)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.is_single" href="#frappe.model.meta.is_single" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>is_single</b>
- <i class="text-muted">(doctype)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.load_doctype_from_file" href="#frappe.model.meta.load_doctype_from_file" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>load_doctype_from_file</b>
- <i class="text-muted">(doctype)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.set_fieldname" href="#frappe.model.meta.set_fieldname" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>set_fieldname</b>
- <i class="text-muted">(field_id, fieldname)</i>
- </p>
- <div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
- </div>
- <br>
-
-
-
-
-
-
-
- <p class="docs-attr-name">
- <a name="frappe.model.meta.trim_tables" href="#frappe.model.meta.trim_tables" class="text-muted small">
- <i class="icon-link small" style="color: #ccc;"></i></a>
- frappe.model.meta.<b>trim_tables</b>
- <i class="text-muted">()</i>
- </p>
- <div class="docs-attr-desc"><p>Use this to remove columns that don't exist in meta</p>
- </div>
- <br>
-
-
-
-
-
- <!-- autodoc -->
|