Workbook

Пространство имен: PP.TS;

Иерархия наследования

Object

PP.Mb.Descriptor

PP.Mb.Object

PP.Exp.EaxAnalyzer

Workbook

Описание

Класс Workbook описывает модель данных рабочей книги.

Синтаксис

PP.initClass(PP.TS.Workbook, PP.Exp.EaxAnalyzer, "Workbook", PP.Exp.IStatistics);

Свойства

  Имя свойства Краткое описание
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 устанавливает метаданные рабочей книги.

Методы

  Имя метода Краткое описание
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

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

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

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

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

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

Params

Свойство Params определяет коллекцию параметров объекта репозитория.
PPService Свойство PPService определяет сервис для работы с объектом репозитория.
ReadOnly Свойство ReadOnly определяет возможность редактирования объекта репозитория.
ShareUrl Свойство ShareUrl определяет URL-адрес объекта репозитория.

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

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

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

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

ParentKey

Свойство ParentKey определяет ключ родительского объекта.
TimeStamp Свойство TimeStamp определяет дату и время последнего изменения объекта репозитория.
Visible Свойство Visible возвращает признак видимости объекта репозитория.

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

  Имя метода Краткое описание
getState Метод getState возвращает метаданные дескриптора объекта - значения всех свойств класса Descriptor.

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

  Имя свойства Краткое описание

Id

Свойство Id определяет идентификатор объекта репозитория.

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

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

См. также:

PP.TS