Interface iAttributes

asObject

attr._a.addVal(<attributeName>, <attributeValue>)
Copy

asString

attrs

count

SetFromEval

• SetFromEval(attr): void

• Converts values from evaluation back to the attributes

  Warning: Used only for fEval method

  Parameters

  • attr: object

  Returns void

  Pararm

  Attr

  object with attribuets create by asObject function

add

• add(attr, ignoreGroup?, newOnly?): void

• Add atribute to the list of attributes. Changes value of existintg atrribute, if there is alrady attributes of the given name and group

  • Important: Passed attributes are put to the list od attributes. By default it does not create a new instance of them - be carefull about that! User copyAttributes if copy requested

  Parameters

  • attr: iAttribute | iAttribute[]

    single attribute or list of attributes, if list provided, each attribute is copied
  • Optional ignoreGroup: boolean

    optional, if true attribute is searched only by name and the group is disregarded; however updated attribute always has group
  • Optional newOnly: boolean

    default false; when true, only those attributes that are not in the current set are added. those that are already in set are not updated

  Returns void

addVal

• addVal(pName, pValue, pGroup?): void

• Simple way to add new value as a fceParam Intended to be used in json-defined scrips

  Parameters

  • pName: string
  • pValue: iAttrVal
  • Optional pGroup: AttrGroup

  Returns void

  Example

  attr._a.addVal('title', obj.name)
  Copy

asArray

• asArray(nameList, group?): object

• Creates and array from the attribute values

  Parameters

  • nameList: string[]

    optional list of names if set, only attributes from list are copies to the array
  • Optional group: AttrGroup

    optional group name; if set only attributes from the group are copied

  Returns object

  copied values

attrVal

• attrVal(attrName, group?): iAttrVal

• Returns value of the attributes if attribute is available or undefined if not Verifies srings and converts them to the number or bool values

  Parameters

  • attrName: string
  • Optional group: AttrGroup

  Returns iAttrVal

clear

• clear(): void

• Clears all attributes

  Returns void

copyAttributeGroup

• copyAttributeGroup(attrs, group?): void

• Add all attributes from a single group

  • If group makes no sense (copy all), use add
  • Makes real copy - i.e. crates new instance of each attribute from the group

  Parameters

  • attrs: iAttributes

    from when (source) are copies
  • Optional group: AttrGroup

    name of the group to copy. If not defined all attributes are copied

  Returns void

deleteAttribute

• deleteAttribute(name, group?): void

• Delete attribute, if exists

  Parameters

  • name: string
  • Optional group: AttrGroup

  Returns void

deleteGroup

• deleteGroup(group): void

• Delete all attributes of the group

  Parameters

  • group: AttrGroup

    name of the group to delete

  Returns void

firstFromGroup

• firstFromGroup(group): iAttribute

• Parameters

  • group: string

  Returns iAttribute

get

• get(attrName, group?): iAttribute

• from the list of attributes returns attribute of the requested name, if that is available return undefined iff not available

  If some attributes have no group defined, function accepts them for any group. It allows json command definition simpler. But be carefull that those parameters are not managed within the group operations. It also fulfill the group of the attribute if that is not defined to make the next part of the provessing standard

  Attribute names are not case sensitive

  Parameters

  • attrName: string
  • Optional group: AttrGroup

  Returns iAttribute

getIDsForWhere

• getIDsForWhere(): string

• Returns string for were command from IDs group

  Returns string

processAttributes

• processAttributes(startAttr, dataObj, lang): void

• Evaluates attributes in the command

  Parameters

  • startAttr: iAttributes
  • dataObj: iDataObject
  • lang: iLangProv

  Returns void

  Example

  attr.listVal replaces to the value of the listVal attribute
  Copy