diff --git a/docs/additional-documentation/readme.html b/docs/additional-documentation/readme.html index eeb49a4bd..01303c9ba 100644 --- a/docs/additional-documentation/readme.html +++ b/docs/additional-documentation/readme.html @@ -53,19 +53,19 @@
The dependencies stack up from core to data (data > ui > core). You could also omit data, using just the ui components.
The main documentation is located at entrecode.github.io/ec.components. You can find a getting started guide there.
diff --git a/docs/classes/ResourceForm.html b/docs/classes/ResourceForm.html index 32f7a1b2e..6d56dfc73 100644 --- a/docs/classes/ResourceForm.html +++ b/docs/classes/ResourceForm.html @@ -112,6 +112,14 @@+ + + + Public + body + + + + | +
+ body:
+ |
+
+ Type : T
+
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:6
+ |
+
+ The value body of the item. This can be either a primitive value or an Object. + |
+
+ + + + Public + config + + + + | +
+ config:
+ |
+
+ Type : ItemConfig<T>
+
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:8
+ |
+
+ The config of the item. + |
+
+ + + + action + + + + | +||||||
+action(property, e)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:217
+ |
+ ||||||
+ Action method that is meant to be called on a button click or similar. +Calls the config#action method with the item and the property name +
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + classes + + + + | +||||||
+classes(property?: string)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:130
+ |
+ ||||||
+ If no property given: Returns the output of the config.classes method or ''. +If property given: Returns the output of the config.fields[property].classes method or '' +
+ Parameters :
+
+
+
+
+ Returns :
+ string
+
+
+
+
+ |
+
+ + + + clear + + + + | +
+clear()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:47
+ |
+
+ deletes the item body +
+ Returns :
+ void
+
+ |
+
+ + + + deleteImmutableProperties + + + + | +||||||||
+deleteImmutableProperties(value: Object)
+ |
+ ||||||||
+ Inherited from
+ Form
+ |
+ ||||||||
+ Defined in Form:173
+ |
+ ||||||||
+
+
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + display + + + + | +||||||
+display(property?: string)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:142
+ |
+ ||||||
+ Returns the output of the config.display transformation function with the given property value. +If no display function is set, it will just return the property value. +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + Protected + generateConfig + + + + | +
+
+ generateConfig()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:17
+ |
+
+ Generates a config from the body by setting view to the properties type. +
+ Returns :
+ ItemConfig<T>
+
+ |
+
+ + + + getBody + + + + | +
+getBody()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:37
+ |
+
+ Returns the item's body +
+ Returns :
+ T
+
+ |
+
+ + + + getConfig + + + + | +
+getConfig()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:57
+ |
+
+ Returns the item's config +
+ Returns :
+ any
+
+ |
+
+ + + + getProperties + + + + | +
+getProperties()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:62
+ |
+
+ Returns an Array of properties possessed by the body. +
+ Returns :
+ Array<string>
+
+ |
+
+ + + + group + + + + | +||||||
+group(property: string)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:124
+ |
+ ||||||
+ Returns the output of the config.group transformation function with the given property value. +If no group function is set, it will just return the property value. +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + hasBody + + + + | +
+hasBody()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:42
+ |
+
+ Returns true if the body is defined and not null +
+ Returns :
+ boolean
+
+ |
+
+ + + + id + + + + | +
+id()
+ |
+
+ Inherited from
+ Form
+ |
+
+ Defined in Form:73
+ |
+
+ Returns the value of the the Item's identifier property. +
+ Returns :
+ any
+
+ |
+
+ + + + isImmutableProperty + + + + | +||||||
+isImmutableProperty(property: string)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:166
+ |
+ ||||||
+
+
+ Parameters :
+
+
+
+
+ Returns :
+ boolean
+
+
+
+
+ |
+
+ + + + pickWriteOnly + + + + | +||||||
+pickWriteOnly(value)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:155
+ |
+ ||||||
+ Returns value with all readOnly properties removed +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + resolve + + + + | +||||||
+resolve(property?: string)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:82
+ |
+ ||||||
+ Returns either the whole body (if no property is given) or the value of the given property. +This method will traverse the body via the config.resolve function (if given). +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + save + + + + | +||||||||
+save(value: T)
+ |
+ ||||||||
+ Inherited from
+ Form
+ |
+ ||||||||
+ Defined in Form:204
+ |
+ ||||||||
+ Saves the given value. Run serializers before assigning the new value. +
+ Parameters :
+
+
+
+
+ Returns :
+ Promise<Item<T>>
+
+
+
+
+ |
+
+ + + + serialize + + + + | +||||||||||||
+serialize(value, put: boolean)
+ |
+ ||||||||||||
+ Inherited from
+ Form
+ |
+ ||||||||||||
+ Defined in Form:182
+ |
+ ||||||||||||
+ Transforms the given field's value for serialization when saving. +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + sort + + + + | +||||||
+sort(property: string)
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:150
+ |
+ ||||||
+ Transforms the given field's value for sorting +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + Private + transform + + + + | +||||||||||||||||||||
+
+ transform(action: string, property: string, value: any, defaultValue: any)
+ |
+ ||||||||||||||||||||
+ Inherited from
+ Form
+ |
+ ||||||||||||||||||||
+ Defined in Form:112
+ |
+ ||||||||||||||||||||
+ The main method for transformation functions like resolve, display and group. +If you dont set the third parameter, the current item value will be used. +The third parameter can be used to transform a value that is not yet possesed (e.g. to +serialize) +
+ Parameters :
+
+
+
+
+ Returns :
+ any
+
+
+
+
+ |
+
+ + + + useConfig + + + + | +||||||
+useConfig(config: ItemConfig
+ |
+ ||||||
+ Inherited from
+ Form
+ |
+ ||||||
+ Defined in Form:52
+ |
+ ||||||
+ Assigns the given config to the existing via Object.assign +
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + Public + items + + + + | +
+ items:
+ |
+
+ Type : Array<T>
+
+ |
+
+ Inherited from
+ List
+ |
+
+ Defined in List:10
+ |
+
+ The items must all have the same type T. + |
+
+ + + + Protected + update + + + + | +
+ update:
+ |
+
+ Type : Subject<Collection<T>>
+
+ |
+
+ Default value : new Subject()
+ |
+
+ Inherited from
+ List
+ |
+
+ Defined in List:12
+ |
+
+ Subject that is nexted when the items update + |
+
+ + + + Public + update$ + + + + | +
+ update$:
+ |
+
+ Type : Observable<Collection<T>>
+
+ |
+
+ Default value : this.update.asObservable()
+ |
+
+ Inherited from
+ List
+ |
+
+ Defined in List:14
+ |
+
+ Subject that is nexted when the items change + |
+
+ + + + add + + + + | +||||||||||||||||
+add(item: T, unique?: boolean, event: boolean)
+ |
+ ||||||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||||||
+ Defined in List:71
+ |
+ ||||||||||||||||
+ Adds the given item to the Collection. If the unique flag is set, the item will only be added +if it is not contained. +
+ Parameters :
+
+
+ Example :
+
+
+
+
+
+ Returns :
+ boolean
+
+
+
+
+ |
+
+ + + + addAll + + + + | +||||||||||||||||
+addAll(items: Array
+ |
+ ||||||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||||||
+ Defined in List:89
+ |
+ ||||||||||||||||
+ Adds the given items to the Collection. If the unique flag is set, only items that are not +contained will be added. +
+ Parameters :
+
+
+ Example :
+
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + has + + + + | +||||||
+has(item: T)
+ |
+ ||||||
+ Inherited from
+ List
+ |
+ ||||||
+ Defined in List:42
+ |
+ ||||||
+ Checks if the Collection contains the given item. +
+ Parameters :
+
+
+ Example :
+
+
+
+
+
+ Returns :
+ boolean
+
+
+
+
+ |
+
+ + + + hasAll + + + + | +||||||||
+hasAll(items: Array
+ |
+ ||||||||
+ Inherited from
+ List
+ |
+ ||||||||
+ Defined in List:53
+ |
+ ||||||||
+ Checks if the Collection contains all given items. +
+ Parameters :
+
+
+ Example :
+
+
+
+
+
+ Returns :
+ boolean
+
+
+
+
+ |
+
+ + + + index + + + + | +||||||
+index(item: T)
+ |
+ ||||||
+ Inherited from
+ List
+ |
+ ||||||
+ Defined in List:31
+ |
+ ||||||
+ Returns the index of the given item +
+ Parameters :
+
+
+
+
+ Returns :
+ number
+
+
+
+
+ |
+
+ + + + isEmpty + + + + | +
+isEmpty()
+ |
+
+ Inherited from
+ List
+ |
+
+ Defined in List:160
+ |
+
+ Returns true if the collection is empty +
+ Returns :
+ boolean
+
+ |
+
+ + + + move + + + + | +||||||||||||||||
+move(item: T, index: number, event: boolean)
+ |
+ ||||||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||||||
+ Defined in List:165
+ |
+ ||||||||||||||||
+ Moves the given item to the given array index. +
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + remove + + + + | +||||||||||||
+remove(item: T, event: boolean)
+ |
+ ||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||
+ Defined in List:106
+ |
+ ||||||||||||
+ Removes the given item from the Collection. +
+ Parameters :
+
+
+ Example :
+
+
+
+
+
+ Returns :
+ boolean
+
+
+
+
+ |
+
+ + + + removeAll + + + + | +||||||||||||
+removeAll(items?: Array
+ |
+ ||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||
+ Defined in List:123
+ |
+ ||||||||||||
+ Removes all items from the Collection. +
+ Parameters :
+
+
+ Example :
+
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + replaceWith + + + + | +||||||||||||
+replaceWith(items: Array
+ |
+ ||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||
+ Defined in List:147
+ |
+ ||||||||||||
+ Replaces all current items with the given items. +
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+ + + + toggle + + + + | +||||||||||||
+toggle(item: T, event: boolean)
+ |
+ ||||||||||||
+ Inherited from
+ List
+ |
+ ||||||||||||
+ Defined in List:138
+ |
+ ||||||||||||
+ Toggles the item in and out of collection +
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
+
+ actions
+ |
+
+
+ Type : |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+ |
+ Defined in ResourceActionbarComponent:33
+ |
+
+
+ config
+ |
+
+
+ Type :
+ Default value : |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+ |
+ Defined in ResourceActionbarComponent:26
+ |
+
- + - Public - cdr + currentActions - + |
- cdr:
+currentActions()
|
- Type : ChangeDetectorRef
- |
-
+ Inherited from
+ ResourceActionbarComponent
+ |
+
-
+ Defined in ResourceActionbarComponent:82
|
+
+
+ Returns :
+ {}
+
+ |
+
- + - Public - elementRef + currentID - + |
- elementRef:
+currentID()
|
- Type : ElementRef
- |
-
+ Inherited from
+ ResourceActionbarComponent
+ |
+
-
+ Defined in ResourceActionbarComponent:70
|
+
+
+ Returns :
+ any
+
+ |
+
- + - Public - notificationService + getPath - + |
- notificationService:
+getPath()
|
- Type : NotificationsService
- |
-
+ Inherited from
+ ResourceActionbarComponent
+ |
+
-
+ Defined in ResourceActionbarComponent:101
|
+
+
+ Returns :
+ any
+
+ |
+
- + - Public - resourceConfig + loadActions - + | |||||||||
- resourceConfig:
+loadActions(actions, addToStack)
|
|||||||||
- Type : ResourceConfig
- |
- |||||||||
+ Inherited from
+ ResourceActionbarComponent
+ |
+ |||||||||
-
+ Defined in ResourceActionbarComponent:86
|
|||||||||
+
+
+ Parameters :
+
+
+
+
+ Returns :
+ void
+
+
+
+
+ |
+
- + - Public - sdk + loadActionsBefore - + |
- sdk:
+loadActionsBefore()
|
- Type : SdkService
- |
-
- + + |
+ Inherited from
+ ResourceActionbarComponent
+ |
+
+ Defined in ResourceActionbarComponent:59
+ |
+
+
+
+ Returns :
+ void
+
+ |
+
+ + + + ngOnInit + + + + | +
+ngOnInit()
+ |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+
+ Defined in ResourceActionbarComponent:66
+ |
+
+
+
+ Returns :
+ void
+
+ |
+
+ + + + reset + + + + | +
+reset()
+ |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+
+ Defined in ResourceActionbarComponent:77
+ |
+
+
+
+ Returns :
+ void
+
+ |
+
+ + + + Public + cdr + + + + | +
+ cdr:
+ |
+
+ Type : ChangeDetectorRef
+
+ |
+
+ + | +
+ + + + Public + elementRef + + + + | +
+ elementRef:
+ |
+
+ Type : ElementRef
+
+ |
+
+ + | +
+ + + + Public + notificationService + + + + | +
+ notificationService:
+ |
+
+ Type : NotificationsService
+
+ |
+
+ + | +
+ + + + Public + resourceConfig + + + + | +
+ resourceConfig:
+ |
+
+ Type : ResourceConfig
+
+ |
+
+ + | +
+ + + + Public + sdk + + + + | +
+ sdk:
+ |
+
+ Type : SdkService
+
+ |
+
+ |
+ + + + actionStack + + + + | +
+ actionStack:
+ |
+
+ Type : literal type
+
+ |
+
+ Default value : {}
+ |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+
+ Defined in ResourceActionbarComponent:34
+ |
+
+ + + + Public + cdr + + + + | +
+ cdr:
+ |
+
+ Type : ChangeDetectorRef
+
+ |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+
+ Defined in ResourceActionbarComponent:38
+ |
+
+ + + + Public + elementRef + + + + | +
+ elementRef:
+ |
+
+ Type : ElementRef
+
+ |
+
+ Inherited from
+ ResourceActionbarComponent
+ |
+
+ Defined in ResourceActionbarComponent:37
+ |
+