WbkDocument

Класс WbkDocument реализует экземпляр рабочей книги из базы данных временных рядов.

Комментарии

Класс WbkDocument является моделью данных, которая отражает состояние данных на сервере. При добавлении нового листа выполняется запрос к сервису и его ответ записывается в модель.

Синтаксис

Свойства

Методы

Свойства, унаследованные от класса Workbook

	Имя свойства	Краткое описание
	ActiveRub	Свойство ActiveRub устанавливает ключ активной базы данных временных рядов для модели данных рабочей книги.
	CommentAttribute	Свойство CommentAttribute определяет атрибут, используемый в качестве всплывающей подсказки для ячеек в таблице.
	DimLvlsEls	Свойство DimLvlsEls определяет элементы календарного измерения.
	DimsObs	Свойство DimsObs устанавливает измерения для ссылающихся на справочники атрибутов наблюдения рабочей книги.
	DimUnitsEls	Свойство DimUnitsEls устанавливает элементы измерения «Единицы измерения».
	Hier	Свойство Hier устанавливает иерархию дерева рядов.
	NeedShowSaveDataDialog	Свойство NeedShowSaveDataDialog используется для хранения информации о том, что был изменен ряд (его данные или атрибуты), для которого включено хранение истории.
	NeedUpdateSelection	Свойство NeedUpdateSelection определяет признак необходимости обновления отметки.
	Permanent	Свойство Permanent определяет признак того, что рабочая книга сохранена в репозитории.
	Pinned	Свойство Pinned устанавливает заблокированный ряд рабочей книги.
	RdsDim	Свойство rdsDim определяет измерение, построенное на справочнике НСИ по своему ключу.
	Rub	Свойство Rub устанавливает базу данных временных рядов, которая является источником рабочей книги.
	RubProps	Свойство RubProps устанавливает свойства базы данных временных рядов.
	SelectedIndexCols	Свойство SelectedIndexCols определяет индексы выделенных колонок.
	SelectedIndexSeries	Свойство SelectedIndexSeries определяет массив индексов рядов в таблице.
	SelectedObsTable	Свойство SelectedObsTable определяет объект, содержащий информацию о значениях выделенных в таблице ячеек, а также о значениях их атрибутов наблюдений.
	SelectedPoint	Свойство SelectedPoint устанавливает информацию о координатах выделенной точки.
	SelectedSeries	Свойство SelectedSeries устанавливает выделенные ряды.
	SelectedTableCells	Свойство SelectedTableCells устанавливает объект, содержащий информацию о выделенных значениях в таблице.
	Series	Свойство Series определяет массив загруженных рядов рабочей книги.
	SeriesCount	Свойство SeriesCount устанавливает количество рядов в рабочей книге.
	StatCoeffTabSheetSource	Свойство StatCoeffTabSheetSource устанавливает источник данных для листа на вкладке "Уравнение" в панели статистики.
	StatCorrTabSheetSource	Свойство StatCorrTabSheetSource устанавливает источник данных для листа на вкладке "пузырьковая диаграмма корреляции" в панели статистики.
	StatWeightsTabSheetSource	Свойство StatWeightsTabSheetSource устанавливает источник данных для листа на вкладке "пузырьковая диаграмма весов" в панели статистики.
	WbkMetadata	Свойство WbkMetadata устанавливает метаданные рабочей книги.

