Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Row

数据源的行对象

Hierarchy

  • Row

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Row(mapValues?: any, rowId?: string, state?: RowState): Row

  • Parameters

    • Optional mapValues: any

      字段与值的map对象 {f1:value1,f2:v2......}

    • Optional rowId: string

      记录的唯一id

    • state: RowState = ...

      记录的初始状态

    Returns Row

Properties

Private __state

__state: RowState

记录的

Private checked

checked: boolean

选择 主要用于界面的对于记录的选择

Private data

data: object

行的数据

Private dataSource

dataSource: DataSourceBase

数据源

Private editing

editing: boolean

是否在编辑

Private error

error: {} = ...

错误

Type declaration

Private extralParams

extralParams: object = ...

附带额外的参数. 用于参数的传递 注意参数的名称不要与列名重复否则会出现覆盖列的行值

Private guid

guid: string

记录的全球唯一id

Private hide

hide: boolean

隐藏

Private id

id: string

记录的id

Private isModify

isModify: boolean

是否被修改过

Private keys

keys: string[]

主键字段名数组

Private original

original: object

保存着被更改的原值

Private raw

raw: object

原始行的数据

Static ROWPARAM

ROWPARAM: string = '__row'

页面的行参数名

Methods

beginEdit

  • beginEdit(): void

  • 开始编辑

    Returns void

cancelEdit

  • cancelEdit(): void

  • 退出编辑

    Returns void

clearError

  • clearError(): void

  • 清楚行的错误

    Returns void

clearErrorByField

  • clearErrorByField(fieldName: string): void

  • 清楚行的错误

    Parameters

    • fieldName: string

      字段编号

    Returns void

clearExtralParams

  • clearExtralParams(): void

  • 清理额外的参数对象

    Returns void

cloneTo

  • 把行复制到指定的数据源

    Parameters

    Returns Row

    返回行的克隆实例

commit

  • commit(silent: boolean): void

  • 本地提交修改,注意这个函数会清空原数据导致无法提交,只是本地数据合并

    Parameters

    • silent: boolean

      是否触发数据源的事件

    Returns void

copy

  • copy(newId?: any): Row

  • 拷贝

    Parameters

    • Optional newId: any

      可选参数,否则复制一模一样的

    Returns Row

    返回行的克隆实例

endEdit

  • endEdit(): void

  • 结束编辑 如果存在修改数据，触发编辑结束事件

    Returns void

get

  • get(fieldName: string): any

  • 获取行字段数据值

    Parameters

    • fieldName: string

      字段名

    Returns any

    返回当前行的字段的值;受format 影响.如果field的设置的格式则反回格式化的值(对于时间/数字类型回如果设置了format只会返回string) 否则返回原始的数据类型的值.

getChanges

  • Returns IChangeData

    返回带有状态的修改的数据对象

Private getChangesObj

  • getChangesObj(): {}

  • 获取所有修改的值对象

    Returns {}

    返回修改的数据对象

getCheck

  • getCheck(): boolean

  • 返回行是否被选定

    Returns boolean

    true被选定,则反之

getDataSource

  • 得到数据源

    Returns DataSourceBase

    关联的数据源实例

getDatas

  • getDatas(): {}

  • 获取数据 这个是返回带有格式化后的数据 一般是用户展示界面时候使用

    Returns {}

    返回数据对象 {field1:1,field2:2,field3:3}

getError

  • 得到列的编辑错误对象

    Parameters

    • fieldName: string

      字段编号

    Returns IRowFieldError

    返回对应的错误对象

getErrorByRow

  • getErrorByRow(fieldName: string): string

  • 得到类的对应行的编辑错误信息

    Parameters

    • fieldName: string

      字段编号

    Returns string

    返回对应的错误信息

getErrors

  • 得到行的所有错误对象

    Returns IRowFieldError[]

    行的所有错误对象数组

getExtralParams

  • getExtralParams(): object

  • 得到额外参数 用于提交时候附带到服务器端的参数

    Returns object

    额外参数

getField

  • getField(fieldName: string): IField

  • 获取字段实例

    Parameters

    • fieldName: string

      字段名

    Returns IField

    返回指定列的实例

