@labkey/api
    Preparing search index...

    Interface MetadataField

    interface MetadataField {
        align?: string;
        autoIncrement: boolean;
        calculated: boolean;
        caption: string;
        defaultValue?: any;
        description?: string;
        dimension: boolean;
        displayField?: FieldKey;
        excelFormat?: string;
        excludeFromShifting?: boolean;
        extFormat?: string;
        extFormatFn?: Function;
        facetingBehaviorType?: string;
        fieldKey: FieldKey;
        friendlyType: string;
        getDisplayField?: GetDisplayField;
        hidden: boolean;
        importAliases?: string[];
        inputType?: string;
        jsonType: string;
        keyField: boolean;
        label?: string;
        lookup?: any;
        measure: boolean;
        mvEnabled: boolean;
        name: string;
        nullable: boolean;
        readOnly: boolean;
        recommendedVariable?: boolean;
        scale?: number;
        shortCaption: string;
        shownInDetailsView: boolean;
        shownInInsertView: boolean;
        shownInLookupView: boolean;
        shownInUpdateView: boolean;
        sortable: boolean;
        sqlType?: string;
        tsvFormat?: string;
        type: string;
        userEditable: boolean;
        width: number;
    }
    Index

    Properties

    align? autoIncrement calculated caption defaultValue? description? dimension displayField? excelFormat? excludeFromShifting? extFormat? extFormatFn? facetingBehaviorType? fieldKey friendlyType getDisplayField? hidden importAliases? inputType? jsonType keyField label? lookup? measure mvEnabled name nullable readOnly recommendedVariable? scale? shortCaption shownInDetailsView shownInInsertView shownInLookupView shownInUpdateView sortable sqlType? tsvFormat? type userEditable width

    Properties

    align?: string
    autoIncrement: boolean
    calculated: boolean
    caption: string
    defaultValue?: any
    description?: string

    Description of the underlying column

    dimension: boolean

    Whether this field is a dimension. Data dimensions define logical groupings of measures.

    displayField?: FieldKey

    If the field has a display field this is the field key for that field.

    excelFormat?: string
    excludeFromShifting?: boolean
    extFormat?: string
    extFormatFn?: Function
    facetingBehaviorType?: string
    fieldKey: FieldKey

    FieldKey for this field.

    friendlyType: string
    getDisplayField?: GetDisplayField

    If the field has a display field this function will return the metadata field object for that field.

    hidden: boolean

    Whether this field is hidden and not normally shown in grid views.

    importAliases?: string[]
    inputType?: string
    jsonType: string
    keyField: boolean
    label?: string
    lookup?: any

    If the field is a lookup, there will be four sub-properties listed under this property: schema, table, displayColumn, and keyColumn, which describe the schema, table, and display column, and key column of the lookup table (query).

    measure: boolean

    Whether this field is a measure. Measures are fields that contain data subject to charting and other analysis.

    mvEnabled: boolean
    name: string

    The name of the field.

    nullable: boolean
    readOnly: boolean
    recommendedVariable?: boolean
    scale?: number
    shortCaption: string
    shownInDetailsView: boolean

    Whether this field is intended to be shown in details views.

    shownInInsertView: boolean

    Whether this field is intended to be shown in insert views.

    shownInLookupView: boolean

    Whether this field is intended to be shown in lookup views.

    shownInUpdateView: boolean

    Whether this field is intended to be shown in update views.

    sortable: boolean
    sqlType?: string
    tsvFormat?: string
    type: string

    JavaScript type name of the field.

    userEditable: boolean
    width: number

    Settings

    Member Visibility

    On This Page

    Properties