Методы, унаследованные от класса Workbook

	Имя метода	Краткое описание
	addSelectedSeries	Метод addSelectedSeries добавляет ряды в массив выделенных.
	getDependentsSeries	Метод getDependentsSeries определяет список рядов, зависимых от заданного ряда.
	getFixedColumnsCount	Метод getFixedColumnsCount возвращает количество зафиксированных при прокрутке столбцов.
	getFixedRowsCount	Метод getFixedRowsCount возвращает количество зафиксированных при прокрутке строк.
	getGaugePeriodDim	Метод getGaugePeriodDim возвращает календарный справочник спидометра.
	getKeepHistorySerieRub	Метод getKeepHistorySerieRub возвращает признак того, что в источнике (базе данных временных рядов) указанного ряда установлен признак сохранения истории изменений (списка ревизий).
	getKeySerie	Метод getKeySerie возвращает ключ ряда по индексу.
	getLoadedChildrenCount	Метод getLoadedChildrenCount определяет количество загруженных дочерних рядов для указанного ряда.
	getObsAttr	Метод getObsAttr определяет список атрибутов наблюдений.
	getRootSeriesCount	Метод getRootSeriesCount возвращает количество корневых рядов.
	getRealIndex	Метод getRealIndex возвращает индекс ряда.
	getRubOdId	Метод getRubOdId определяет моникёр базы данных временных рядов.
	getRubsOdId	Метод getRubsOdId возвращает моникёр для каталога показатей с ключом rubKey.
	getSelectedOrPinnedSeries	Метод getSelectedOrPinnedSeries возвращает выделенные ряды или заблокированный ряд, если он есть.
	getSelectionTimeRanges	Метод getSelectionTimeRanges возвращает список периодов для выделенных рядов.
	getSerie	Метод getSerie возвращает ряд из кэша загруженных рядов по ключу.
	getSerieByIndexAndParent	Метод getSerieByIndexAndParent возвращает ряд по индексу у определенного родителя.
	getSerieDepth	Метод getSerieDepth возвращает уровень вложенности ряда.
	getSerieVisibleSize	Метод getSerieVisibleSize возвращает количество строк, занимаемое рядом и его потомками.
	hasRubrs	Метод hasRubrs определяет, является ли источник рабочей книги базой данных временных рядов.
	isMapAvailable	Метод isMapAvailable определяет, доступно ли представление данных «Карта» в рабочей книге.
	isSerieSelected	Метод isSerieSelected определяет, выделен ли ряд.
	removeAllSelectedSeries	Метод removeAllSelectedSeries удаляет информацию о выделенных строках таблицы.
	removeSelectedSeries	Метод removeSelectedSeries удаляет строку таблицы из массива выделенных.
	removeSeries	Метод removeSeries удаляет строки таблицы.
	updateSeriesList	Метод updateSeriesList обновляет список рядов.

Свойства, унаследованные от класса PP.Exp.EaxAnalyzer

	Имя свойства	Краткое описание
	AutoUpdate	Свойство AutoUpdate управляет автообновлением экспресс-отчета.
	BubbleChartChangedData	Свойство BubbleChartChangedData содержит измененные данные и метаданные представления экспресс-отчета «пузырьковая диаграмма».
	BubbleChartData	Свойство BubbleChartData содержит данные представления экспресс-отчета «пузырьковая диаграмма».
	ChartChangedData	Свойство ChartChangedData содержит измененные данные представления экспресс-отчета «Диаграмма».
	ChartData	Свойство ChartData содержит данные представления экспресс-отчета «Диаграмма».
	Document	Свойство Document содержит html-документ экспресс-отчета.
	EaxParams	Свойство EaxParams определяет массив параметров экспресс-очтета.
	GaugeData	Свойство GaugeData определяет настройки для контейнера спидометра.
	GaugeChangedData	Свойство GaugeChangedData определяет изменённые настройки для контейнера спидометра.
	GridSelectionType	Свойство GridSelectionType содержит тип выделенного объекта в таблице экспресс-отчета.
	IsChanged	Свойство IsChanged возвращает признак того, что экспресс-отчёт изменён.
	IsDataChanged	Свойство GridSelectionType содержит тип выделенного объекта в таблице экспресс-отчета.
	IsDefaultHighlight	Свойство IsDefaultHighlight возвращает признак того, что выделения элементов экспресс-отчета установлены по умолчанию.
	IsHasDataAvailable	Свойство IsHasDataAvailable определяет, будут ли при изменениях данных в измерениях отправляться запросы на обновление состояния поля «@hasData» в метаданных элемента измерения.
	IsSelectionChanged	Свойство IsSelectionChanged содержит признак того, изменено ли выделение в таблице экспресс-отчета.
	MapChangedData	Свойство MapChangedData содержит измененные данные представления экспресс-отчета «Карта».
	MapData	Свойство MapData содержит данные представления экспресс-отчета «Карта».
	PeriodicalUpdateInterval	Свойство PeriodicalUpdateInterval определяет интервал периодического обновления экспресс-отчета.
	SelectedPart	Свойство SelectedPart определяет выделенную область таблицы.
	Selection	Свойство Selection содержит выделенные ячейки в таблице экспресс-отчета.
	SourceParams	Свойство SourceParams определяет массив параметров источника данных.
	StatData	Свойство StatData содержит статистические данные экспресс-отчета.
	TabFocusedCell	Свойство TabFocusedCell содержит координаты ячейки таблицы экспресс-отчета, в которой установлен фокус.
	TabSheetChangedState	Свойство TabSheetChangedState содержит измененные настройки листа экспресс-отчета.
	TableChangedData	Свойство TitleChangedData содержит измененные данные заголовка экспресс-отчета.
	TableChangedStruct	Свойство TableChangedStruct содержит измененную структуру таблицы экспресс-отчета.
	TitleChangedData	Свойство TitleChangedData содержит измененные данные заголовка экспресс-отчета.
	Topobase	Свойство Topobase содержит топооснову для представления данных «Карта» экспресс-отчета.
	TopobaseOd	Свойство TopobaseOd содержит идентификатор топоосновы экспресс-отчета в виде JSON-объекта.
	ViewSize	Свойство ViewSize содержит размер визуализатора экспресс-отчета, при использовании вертикального/горизонтального расположения визуализаторов.
	WaitToken	Свойство WaitToken устанавливает и возвращает маркер ожидания по указанному имени.

