DocField class

Class containing properties of a docField. In addition, it contains helper functions for frappe docs.

Inheritance

• Object
• JSONAble
• RenovationDocument
• FrappeDocument
• DocField

Annotations

• @JsonSerializable()

Constructors

DocField()

DocField.fromJson(Map<String, dynamic>? json)

factory

Properties

allowBulkEdit ↔ bool?

getter/setter pair

allowInQuickEntry ↔ bool?

getter/setter pair

allowOnSubmit ↔ bool?

getter/setter pair

amendedFrom ↔ String?

getter/setter pair, inherited

bold ↔ bool?

getter/setter pair

collapsible ↔ bool?

Whether the field is collapsible in the UI

getter/setter pair

collapsibleDependsOn ↔ String?

getter/setter pair

columns ↔ int?

getter/setter pair

creation ↔ DateTime?

getter/setter pair, inherited

defaults ↔ String?

getter/setter pair

dependsOn ↔ String?

getter/setter pair

description ↔ String?

getter/setter pair

docFieldTypes ↔ List<String>

getter/setter pair

docStatus ↔ FrappeDocStatus?

getter/setter pair, inherited

doctype ↔ String?

getter/setter pair, inherited

fetchFrom ↔ String?

getter/setter pair

fetchIfEmpty ↔ bool?

getter/setter pair

fieldName ↔ String?

The name of the field which is the field's identifier

getter/setter pair

fieldType ↔ String?

The type of the fields defined in frappe such as Data, Link, Select, etc

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

hidden ↔ bool?

Whether the field is hidden

getter/setter pair

idx ↔ int?

getter/setter pair, inherited

ignoreUserPermissions ↔ bool?

getter/setter pair

ignoreXssFilter ↔ bool?

getter/setter pair

inFilter ↔ bool?

getter/setter pair

inGlobalSearch ↔ bool?

getter/setter pair

inListView ↔ bool?

Whether the field should appear in the list view of the doctype

getter/setter pair

inPreview ↔ bool?

getter/setter pair

inStandardFilter ↔ bool?

Whether to include the field in the default filters appearing in list view, for instance

getter/setter pair

isCustomField ↔ bool?

getter/setter pair

isLocal ↔ bool?

getter/setter pair, inherited

label ↔ String?

The human readable label of the field

getter/setter pair

length ↔ int?

getter/setter pair

linkedDocumentType ↔ String?

getter/setter pair

modified ↔ DateTime?

getter/setter pair, inherited

modifiedBy ↔ String?

getter/setter pair, inherited

name ↔ String?

getter/setter pair, inherited

noCopy ↔ bool?

getter/setter pair

oldFieldName ↔ String?

getter/setter pair

oldFieldType ↔ String?

getter/setter pair

options ↔ String?

Options contained for the docField.

getter/setter pair

owner ↔ String?

getter/setter pair, inherited

parent ↔ String?

getter/setter pair, inherited

parentField ↔ String?

getter/setter pair, inherited

parentType ↔ String?

getter/setter pair, inherited

permLevel ↔ int?

getter/setter pair

precision ↔ String?

getter/setter pair

printHide ↔ bool?

getter/setter pair

printHideIfNoValue ↔ bool?

getter/setter pair

printWidth ↔ String?

getter/setter pair

rawResponse ↔ Map<String, dynamic>?

getter/setter pair, inherited

readOnly ↔ bool?

Whether the field is not editable and just read-only

getter/setter pair

rememberLastSelectedValue ↔ bool?

getter/setter pair

reportHide ↔ bool?

getter/setter pair

required ↔ bool?

Whether the field is mandatory

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchFields ↔ List?

getter/setter pair

searchIndex ↔ bool?

getter/setter pair

setOnlyOnce ↔ bool?

getter/setter pair

showPreviewPopup ↔ bool?

getter/setter pair

translatable ↔ bool?

Whether the field is translatable

getter/setter pair

trigger ↔ String?

getter/setter pair

unique ↔ bool?

getter/setter pair

unsaved ↔ bool?

getter/setter pair, inherited

width ↔ String?

getter/setter pair

Methods

deserializeList<T>(List? docs) → List<T>?

inherited

fromJson<T>(Map<String, dynamic>? json) → T

Returns the target type from json (Map)

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Returns the JSON representation of a type in the form of Map

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited