Class DataGroup<TData, TProperty, TMethod>

constructor

• new DataGroup<TData, TProperty, TMethod>(associatedComponent, data, pureDataPattern, dataDeepCopy, propertyPassingDeepCopy, reflectToAttributes, observerTree): DataGroup<TData, TProperty, TMethod>

• Type Parameters

  • TData extends DataList
  • TProperty extends PropertyList
  • TMethod extends MethodList

  Parameters

  • associatedComponent: null | ComponentInstance<TData, TProperty, TMethod, Empty>
  • data: DataWithPropertyValues<TData, TProperty>
  • pureDataPattern: null | RegExp
  • dataDeepCopy: DeepCopyStrategy
  • propertyPassingDeepCopy: DeepCopyStrategy
  • reflectToAttributes: boolean
  • observerTree: DataGroupObserverTree

  Returns DataGroup<TData, TProperty, TMethod>

data

innerData

applyDataUpdates

• applyDataUpdates(skipModelListener?): void

• Apply all changes in queue

  Parameters

  • Optional skipModelListener: boolean

  Returns void

getChanges

• getChanges(): DataChange[]

• Get the data change queue

  Returns DataChange[]

replaceDataOnPath

• replaceDataOnPath(path, newData): void

• Add a new common data change to queue

  Parameters

  • path: DataPath
  • newData: unknown

  Returns void

replaceProperty

• replaceProperty(propName, newData): boolean

• Add a new property change to queue

  (Generally designed for template engines.) If the propName is a property, the newData will be deep-copied according to the propertyPassingDeepCopy configuration. Otherwise, it returns false.

  Parameters

  • propName: string
  • newData: unknown

  Returns boolean

replaceWholeData

• replaceWholeData(data): void

• Replace the underlying data

  Parameters

  • data: DataWithPropertyValues<TData, TProperty>

  Returns void

setChanges

• setChanges(changes): void

• Discard changes in queue and generate a new queue with specified changes

  Parameters

  • changes: DataChange[]

  Returns void

setModelBindingListener

• setModelBindingListener(propName, listener): void

• Set a callback when a specified property changes

  (Generally designed for template engines.)

  Parameters

  • propName: string
  • listener: ModelBindingListener

  Returns void

setUpdateListener

• setUpdateListener(updateListener): void

• Set a callback for every grouped update

  Parameters

  • updateListener: DataUpdateCallback

  Returns void

spliceArrayDataOnPath

• spliceArrayDataOnPath(path, index, del, inserts): void

• Add a new array splice operation to queue

  Parameters

  • path: DataPath
  • index: undefined | number
  • del: undefined | number
  • inserts: unknown[]

  Returns void

Static create

• create(data): DataGroup<any, PropertyList, MethodList>

• Create a simple data group

  Parameters

  • data: {
        [key: string]: DataValue;
    }

    • [key: string]: DataValue

  Returns DataGroup<any, PropertyList, MethodList>