Методы, унаследованные от класса PP.Exp.EaxAnalyzer

	Имя метода	Краткое описание
	canMapDrillUp	Метод canMapDrillUp проверяет, возможно ли поднятие на уровень вверх по иерархии отметки в представлении экспресс-отчета «Карта».
	clearAllWaitTokens	Метод clearAllWaitTokens cбрасывает все маркеры ожидания в экспресс-отчете.
	clearDataSources	Метод clearDataSources сбрасывает все источники данных экспресс-отчета.
	clearDimItems	Метод clearDimItems удаляет все загруженные элементы измерения в экспресс-отчете.
	clearDims	Метод clearDims удаляет все измерения в экспресс-отчете.
	clearMapDrill	Метод clearMapDrill очищает метаданные карты.
	clearViewData	Метод clearViewData очищает метаданные экспресс-отчета.
	clearWaitToken	Метод clearWaitToken сбрасывает маркер ожидания в экспресс-отчете по указанному имени.
	getAllWaitTokens	Метод getAllWaitTokens возвращает все маркеры ожидания.
	getBubbleChartId	Метод getBubbleChartId возвращает идентификатор представления данных «пузырьковая диаграмма» у экспресс-отчета.
	getCustomHierMd	Метод getCustomHierMd возвращает метаданные пользовательской иерархии.
	getChartId	Метод getChartId возвращает идентификатор представления данных «Диаграмма» у экспресс-отчета.
	getDataSource	Метод getDataSource возвращает источник данных по ключу.
	getDim	Метод getDim возвращает измерение по своему ключу и по ключу его источника.
	getDimFilterOdId	Метод getDimFilterOdId возвращает идентификатор фильтра измерений экспресс-отчета.
	getDimOdId	Метод getDimOdId возвращает моникёр для измерения экспресс-отчета.
	getDimPosition	Метод getDimPosition возвращает положение измерения в кубе, на котором построен экспресс-отчёт.
	getDimSources	Метод getDimSources возвращает массив источников измерений для экспресс-отчета.
	getDims	Метод getDims возвращает массив измерений у экспресс-отчета.
	getDimsByPosition	Метод getDimsByPosition возвращает массив измерений отчета в указанной позиции.
	getDimsState	Метод getDimsState возвращает сведения об измерениях в экспресс-отчете.
	getIndAgg	Метод getIndAgg возвращает установленный тип агрегации метрики.
	getIndicatorEls	Метод getIndicatorEls возвращает перечень измерений метрик заданного типа визуализатора.
	getIndValue	Метод getIndValue возвращает значение индикатора для карты или пузырьковой диаграммы экспресс-отчета.
	getIsADOMD	Метод getIsADOMD возвращает признак того, что экспресс-отчет построен на основе ADOMD-куба.
	getIsDmHier	Метод getIsDmHier возвращает ключ измерения, для которого измерение экспресс-отчета с указанным ключом является альтернативной иерархией.
	getIsNewReport	Метод getIsNewReport определяет, был ли ранее сохранён данный экспресс-отчет.
	getIsPPSrvCreate	Метод getIsPPSrvCreate определяет, был ли создан экспресс-отчет при помощи сервиса EaxMdService.
	getMapId	Метод getMapId возвращает идентификатор представления данных «Карта» у экспресс-отчета.
	getMetricOdId	Метод getMetricOdId возвращает идентификатор метрики выбранного визуализатора.
	getPvtSortItemDimId	Метод getPvtSortItemDimId возвращает моникёр для сортировки таблицы экспресс-отчёта.
	getSelectedParts	Метод getSelectedParts возвращает массив областей таблицы, входящих в текущее выделение.
	getServiceTbFormat	Метод getServiceTbFormat преобразует указанный формат топоосновы в TopobaseFormat (перечисление сервисов платформы).
	getSourceName	Метод getSourceName возвращает имя источника данных экспресс-отчета по его ключу.
	getSourcePrivateDims	Метод getSourcePrivateDims возвращает ключи частных измерений указанного источника.
	getSpecialValidDimKeys	Метод getSpecialValidDimKeys возвращает ключи измерений указанного типа.
	getTabId	Метод getTabId возвращает идентификатор представления данных «Таблица» у экспресс-отчета.
	getTableParts	Метод getTableParts возвращает массив всех областей таблицы.
	getTypeGrowth	Метод getTypeGrowth возвращает тип установленного индикатора роста.
	hasDataSources	Метод hasDataSources определяет наличие измерений у экспресс-отчета.
	isMapAvailable	Метод isMapAvailable определяет, доступно ли представление данных «Карта» в экспресс-отчёте.
	transposeSelection	Метод transposeSelection транспонирует диапазон выделенных ячеек в таблице экспресс-отчета.
	waitFor	Метод waitFor выставляет маркер ожидания указанной операции в экспресс-отчете.

Свойства, унаследованные от класса PP.Mb.Object

Методы, унаследованные от класса PP.Mb.Object

Свойства, унаследованные от класса Descriptor

	Имя свойства	Краткое описание
	Class	Свойство Class определяет класс объекта репозитория.
	HasChildren	Свойство HasChildren определяет признак наличия дочерних объектов.
	IsLink	Свойство IsLink возвращает признак того, что данный объект находится в другом репозитории.
	IsShortcut	Свойство IsShortcut возвращает признак того, что данный объект является ярлыком на другой объект репозитория.
	Key	Свойство Key определяет ключ объекта репозитория.
	Metadata	Свойство Metadata определяет метаданные объекта.
	Name	Свойство Name определяет имя объекта.
	ParentKey	Свойство ParentKey определяет ключ родительского объекта.
	TimeStamp	Свойство TimeStamp определяет дату и время последнего изменения объекта репозитория.
	Visible	Свойство Visible возвращает признак видимости объекта репозитория.

Методы, унаследованные от класса Descriptor

Свойства, унаследованные от класса Object

Методы, унаследованные от класса Object

	Имя метода	Краткое описание
	clone	Метод clone создает копию объекта.
	dispose	Метод dispose уничтожает компонент.
	getHashCode	Метод getHashCode возвращает хэш-код объекта репозитория.
	getSettings	Метод getSettings возвращает настройки объекта репозитория.
	getTypeName	Метод getTypeName возвращает имя типа объекта без пространства имен, к которому он принадлежит.
	isEqual	Метод isEqual определяет, равен ли заданный объект текущему объекту репозитория.
	isLive	Метод isLive определяет действительность объекта репозитория.
	removeAllEvents	Метод removeAllEvents удаляет все обработчики событий объекта по заданному контексту.
	setSettings	Метод setSettings задает настройки объекта репозитория.
	defineProps	Метод defineProps создает методы get и set из массива имен для указанного класса.
	keys	Метод keys возвращает массив названий методов и свойств для указанного объекта.

	Имя свойства	Краткое описание
	ActiveSheetKey	Свойство ActiveSheetKey определяет ключ активного листа.
	DocumentMetadata	Свойство DocumentMetadata определяет метаданные документа.
	DocumentOdld	Свойство DocumentOdld определяет объект, содержащий моникёр документа рабочей книги.
	OpenRub	Свойство OpenRub определяет базу данных временных рядов.

	Имя метода	Краткое описание
	checkSheetName	Метод checkSheetName проверяет допустимость нового названия листа.
	getActiveSheet	Метод getActiveSheet возвращает активный лист.
	getSheet	Метод getSheet возвращает объект листа по ключу или идентификатору.
	getSheetName	Метод getSheetName возвращает имя листа по ключу или идентификатору.
	getSheetOdld	Метод getSheetOdld возвращает объект, содержащий моникёр листа, по ключу.
	getSheets	Метод getSheets возвращает список всех листов в документе.
	removeSheet	Метод removeSheet удаляет лист по ключу или идентификатору.

	Имя свойства	Краткое описание
	Metabase	Свойство Metabase определяет репозиторий, в котором хранится объект.
	Names	Свойство Names определяет коллекцию наименований объекта для разных языков.
	OdId	Свойство OdId определяет строку моникёра объекта репозитория.
	Params	Свойство Params определяет коллекцию параметров объекта репозитория.
	PPService	Свойство PPService определяет сервис для работы с объектом репозитория.
	ReadOnly	Свойство ReadOnly определяет возможность редактирования объекта репозитория.
	ShareUrl	Свойство ShareUrl определяет URL-адрес объекта репозитория.

	Имя метода	Краткое описание
	getIsOpened	Метод getIsOpened возвращает результат проверки открытия объекта.
	getRights	Метод getRights возвращает эффективные права доступа объекта.