Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions API/audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ eventTypeFilter(data: string | number | (string | number)[]): this;

- `string` — название типа события,

- `number` — [`longId`](./views.md#long-id) типа события,
- `number` — [`longId`](./common.md#long-id) типа события,

- `(string | number)[]` — массив (возможно, смешанный) названий и [`longId`](./views.md#long-id) типов событий.
- `(string | number)[]` — массив (возможно, смешанный) названий и [`longId`](./common.md#long-id) типов событий.

Возвращает `this`.

Expand Down
96 changes: 86 additions & 10 deletions API/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ interface CellBuffer {
```js
set(cell: Cell | CubeCell, value: number | string | boolean | null): this;
```
Устанавливает значение `value` в клетку `cell` в буфере. Возвращает `this`.
Устанавливает значение `value` в клетку `cell` в буфере. В качестве значения `value` можно передать то же, что и для метода [`Cell.setValue()`](./readingGrid.md#cell.set-value). Возвращает `this`.

 

Expand Down Expand Up @@ -400,7 +400,7 @@ recalculate(): boolean;
```js
backup(path?: string): EntityInfo | boolean;
```
Сохраняет резервную копию в логах модели: в интерфейсе Optimacros на вкладке `Центр безопастности`->`Логи`->`Резервные копии`. Если указан путь `path`, после создания копии вызовется функция `export()` и вернётся её результат типа `boolean`. Если `path` не указан, возвращает сущность резервной копии в виде [`EntityInfo`](./views.md#entity-info).
Сохраняет резервную копию в логах модели: в интерфейсе Optimacros на вкладке `Центр безопастности`->`Логи`->`Резервные копии`. Если указан путь `path`, после создания копии вызовется функция `export()` и вернётся её результат типа `boolean`. Если `path` не указан, возвращает сущность резервной копии в виде [`EntityInfo`](#entity-info).

 

Expand Down Expand Up @@ -587,7 +587,7 @@ interface UserInfo {
```js
getEntity(): EntityInfo;
```
Возвращает сущность пользователя в виде [`EntityInfo`](./views.md#entity-info).
Возвращает сущность пользователя в виде [`EntityInfo`](#entity-info).

 

Expand Down Expand Up @@ -615,7 +615,7 @@ getLastName(): string;
```js
getRole(): EntityInfo;
```
Возвращает сущность роли пользователя в виде [`EntityInfo`](./views.md#entity-info).
Возвращает сущность роли пользователя в виде [`EntityInfo`](#entity-info).

 

Expand Down Expand Up @@ -653,28 +653,104 @@ setProperty(name: string, value: any): this;

 

### Интерфейс EntityInfo (Label)<a name="entity-info"></a>
```ts
interface Label {
longId(): number;
name(): string;
code(): string | null;
alias(): string;
label(): string;
parentLongId(): number;
hierarchyLongId(): number;
}

```
Интерфейс сущности. Как правило, представляет собой один из заголовков строки или столбца.

&nbsp;

<a name="long-id"></a>
```js
longId(): number;
```
Возвращает внутренний идентификатор сущности в системе, уникальный в пределах модели.

&nbsp;

<a name="name"></a>
```js
name(): string;
```
Возвращает имя сущности.

&nbsp;

<a name="code"></a>
```js
code(): string;
```
Возвращает код сущности.

&nbsp;

<a name="alias"></a>
```js
alias(): string;
```
Возвращает отображаемое имя.

Если `this` является сущностью элемента справочника, в настройках которого задано некоторое свойство в качестве отображаемого имени (колонка `Отображаемое имя` на вкладке `Справочники`), и для этой сущности задано значение этого свойства, то возвращает значение этого свойства.

Иначе возвращает [`name()`](#name).

&nbsp;

```js
label(): string;
```
То же, что и [`alias()`](#alias).

&nbsp;

```js
parentLongId(): number;
```
Если сущность является элементом, у которого есть родительский элемент, то возвращает [`longId`](#long-id) сущности родителя.

Если родительской сущности нет, возвращает `-1`.

&nbsp;

```js
hierarchyLongId(): number;
```
Если сущность является элементом или сабсетом справочника (включая справочники времени и версий), возвращает [`longId`](#long-id) самого справочника. Если родительского справочника нет, возвращает `-1`. На данный момент этот метод может некорректно работать в зависимости от способа получения `EntityInfo`, для корректной работы рекомендуется получать сущность с помощью интерфейса [`EntitiesInfo`](#entities-info).

&nbsp;

### Интерфейс EntitiesInfo<a name="entities-info"></a>
```ts
interface EntitiesInfo {
get(longId: number): EntityInfo | null;
getCollection(longId: number[]): EntityInfo[];
}
```
Интерфейс для получения сущности по [`longId`](./views.md#long-id).
Интерфейс для получения сущности по [`longId`](#long-id).

&nbsp;

```js
get(longId: number): EntityInfo | null;
```
Возвращает сущность [`EntityInfo`](./views.md#entity-info) по её [`longId`](./views.md#long-id).
Возвращает сущность [`EntityInfo`](#entity-info) по её [`longId`](#long-id).

&nbsp;

```js
getCollection(longId: number[]): EntityInfo[];
```
Возвращает массив сущностей [`EntityInfo`](./views.md#entity-info) по массиву их [`longId`](./views.md#long-id). Корректно работает, только если все переданные `longId` корректные (существуют в модели). Иначе возвращает массив меньшей размерности. Использовать с осторожностью. Порядок возвращаемых сущностей `EntityInfo` может отличаться от порядка переданных `longId`.
Возвращает массив сущностей [`EntityInfo`](#entity-info) по массиву их [`longId`](#long-id). Корректно работает, только если все переданные `longId` корректные (существуют в модели). Иначе возвращает массив меньшей размерности. Использовать с осторожностью. Порядок возвращаемых сущностей `EntityInfo` может отличаться от порядка переданных `longId`.

&nbsp;

Expand Down Expand Up @@ -703,14 +779,14 @@ interface CopyData {
```js
setSourceLongId(longId: number): this;
```
Устанавливает [`longId`](./views.md#long-id) элемента-источника *заданного измерения*.
Устанавливает [`longId`](#long-id) элемента-источника *заданного измерения*.

&nbsp;

```js
setDestLongId(longId: number): this;
```
Устанавливает [`longId`](./views.md#long-id) элемента-приёмника *заданного измерения*.
Устанавливает [`longId`](#long-id) элемента-приёмника *заданного измерения*.

&nbsp;

Expand All @@ -731,7 +807,7 @@ enableCustomProperties(): this;
```js
setMulticubeLongIds(longIds: number[]): this;
```
Предписывает произвести копирование в указанных по [`longId`](./views.md#long-id) мультикубах, которые содержат *заданное измерение*.
Предписывает произвести копирование в указанных по [`longId`](#long-id) мультикубах, которые содержат *заданное измерение*.

&nbsp;

Expand Down
8 changes: 4 additions & 4 deletions API/cubeCell.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ getDimensionIds(): number[];
```js
getDimensionItems(): EntityInfo[];
```
Возвращает массив [`EntityInfo`](./views.md#entity-info) элементов измерений куба, которыми определена клетка. Порядок измерений фиксирован и соответствует порядку, в котором их же возвращает функция [`CubeInfo.getDimensions()`](#cube-info.get-dimensions).
Возвращает массив [`EntityInfo`](./common.md#entity-info) элементов измерений куба, которыми определена клетка. Порядок измерений фиксирован и соответствует порядку, в котором их же возвращает функция [`CubeInfo.getDimensions()`](#cube-info.get-dimensions).

&nbsp;

Expand All @@ -56,7 +56,7 @@ interface CubeInfo extends EntityInfo {
getDimensions(): EntityInfo[];
}
```
Интерфейс информации о кубе. Интерфейс наследуется от [`EntityInfo`](./views.md#entity-info).
Интерфейс информации о кубе. Интерфейс наследуется от [`EntityInfo`](./common.md#entity-info).

&nbsp;

Expand All @@ -78,7 +78,7 @@ getFormatInfo(): CubeFormatInfo;
```js
getDimensions(): EntityInfo[];
```
Возвращает массив [`EntityInfo`](./views.md#entity-info) измерений куба.
Возвращает массив [`EntityInfo`](./common.md#entity-info) измерений куба.

&nbsp;

Expand All @@ -96,7 +96,7 @@ interface CubeFormatInfo {
```js
getFormatTypeEntity(): EntityInfo;
```
Возвращает сущность [`EntityInfo`](./views.md#entity-info) формата куба. Возможные форматы: `'Number'`, `'Text'`, `'Boolean'`, `'Date'`, `'Entity'`, `'Time Entity'`, `'Version'`, `'Line Item Subset'`, `'None'`.
Возвращает сущность [`EntityInfo`](./common.md#entity-info) формата куба. Возможные форматы: `'Number'`, `'Text'`, `'Boolean'`, `'Date'`, `'Entity'`, `'Time Entity'`, `'Version'`, `'Line Item Subset'`, `'None'`.

&nbsp;

Expand Down
2 changes: 1 addition & 1 deletion API/dimensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,7 @@ interface TimeOptionsTab extends Tab {
applyForm(): Object;
}
```
Вкладка `Время`. Интерфейс наследуется от [`Tab`](./views.md#tab). Является [`плоской таблицей`](../appendix/constraints.md#flat-table). Кроме того, является формой, аналогичной форме HTML: после изменения значений ячейки/ячеек требуется ещё вызвать функцию `applyForm()` для применения новых данных к модели.
Вкладка `Время`. Интерфейс наследуется от [`Tab`](./views.md#tab). Является [`плоской таблицей`](../appendix/constraints.md#labelless-table). Кроме того, является формой, аналогичной форме HTML: после изменения значений ячейки/ячеек требуется ещё вызвать функцию `applyForm()` для применения новых данных к модели.

&nbsp;

Expand Down
12 changes: 6 additions & 6 deletions API/elementsManipulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ interface BaseElementsCreator {
```js
setPositionAfter(relativeLongId: number): this;
```
Устанавливает позицию добавления после [`relativeLongId`](./views.md#long-id). Возвращает `this`.
Устанавливает позицию добавления после [`relativeLongId`](./common.md#long-id). Возвращает `this`.

&nbsp;

```js
setPositionBefore(relativeLongId: number): this;
```
Устанавливает позицию добавления до [`relativeLongId`](./views.md#long-id). Возвращает `this`.
Устанавливает позицию добавления до [`relativeLongId`](./common.md#long-id). Возвращает `this`.

&nbsp;

Expand All @@ -72,14 +72,14 @@ setPositionEnd(): this;
```js
setPositionChildOf(parentLongId: number): this;
```
Устанавливает позицию добавления элемента как дочернего для [`parentLongId`](./views.md#long-id). Возвращает `this`.
Устанавливает позицию добавления элемента как дочернего для [`parentLongId`](./common.md#long-id). Возвращает `this`.

&nbsp;

```js
create(): number[];
```
Добавляет элементы и возвращает массив их [`longId`](./views.md#long-id).
Добавляет элементы и возвращает массив их [`longId`](./common.md#long-id).

&nbsp;

Expand Down Expand Up @@ -131,7 +131,7 @@ interface ElementsDeleter {
```js
appendIdentifier(identifier: number): this;
```
Добавляет в буфер элемент, чей [`longId`](./views.md#long-id) равен `identifier`. Повторное добавление элемента в очередь **не** приводит к ошибкам. Возращает `this`.
Добавляет в буфер элемент, чей [`longId`](./common.md#long-id) равен `identifier`. Повторное добавление элемента в очередь **не** приводит к ошибкам. Возращает `this`.

&nbsp;

Expand Down Expand Up @@ -160,7 +160,7 @@ interface ElementsReorder {
```js
append(longId: number, relativeLongId?: number, position?: string): this;
```
Добавляет в очередь данные о [`longId`](./views.md#long-id) элемента, который впоследствии будет позиционирован относительно элемента `relativeLongId` (значение по умолчанию: `-1`). Возвращает `this`. Способ позиционирования задаёт аргумент `position` (регистр имеет значение):
Добавляет в очередь данные о [`longId`](./common.md#long-id) элемента, который впоследствии будет позиционирован относительно элемента `relativeLongId` (значение по умолчанию: `-1`). Возвращает `this`. Способ позиционирования задаёт аргумент `position` (регистр имеет значение):

`'Before'` — непосредственно перед `relativeLongId`;

Expand Down
Loading