getGuid

  • getGuid(): string

  • 行的全球唯一ID

    Returns string

    全球唯一ID字符串

getHide

  • getHide(): boolean

  • 返回行是否隐藏,组件的显示会用到

    Returns boolean

    true 隐藏/ false 显示

getId

  • getId(): any

  • 获取行的主键值

    Returns any

    返回行的主键值,返回空说明无主键

getIsModify

  • getIsModify(): (fieldName: string) => boolean

  • 获取行是否被修改过.

    Returns (fieldName: string) => boolean

    true 修改过.否则返回false

      • (fieldName: string): boolean

      • 字段是否被修改

        Parameters

        • fieldName: string

          字段是否存修改过

        Returns boolean

        true修改过, 否则没被修改过

getKeys

  • getKeys(): string[]

  • 得到数据源的主键字段数组

    Returns string[]

    返回主键字段数组

getOriginalData

  • getOriginalData(): object

  • 得到行的未修改之前的数据数组

    Returns object

    返回未修改之前的数据数组

getRaw

  • getRaw(fieldName: string): any

  • 获取行字段数据值,不受format的影响

    Parameters

    • fieldName: string

      字段名

    Returns any

    返回当前行的字段的值.不受format 影响.

getRawData

  • getRawData(): object

  • 获取原始数据

    Returns object

    原始数据 {field1:1,field2:2,field3:3}

getState

  • 获取行state

    Returns RowState

    返回行的状态 (none,insert,update,delete )

getValue

  • getValue(fieldName: string): any

  • 获取对应的字段的数据的值

    Parameters

    • fieldName: string

      字段名

    Returns any

    返回字段的值 时间类型就返回时间,数字类型就返回数字 不受format 影响.

Private getdbValue

  • getdbValue(value: any): any

  • 得到后台数据库的值,

    1. 过滤掉undefined=>null ,"" =>null;
    2. 把 _.isObject(value) && !Common.isDate(value) 对象和数组 变成字符串

    Parameters

    • value: any

      值

    Returns any

    返回的过滤后的值

hasError

  • hasError(): boolean

  • 行是否存在错误

    Returns boolean

    返回true 说明行存在错误.

isModified

  • isModified(fieldName: string): boolean

  • 字段是否被修改

    Parameters

    • fieldName: string

      字段是否存修改过

    Returns boolean

    true修改过, 否则没被修改过

join

  • 关联数据源

    Parameters

    Returns void

reject

  • reject(isSilent: boolean): void

  • 取消行的所有的修改

    Parameters

    • isSilent: boolean

      是否触发数据源的事件

    Returns void

set

  • set(fieldName: string, value: any): void

  • 设置某个字段数据的值

    Parameters

    • fieldName: string

      字段名

    • value: any

      字段的值

    Returns void

setCheck

  • setCheck(value: boolean): void

  • 设置行是否被选定

    Parameters

    • value: boolean

      true说明被选定,则反之

    Returns void

setError

  • setError(fieldName: string, errValue: string, error: string): void

  • 设置错误

    Parameters

    • fieldName: string

      字段编号

    • errValue: string

      错误的值

    • error: string

      错误信息

    Returns void

setExtralParams

  • setExtralParams(param: object): void

  • 设置附带额外的参数.

    Parameters

    • param: object

      参数对象

    Returns void

setHide

  • setHide(hide: boolean): void

  • 设置行是否隐藏

    Parameters

    • hide: boolean

      true 隐藏/ false 显示

    Returns void

Private setIsModify

  • setIsModify(value: any): void

  • 设置是否被修改

    Parameters

    • value: any

      true标记记录已经被修改.则反之

    Returns void

setRawData

  • setRawData(obj: object): void

  • 保存最原始的数据

    Parameters

    • obj: object

      原始数据源对象

    Returns void

setState

  • 设置行的状态

    Parameters

    Returns void

setValues

  • setValues(data: object): void

  • 设置多个字段值

    Parameters

    • data: object

      数据值对象 {field1: value1,field2:value2}

    Returns void

updateChanges

  • 把变动的数据更新到行

    Parameters

    Returns void

Generated using TypeDoc