Constructor
new ScreenModel(htmlopt, childrenopt, parentsopt)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
html |
String | ScreenModel~ScreenConfig |
<optional> |
контент модели |
children |
Array.<ScreenModel> |
<optional> |
потомки модели |
parents |
Array.<ScreenModel> |
<optional> |
предки модели |
- Source:
Methods
(static) clearUpdateFn()
Очистить набор функций для запуска, когда изменится структура графа
- Source:
(static) configure(config)
Устанавливает конфигурацию моделей по умолчанию. Изначальные значения по умоланию:
isPermanent: false,
isDirectedGraph: true,
defaultChildIndex: 0,
defaultParentIndex: 0
Parameters:
| Name | Type | Description |
|---|---|---|
config |
ScreenModel~DefaultScreenConfig | конфигурация |
- Source:
(static) getMainScreen() → {ScreenModel}
Получить модель по умолчанию
- Source:
Returns:
модель по умолчанию
- Type
- ScreenModel
(static) registerUpdateFn(fn)
Зарегистрировать функцию для запуска, когда изменится структура графа
Parameters:
| Name | Type | Description |
|---|---|---|
fn |
function | функция для запуска |
- Source:
(static) setMainScreen(screen)
Установить модель по умолчанию, она будет использоваться в качестве стартовой для панелей, если при старте не заданы иные модели. Если модель по умолчанию не установлена вручную, будет использован первый созданный экземпляр модели.
Parameters:
| Name | Type | Description |
|---|---|---|
screen |
ScreenModel | модель по умолчанию |
- Source:
- See:
(static) unregisterUpdateFn(fn)
Удалить функцию из списка функций для запуска, когда изменится структура графа
Parameters:
| Name | Type | Description |
|---|---|---|
fn |
function | функция для запуска |
- Source:
childrenLength() → {Number}
Возвращает количество потомков.
- Source:
Returns:
количество потомков
- Type
- Number
defaultChildIndex(indexopt) → {number}
Возвращает индекс модели по умолчанию среди моделей-потомков
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
index |
number |
<optional> |
если задан индекс, он будет установлен как значение по умолчанию |
- Source:
Returns:
индекс модели по умолчанию среди моделей-потомков
- Type
- number
defaultParentIndex(indexopt) → {number}
Возвращает индекс модели по умолчанию среди моделей-предков
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
index |
number |
<optional> |
если задан индекс, он будет установлен как значение по умолчанию |
- Source:
Returns:
индекс модели по умолчанию среди моделей-предков
- Type
- number
getChild(child) → {ScreenModel}
Находит модель среди набора потомков
Parameters:
| Name | Type | Description |
|---|---|---|
child |
ScreenModel | string | number | искомая модель, ее идентификатор или порядковый номер в наборе |
- Source:
Returns:
искомая модель
- Type
- ScreenModel
getChildIndex(child) → {number}
Находит индекс модели среди набора потомков
Parameters:
| Name | Type | Description |
|---|---|---|
child |
ScreenModel | string | number | искомая модель, ее идентификатор или порядковый номер в наборе |
- Source:
Returns:
искомый индекс модели
- Type
- number
getParent(parent) → {ScreenModel}
Находит модель среди набора предков
Parameters:
| Name | Type | Description |
|---|---|---|
parent |
ScreenModel | string | number | искомая модель, ее идентификатор или порядковый номер в наборе |
- Source:
Returns:
искомая модель
- Type
- ScreenModel
getParentIndex(parent) → {number}
Находит индекс модели среди набора предков
Parameters:
| Name | Type | Description |
|---|---|---|
parent |
ScreenModel | string | number | искомая модель, ее идентификатор или порядковый номер в наборе |
- Source:
Returns:
искомый индекс модели
- Type
- number
html(htmlopt) → {string}
Возвращает контент модели
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
html |
string |
<optional> |
если аргумент задан, он будет установлен в качестве контента модели |
- Source:
Returns:
контент модели
- Type
- string
isDirectedGraph() → {boolean}
Возвращает опцию "ориентированный граф". Если true, модель является частью ориентированного графа.
- Source:
Returns:
опция "ориентированный граф"
- Type
- boolean
isTemporary() → {boolean}
Возвращает опцию "временная модель". Если модель временная, она не будет храниться на странице, если не отображается.
- Source:
Returns:
опция "временная модель"
- Type
- boolean
parentsLength() → {Number}
Возвращает количество предков.
- Source:
Returns:
количество предков
- Type
- Number
pushChildren(children) → {ScreenModel}
Добавить набор моделей в конец к набору потомков
Parameters:
| Name | Type | Description |
|---|---|---|
children |
Array.<ScreenModel> | ScreenModel | набор добавляемый моделей |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
pushParents(parents) → {ScreenModel}
Добавить набор моделей в конец к набору предков
Parameters:
| Name | Type | Description |
|---|---|---|
parents |
Array.<ScreenModel> | ScreenModel | набор добавляемый моделей |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
removeChild(child) → {ScreenModel}
Удаляет модель из набора потомков
Parameters:
| Name | Type | Description |
|---|---|---|
child |
ScreenModel | string | number | удаляемая модель, ее идентификатор или порядковый номер в наборе |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
removeParent(parent) → {ScreenModel}
Удаляет модель из набора предков
Parameters:
| Name | Type | Description |
|---|---|---|
parent |
ScreenModel | string | number | удаляемая модель, ее идентификатор или порядковый номер в наборе |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
resetChildren(childrenopt) → {ScreenModel}
Переопределить набор моделей потомков, то есть удалить старые и установить новые
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
children |
Array.<ScreenModel> |
<optional> |
набор добавляемый моделей |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
resetParents(parentsopt) → {ScreenModel}
Переопределить набор моделей предков, то есть удалить старые и установить новые
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
parents |
Array.<ScreenModel> |
<optional> |
набор добавляемый моделей |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
sortChildren(compareFnopt) → {ScreenModel}
Сортирует набор потомков. Сортировка происходит по правилам сортировки массива.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
compareFn |
function |
<optional> |
Если задана функция сравнения, она будет использована при сортировке. |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
sortParents(compareFnopt) → {ScreenModel}
Сортирует набор предков. Сортировка происходит по правилам сортировки массива.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
compareFn |
function |
<optional> |
Если задана функция сравнения, она будет использована при сортировке. |
- Source:
Returns:
текущая модель
- Type
- ScreenModel
toString() → {string}
Возвращает идентификатор модели
- Source:
Returns:
идентификатор модели
- Type
- string
Type Definitions
DefaultScreenConfig
Конфигурация моделей по умолчанию
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
isPermanent |
boolean |
<optional> |
Является ли модель постоянно хранимой, если да, то попав на страницу не будет оттуда удаляться. |
isDirectedGraph |
boolean |
<optional> |
Является ли строящийся граф моделей ориентированным. |
defaultChildIndex |
number |
<optional> |
Индекс модели по умолчанию среди моделей-потомков |
defaultParentIndex |
number |
<optional> |
Индекс модели по умолчанию среди моделей-предков |
- Source:
ScreenConfig
Конфигурация модели
Type:
- Object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
children |
Array.<ScreenModel> |
<optional> |
Потомки модели |
parents |
Array.<ScreenModel> |
<optional> |
Предки модели |
isPermanent |
boolean |
<optional> |
Является ли модель постоянно хранимой, если да, то попав на страницу не будет оттуда удаляться. |
isDirectedGraph |
boolean |
<optional> |
Является ли строящийся граф моделей ориентированным. |
html |
string |
<optional> |
Контент модели |
defaultChildIndex |
number |
<optional> |
Индекс модели по умолчанию среди моделей-потомков |
defaultParentIndex |
number |
<optional> |
Индекс модели по умолчанию среди моделей-предков |
- Source: