добавлены описания для атрибутной ноды
This commit is contained in:
parent
732efd2b3d
commit
f664dc3569
|
|
@ -8,8 +8,8 @@
|
|||
* Связанные объекты:
|
||||
*
|
||||
* - {@link Trees.GlobalTree.Node} - Здесь можно найти примеры, как работать с вложенными нодами
|
||||
* - {@link Trees.GlobalAttributeTree} - Здесь можно найти примеры, как работать с глобальным деревом
|
||||
* - {@link Trees.GlobalAttributeTree.Node.Attributes} - Здесь можно найти примеры, как работать с типами ноды
|
||||
* - {@link Trees.GlobalAttributeTree} - Здесь можно найти примеры, как работать с атрибутным деревом
|
||||
* - {@link Trees.GlobalAttributeTree.Node.Attributes} - Здесь можно найти примеры, как работать с атрибутами
|
||||
*
|
||||
*
|
||||
* @example
|
||||
|
|
@ -47,12 +47,63 @@
|
|||
*/
|
||||
function Node() {
|
||||
/**
|
||||
* Возвращает список всех атрибутов, включая динамические <br>
|
||||
* <br> Работает через промис.
|
||||
* #### Атрибуты ноды
|
||||
*
|
||||
* Данный метод, возвращает все атрибуты, которые есть у ноды, включая те, которые вернет {@link Trees.GlobalAttributeTree.Node.base_attributes base_attributes}
|
||||
*
|
||||
* <br>
|
||||
* _Используется в BNA._
|
||||
*
|
||||
* <br>
|
||||
* #### Результат
|
||||
*
|
||||
* **first** (имя атрибута)
|
||||
*
|
||||
* **second** (структура атрибута: метаданные и значение)
|
||||
*
|
||||
* visible -> {@link v2.boolean Boolean}
|
||||
* editable -> {@link v2.boolean Boolean}
|
||||
* removable -> {@link v2.boolean Boolean}
|
||||
* type -> {@link v2.type Type}
|
||||
* value -> {@link v2 Any}
|
||||
*
|
||||
* #### Важно!
|
||||
* Это ресурсоемкий вызов и если вам нужно получить имя или адрес иконки для ноды, то нужно использовать {@link Trees.GlobalAttributeTree.Node.base_attributes base_attributes}
|
||||
*
|
||||
* @example
|
||||
* // Пример:
|
||||
*
|
||||
* // Считаем что, нода уже есть на руках.
|
||||
* node.attributes().then(function(_attributes){
|
||||
* // распечатаем атрибуты
|
||||
* console.log(v2.tools.print(_attributes));
|
||||
*
|
||||
* // примерный вывод будет таким:
|
||||
* // Map(String, VariableContainer) [
|
||||
* // "childrenCount" : VariableContainer [
|
||||
* // visible : false,
|
||||
* // editable : false,
|
||||
* // removable : false,
|
||||
* // type : Integer,
|
||||
* // value : 0
|
||||
* // ],
|
||||
* // "icon" : VariableContainer [
|
||||
* // visible : true,
|
||||
* // editable : true,
|
||||
* // removable : false,
|
||||
* // type : String,
|
||||
* // value : "tree"
|
||||
* // ]
|
||||
* // ]
|
||||
*
|
||||
* }, function(_err){
|
||||
* // распечатаем ошибку
|
||||
* console.log(_err)
|
||||
* })
|
||||
*
|
||||
* @public
|
||||
* @function attributes
|
||||
* @returns {tools.promise}
|
||||
* @returns {tools.promise(v2.map(v2.string,v2.vc))}
|
||||
* @memberof Trees.GlobalAttributeTree.Node
|
||||
*/
|
||||
this.attributes = function() {
|
||||
|
|
@ -60,12 +111,63 @@ function Node() {
|
|||
};
|
||||
|
||||
/**
|
||||
* Возвращает список базовых атрибутов ноды (их нельзя удалить) <br>
|
||||
* <br> Работает через промис.
|
||||
* #### Статические атрибуты ноды
|
||||
*
|
||||
* Данный метод, возвращает только те атрибуты, которые описаны типом ноды {@link Trees.GlobalTree.Node.NodeTypes.NodeType NodeType}
|
||||
*
|
||||
* <br>
|
||||
* _Используется в BNBA._
|
||||
*
|
||||
* <br>
|
||||
* #### Результат
|
||||
*
|
||||
* **first** (имя атрибута)
|
||||
*
|
||||
* **second** (структура атрибута: метаданные и значение)
|
||||
*
|
||||
* visible -> {@link v2.boolean Boolean}
|
||||
* editable -> {@link v2.boolean Boolean}
|
||||
* removable -> {@link v2.boolean Boolean}
|
||||
* type -> {@link v2.type Type}
|
||||
* value -> {@link v2 Any}
|
||||
*
|
||||
* #### Важно!
|
||||
* Это оптимизированный метод, и им следует пользоваться
|
||||
*
|
||||
* @example
|
||||
* // Пример:
|
||||
*
|
||||
* // Считаем что, нода уже есть на руках.
|
||||
* node.base_attributes().then(function(_attributes){
|
||||
* // распечатаем атрибуты
|
||||
* console.log(v2.tools.print(_attributes));
|
||||
*
|
||||
* // примерный вывод будет таким:
|
||||
* // Map(String, VariableContainer) [
|
||||
* // "childrenCount" : VariableContainer [
|
||||
* // visible : false,
|
||||
* // editable : false,
|
||||
* // removable : false,
|
||||
* // type : Integer,
|
||||
* // value : 0
|
||||
* // ],
|
||||
* // "icon" : VariableContainer [
|
||||
* // visible : true,
|
||||
* // editable : true,
|
||||
* // removable : false,
|
||||
* // type : String,
|
||||
* // value : "tree"
|
||||
* // ]
|
||||
* // ]
|
||||
*
|
||||
* }, function(_err){
|
||||
* // распечатаем ошибку
|
||||
* console.log(_err)
|
||||
* })
|
||||
*
|
||||
* @public
|
||||
* @function base_attributes
|
||||
* @returns {tools.promise}
|
||||
* @returns {tools.promise(v2.map(v2.string,v2.vc))}
|
||||
* @memberof Trees.GlobalAttributeTree.Node
|
||||
*/
|
||||
this.base_attributes = function() {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,17 @@
|
|||
/**
|
||||
* Отнаследовано от глобального дерева. <br>
|
||||
* ### Атрибутное дерево
|
||||
*
|
||||
* Отнаследовано от глобального дерева.
|
||||
*
|
||||
* Ноды этого дерева имеют доступ к атрибутам
|
||||
*
|
||||
* <br>
|
||||
* Связанные объекты:
|
||||
*
|
||||
* - {@link Trees} - Здесь можно найти примеры, как работать с менеджером деревьев
|
||||
* - {@link Trees.GlobalTree} - Здесь можно найти примеры, как работать с содержимым глобальной ноды
|
||||
* - {@link Trees.GlobalAttributeTree.Node} - Здесь можно найти примеры как работать с атрибутной нодой
|
||||
*
|
||||
* @group manager
|
||||
* @class GlobalAttributeTree
|
||||
* @extends Trees.GlobalTree
|
||||
|
|
|
|||
|
|
@ -928,11 +928,11 @@ exports.publish = function(taffyData, opts, tutorials) {
|
|||
}
|
||||
|
||||
if (myClasses.length) {
|
||||
generate('Class: ' + myClasses[0].name, myClasses, helper.longnameToUrl[longname]);
|
||||
generate(myClasses[0].name, myClasses, helper.longnameToUrl[longname]);
|
||||
}
|
||||
|
||||
if (myNamespaces.length) {
|
||||
generate('Namespace: ' + myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]);
|
||||
generate(myNamespaces[0].name, myNamespaces, helper.longnameToUrl[longname]);
|
||||
}
|
||||
|
||||
if (myMixins.length) {
|
||||
|
|
|
|||
Loading…
Reference in New Issue