Мониторинг целевых показателей

ПолучитьНастройкиМонитораЦелевыхПоказателей

Описание, пример вызова

// Возвращает пользовательские настройки монитора целевых показателей
//
// Параметры:
//  Дашборд - СправочникСсылка.ДашбордыМЦП - дашборд с настройками МЦП
//
// Возвращаемое значение:
//  Структура - содержит пользовательские настройки:
//    * ВариантГруппировкиПоказателей - Строка - принимает значения "ПоКатегориямЦелей" и "ПоСостоянию"
//    * ВариантОтображенияДеталей - Строка - принимает значения "ПоказыватьТолькоТекущееЗначение" и "ПоказыватьТекущееЗначениеИДетали"
//    * КоличествоКолонокМонитораПоказателей - Число - количество колонок на форме.
//    * РазмерДиаграмм - Число - принимает значения 1(малый) и 2(Крупный)
//    * ПериодАвтообновления - Число - период в минутах.
//
Функция ПолучитьНастройкиМонитораЦелевыхПоказателей(Дашборд = Неопределено) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьНастройкиМонитораЦелевыхПоказателей(Дашборд);

ПодготовитьДанныеДляЗаполнения

Описание, пример вызова

// Процедура вызывается из фонового задания для подготовки данных для заполнения
// монитора целевых показателей.
//
// Параметры:
//  ПараметрыСоставаМонитора - Структура - структура параметров для подготовки данных:
//    * СтруктураНастроек - см. МониторингЦелевыхПоказателей.ПолучитьНастройкиМонитораЦелевыхПоказателей
//    * ОтборСтатус - Строка, СписокЗначений - значения отбираемых статусов
//    * ПериодичностьКонтроля - ПеречислениеСсылка.Периодичность - периодичность контроля варианта анализа
//    * УчитыватьВариантыОтображения - Булево - учитывать визуальное представление при подготовке данных
//    * ДемонстрационныйРежим - Булево - получить демонстрационные данные вместо реальных
//  АдресХранилища - Строка - адрес временного хранилища с подготовленными данными.
//
Процедура ПодготовитьДанныеДляЗаполнения(ПараметрыСоставаМонитора, АдресХранилища) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ПодготовитьДанныеДляЗаполнения(ПараметрыСоставаМонитора, АдресХранилища)

ПолучитьСоставМонитора

Описание, пример вызова

// Функция возвращает подготовленный состав монитора целевых показателей
//
// Параметры:
//  ПараметрыСоставаМонитора - см. МониторингЦелевыхПоказателей.ПодготовитьДанныеДляЗаполнения.ПараметрыСоставаМонитора
//
// Возвращаемое значение:
//  Структура -
Функция ПолучитьСоставМонитора(ПараметрыСоставаМонитора) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьСоставМонитора(ПараметрыСоставаМонитора)

ПолучитьСоставМонитораВзаимосвязанных

Описание, пример вызова

// Функция возвращает подготовленный состав взаимосвязанных показателей монитора
// Параметры:
//  ПараметрыСоставаМонитора - Структура - структура параметров для подготовки данных. См. МониторингЦелевыхПоказателей.ПодготовитьДанныеДляЗаполнения.
//
// Возвращаемое значение:
//  См. ПолучитьВзаимосвязанныеВариантыАнализа
//
Функция ПолучитьСоставМонитораВзаимосвязанных(ПараметрыСоставаМонитора) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьСоставМонитораВзаимосвязанных(ПараметрыСоставаМонитора)

СтруктураВывода

Описание, пример вызова

// Возвращает порядок вывода блоков информации в виде структуры
//
// Параметры:
//  СоставМонитора - Структура - таблица ссылок на показатели, которые должны попасть в отчет
// Возвращаемое значение:
//  Структура - описание порядка вывода блоков информации.
//
Функция СтруктураВывода(СоставМонитора) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.СтруктураВывода(СоставМонитора)

РасчетИсточниковДанныхВариантовАнализа

Описание, пример вызова

// Выполняет расчет источников данных, доступных хотя бы одному пользователю.
// Вызывается из регламентного задания "РасчетИсточниковДанныхВариантовАнализа".
//
Процедура РасчетИсточниковДанныхВариантовАнализа() Экспорт

Пример вызова

МониторингЦелевыхПоказателей.РасчетИсточниковДанныхВариантовАнализа()

ПолучитьВзаимосвязанныеВариантыАнализа

Описание, пример вызова

// Возвращает набор источников данных взаимосвязанных вариантов анализа
//
// Параметры:
//  ВидПоиска - ПеречислениеСсылка.ВидыПоискаСвязанныхПоказателей - способ поиска связей
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - вариант анализа, для которого ищутся взаимосвязанные
//  ОтборЗонаВнимания - Число - характеризует статус или набор статусов
//  АдресаДинамическихПараметров - ТаблицаЗначений - содержит варианты анализа и адреса их дин. параметров.
//  ДемоДанные - Булево - Флаг построения отчета по демо-данным.
//
// Возвращаемое значение:
//  Структура - содержит набор источников данных и обобщенную информацию об источниках взаимосвязанных показателей:
//   *НаборИсточниковДанных - ТаблицаЗначений - Таблица источников:
//     **ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Вариант анализа.
//     **Цель - СправочникСсылка.СтруктураЦелей - Цель.
//     **ЦельЦелевойПоказатель - Строка - Целевой показатель.
//     **СостояниеПоНарастающемуИтогу - Булево - флаг расчета состояния по нарастающему итогу.
//     **ВариантОтображения - ПеречислениеСсылка.ВариантыОтображенияВариантовАнализа - Вариант отображения.
//     **ВыводитьПодробности - Булево - Флаг вывода подробностей.
//     **ВыводитьИтогТаблицы - Булево - Флаг вывода итогов таблицы.
//     **Позиция - Число - реквизит дополнительного упорядочивания варианта анализа.
//     **НаименованиеЦелевогоПоказателя - Строка - Краткое наименование целевого показателя.
//     **Группа - ПеречислениеСсылка.ВидыПоискаСвязанныхПоказателей - группа.
//     **ИсточникДанных - См. ПолучитьИсточникДанныхВариантаАнализа
//     **ЗонаВнимания - См. ЗонаАнализаЗначения
//     **Пустой - Булево -
//     **РасчетыНеактуальны - Булево -
//     **ОшибкаРасчета - Булево -
//     **ПорядокЗоныВнимания - Неопределено, ПеречислениеСсылка.ЗоныВниманияВариантовАнализа -
//   *СтатистикаПоСтрокам - См. СтатистикаИсточниковДанныхПоЗонамВнимания
//   *Пустой - Булево - Флаг пустого состава монитора.
//
Функция ПолучитьВзаимосвязанныеВариантыАнализа(ВидПоиска, ВариантАнализа, ОтборЗонаВнимания, АдресаДинамическихПараметров, ДемоДанные = Ложь) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьВзаимосвязанныеВариантыАнализа(ВидПоиска, ВариантАнализа, ОтборЗонаВнимания, АдресаДинамическихПараметров, ДемоДанные);

ПолучитьПараметрыДоступностиАнализаВзаимосвязанных

Описание, пример вызова

// Возвращает доступность зависимых/влияющих вариантов анализа для текущего пользователя
// и переданного варианта анализа.
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - вариант анализа, для которого ищутся взаимосвязанные.
//
// Возвращаемое значение:
//  Структура - содержит признаки доступности:
//    *ЕстьДоступныеВлияющие - Булево -
//    *ЕстьДоступныеЗависимые - Булево -
//
Функция ПолучитьПараметрыДоступностиАнализаВзаимосвязанных(ВариантАнализа) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьПараметрыДоступностиАнализаВзаимосвязанных(ВариантАнализа)

ВывестиОтдельныеПоказатели

Описание, пример вызова

// Заполняет табличный документ информацией отдельных вариантов анализа
//
// Параметры:
//  ТабличныйДокумент - ТабличныйДокумент - табличный документ для заполнения
//  СоставМонитора - Структура - см. ПодготовитьДанныеДляЗаполнения:
//   *Параметры - Структура -:
//    **РежимАнализаВзаимосвязанных - Булево -
//  СтруктураВывода - Структура - описание порядка вывода блоков информации.
//
Процедура ВывестиОтдельныеПоказатели(ТабличныйДокумент, СоставМонитора, СтруктураВывода) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ВывестиОтдельныеПоказатели(ТабличныйДокумент, СоставМонитора, СтруктураВывода)

ВывестиОтдельныйПоказатель

Описание, пример вызова

// Заполняет табличный документ информацией отдельного варианта анализа
//
// Параметры:
//  ТабличныйДокумент - ТабличныйДокумент - табличный документ для заполнения
//  ОписаниеИсточникаДанных - Структура - полное описание источника данных.
//
Процедура ВывестиОтдельныйПоказатель(ТабличныйДокумент, ОписаниеИсточникаДанных) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ВывестиОтдельныйПоказатель(ТабличныйДокумент, ОписаниеИсточникаДанных)

УстановитьПараметрыВывода

Описание, пример вызова

// Устанавливает стандартные параметры вывода для табличного документа
//
// Параметры:
//  ТабличныйДокумент - ТабличныйДокумент - табличный документ для настройки.
//
Процедура УстановитьПараметрыВывода(ТабличныйДокумент) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.УстановитьПараметрыВывода(ТабличныйДокумент)

ПолучитьПоследнееЗначениеМассива

Описание, пример вызова

// Возвращает последнее значение из переданного из СКД массива итогов
//
// Параметры:
//  Данные - Массив из Произвольный - массив итогов.
//  РазвернутьМассив - Булево - Истина, если нужно получить первое значение массива
//
// Возвращаемое значение:
//  Произвольный - последнее значение в массиве.
//
Функция ПолучитьПоследнееЗначениеМассива(Данные, РазвернутьМассив = Ложь) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьПоследнееЗначениеМассива(Данные, РазвернутьМассив);

ПолучитьИсточникДанныхВариантаАнализа

Описание, пример вызова

// Возвращает источник данных варианта анализа
// Если источник данных в кэше устарел, то производится перерасчет и обновление кэша.
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей
//  ВариантОтображения - ПеречислениеСсылка.ВариантыОтображенияВариантовАнализа - кратко, диаграмма, таблица
//  ПринудительноОбновитьДанные - Булево - указывает, что проверять актуальность данных не нужно.
//  ДинамическиеПараметры - Неопределено -
//            - Структура - содержит примененные дин. параметры варианта анализа:
//              *ПериодичностьРасчетаПоказателя - ПеречислениеСсылка.Периодичность - периодичность расчета.
//              *ОбъектАнализа - Строка - имя поля-измерения, которое будет в роли объекта анализа.
//  ДемоДанные - Булево - Флаг построения отчета по демо-данным.
//
// Возвращаемое значение:
//  Структура - источник данных варианта анализа.
//
Функция ПолучитьИсточникДанныхВариантаАнализа(ВариантАнализа, ВариантОтображения, ПринудительноОбновитьДанные = Ложь, ДинамическиеПараметры = Неопределено, ДемоДанные = Ложь) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьИсточникДанныхВариантаАнализа(ВариантАнализа, ВариантОтображения, ПринудительноОбновитьДанные, ДинамическиеПараметры, ДемоДанные);

ПолучитьИсточникДанныхВариантаАнализаИзДемоДанных

Описание, пример вызова

// Возвращает источник данных варианта анализа, на основании демонстрационных данных.
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей
//  ВариантОтображения - ПеречислениеСсылка.ВариантыОтображенияВариантовАнализа - кратко, диаграмма, таблица
//  ДинамическиеПараметры - Неопределено -
//            - Структура - содержит примененные дин. параметры варианта анализа:
//              *ПериодичностьРасчетаПоказателя - ПеречислениеСсылка.Периодичность - периодичность расчета.
//              *ОбъектАнализа - Строка - имя поля-измерения, которое будет в роли объекта анализа.
//  ТаблицаДанных - Неопределено,
//          - ТаблицаЗначений - таблица с возможными колонками (см. Справочник.ВариантыАнализаЦелевыхПоказателей.Форма.НастройкаДемоДанных.ИсточникДемоДанных):
//          *Период - Дата -
//          *ОбъектАнализа - Произвольный -
//          *ЗначениеПоказателя - Число -
//          *ЦелевоеЗначение - Число -
//          *ЦелевойДиапазонМаксимум - Число -
//          *ЦелевойДиапазонМинимум - Число -
//          *ПриведенноеГраничноеПозитивноеОтклонение - Число -
//          *ПриведенноеГраничноеНегативноеОтклонение - Число -
//          *ГраничноеПозитивноеОтклонение - Число -
//          *ГраничноеНегативноеОтклонение - Число -
//          *ЗначениеПоказателяДополнительное - Число -
//
// Возвращаемое значение:
//  См. ИнициализироватьИсточникДанных
Функция ПолучитьИсточникДанныхВариантаАнализаИзДемоДанных(ВариантАнализа, ВариантОтображения, ДинамическиеПараметры = Неопределено, ТаблицаДанных = Неопределено) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьИсточникДанныхВариантаАнализаИзДемоДанных(ВариантАнализа, ВариантОтображения, ДинамическиеПараметры, ТаблицаДанных);

ДатаСоСмещением

Описание, пример вызова

// Возвращает дату, смещенную на указанное количество периодов
//
// Параметры:
//  Дата - Дата - исходная дата
//  Периодичность - ПеречислениеСсылка.Периодичность - шаг периода
//  ЧислоПериодов - Число - число периодов, на которые нужно сдвинуть исходную дату
//  НеделяДекадаСПервогоДня - Булево - указывает, будет ли для периодичности "Неделя" и "Декада"
//     расчетная дата смещаться на начало недели или декады.
//
// Возвращаемое значение:
//  Дата - дата, смещенная на указанное количество периодов.
//
Функция ДатаСоСмещением(Дата, Периодичность, ЧислоПериодов, НеделяДекадаСПервогоДня = Истина) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ДатаСоСмещением(Дата, Периодичность, ЧислоПериодов, НеделяДекадаСПервогоДня);

ПредставлениеПериодаВариантаАнализа

Описание, пример вызова

// Возвращает строковое представление периода варианта анализа
//
// Параметры:
//  ИсточникДанных - См. ИнициализироватьИсточникДанных
//
// Возвращаемое значение:
//  Строка - строковое представление периода варианта анализа.
//
Функция ПредставлениеПериодаВариантаАнализа(Знач ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПредставлениеПериодаВариантаАнализа(ИсточникДанных)

ДополнитьТаблицуПериодов

Описание, пример вызова

// Возвращает таблицу значений, дополненную невошедшими датами
// для последующего использования в качестве объекта СКД.
//
// Параметры:
//  ТаблицаПериодов - ТаблицаЗначений - таблица периодов:
//    *Период - Дата -
//  НачалоПериода   - Дата - начало периода
//  КонецПериода  - Дата - окончание периода
//  Периодичность  - ПеречислениеСсылка.Периодичность - принимает значения "ДЕНЬ,НЕДЕЛЯ,ДЕКАДА,МЕСЯЦ,КВАРТАЛ,ПОЛУГОДИЕ,ГОД".
//
// Возвращаемое значение:
//   ТаблицаЗначений - таблица значений, содержащая колонку "Период" и значения периодов:
//    *Период - Дата -
//
Функция ДополнитьТаблицуПериодов(Знач ТаблицаПериодов, НачалоПериода, КонецПериода, Периодичность) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ДополнитьТаблицуПериодов(ТаблицаПериодов, НачалоПериода, КонецПериода, Периодичность)

ПериодыЗаданнойПериодичности

Описание, пример вызова

// Возвращает таблицу значений для последующего использования в качестве внешнего источника.
//
// Параметры:
//  НачалоПериода   - Дата - начало периода.
//  КонецПериода  - Дата - окончание периода.
//  Периодичность  - ПеречислениеСсылка.Периодичность - принимает значения "ДЕНЬ,НЕДЕЛЯ,ДЕКАДА,МЕСЯЦ,КВАРТАЛ,ПОЛУГОДИЕ,ГОД".
//
// Возвращаемое значение:
//   ТаблицаЗначений   - таблица значений, содержащая колонку "Период" и значения периодов.
//
Функция ПериодыЗаданнойПериодичности(НачалоПериода, КонецПериода, Периодичность) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПериодыЗаданнойПериодичности(НачалоПериода, КонецПериода, Периодичность)

ПериодыСДатойНаКонецПериода

Описание, пример вызова

// Возвращает таблицу значений для последующего использования в качестве внешнего источника.
//
// Параметры:
//  НачалоПериода   - Дата - начало периода.
//  КонецПериода  - Дата - окончание периода.
//  Периодичность  - ПеречислениеСсылка.Периодичность - принимает значения "ДЕНЬ,НЕДЕЛЯ,ДЕКАДА,МЕСЯЦ,КВАРТАЛ,ПОЛУГОДИЕ,ГОД".
//
// Возвращаемое значение:
//   ТаблицаЗначений   - таблица значений, содержащая колонку "ДатаРасчета" и значения периодов.
//
Функция ПериодыСДатойНаКонецПериода(НачалоПериода, КонецПериода, Периодичность) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПериодыСДатойНаКонецПериода(НачалоПериода, КонецПериода, Периодичность)

ПериодыСравненияСАналогичнымиПериодамиВПрошлом

Описание, пример вызова

// Возвращает таблицу значений для последующего использования в качестве внешнего источника.
//
// Параметры:
//  НачалоПериода - Дата - начало периода
//  КонецПериода- Дата - окончание периода
//  ШагПериодовСравнения- ПеречислениеСсылка.Периодичность - период, в котором будет выделен отрезок от начала и до окончания периода.
//  КоличествоПериодов- Число - количество сравниваемых периодов заданной периодичности.
//
// Пример: НачалоПериода = начало года, КонецПериода = текущая дата, ШагПериодовСравнения = год, КоличествоПериодов = 2
//  Будет получен набор периодов с начала года до текущей даты за текущий и прошлый год.
//
// Возвращаемое значение:
//   ТаблицаЗначений - таблица значений, содержащая колонки "ДатаНачалаРасчета", "ДатаОкончанияРасчета" и значения дат:
//    *ДатаНачалаРасчета - Дата -
//    *ДатаОкончанияРасчета - Дата -
//
Функция ПериодыСравненияСАналогичнымиПериодамиВПрошлом(НачалоПериода, КонецПериода, ШагПериодовСравнения, КоличествоПериодов) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПериодыСравненияСАналогичнымиПериодамиВПрошлом(НачалоПериода, КонецПериода, ШагПериодовСравнения, КоличествоПериодов)

ПолучитьТонНасыщенностьЯркостьПоКрасныйЗеленыйСиний

Описание, пример вызова

// Возвращает компоненты цвета по модели HSV, по переданным компонентам RGB
//
// Параметры:
//  Красный - Число - от 0 до 255
//  Зеленый - Число - от 0 до 255
//  Синий - Число - от 0 до 255
//  Тон - Число - возвращается значение от 0 до 360 (градусов)
//  Насыщенность - Число - возвращается значение от 0 до 100 (%)
//  Светлота - Число - возвращается значение от 0 до 100 (%).
//
Процедура ПолучитьТонНасыщенностьЯркостьПоКрасныйЗеленыйСиний(Красный, Зеленый, Синий, Тон, Насыщенность, Светлота) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ПолучитьТонНасыщенностьЯркостьПоКрасныйЗеленыйСиний(Красный, Зеленый, Синий, Тон, Насыщенность, Светлота)

ПолучитьКрасныйЗеленыйСинийВебЦвета

Описание, пример вызова

// Возвращает компоненты цвета по модели RGB, по переданным Web-цвету.
//
// Параметры:
//  Цвет - WebЦвета - системное перечисление.
//  Красный - Число - возвращается значение от 0 до 255.
//  Зеленый - Число - возвращается значение от 0 до 255.
//  Синий - Число - возвращается значение от 0 до 255.
//
Процедура ПолучитьКрасныйЗеленыйСинийВебЦвета(Цвет, Красный, Зеленый, Синий) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ПолучитьКрасныйЗеленыйСинийВебЦвета(Цвет, Красный, Зеленый, Синий)

ПолучитьКрасныйЗеленыйСинийПоТонуНасыщенностиЯркости

Описание, пример вызова

// Возвращает компоненты цвета по модели RGB, по переданным компонентам HSV.
//
// Параметры:
//  Тон - Число - от 0 до 360 (градусов).
//  Насыщенность - Число - от 0 до 100 (%).
//  Светлота - Число - от 0 до 100 (%).
//  Красный - Число - возвращается значение от 0 до 255.
//  Зеленый - Число - возвращается значение от 0 до 255.
//  Синий - Число - возвращается значение от 0 до 255.
//
Процедура ПолучитьКрасныйЗеленыйСинийПоТонуНасыщенностиЯркости(Тон, Насыщенность, Светлота, Красный, Зеленый, Синий) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ПолучитьКрасныйЗеленыйСинийПоТонуНасыщенностиЯркости(Тон, Насыщенность, Светлота, Красный, Зеленый, Синий)

ПолучитьДополнительныйЦветПоТонуНасыщенностиЯркости

Описание, пример вызова

// Возвращает компоненты дополнительного цвета по модели HSV, по переданным компонентам HSV.
//
// Параметры:
//  Тон - Число - от 0 до 360 (градусов).
//  Насыщенность - Число - от 0 до 100 (%).
//  Светлота - Число - от 0 до 100 (%).
//  НовыйТон - Число - возвращается значение от 0 до 360 (градусов).
//  НоваяНасыщенность - Число - возвращается значение от 0 до 100 (%).
//  НоваяСветлота - Число - возвращается значение от 0 до 100 (%).
//
Процедура ПолучитьДополнительныйЦветПоТонуНасыщенностиЯркости(Тон, Насыщенность, Светлота, НовыйТон, НоваяНасыщенность, НоваяСветлота) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ПолучитьДополнительныйЦветПоТонуНасыщенностиЯркости(Тон, Насыщенность, Светлота, НовыйТон, НоваяНасыщенность, НоваяСветлота)

ПолучитьДополнительныйЦветПоКрасныйЗеленыйСиний

Описание, пример вызова

// Возвращает компоненты дополнительного цвета по модели HSV, по переданным компонентам RGB.
//
// Параметры:
//  Красный - Число - от 0 до 255.
//  Зеленый - Число - от 0 до 255.
//  Синий - Число - от 0 до 255.
//  НовыйКрасный - Число - возвращается значение от 0 до 255.
//  НовыйЗеленый - Число - возвращается значение от 0 до 255.
//  НовыйСиний - Число - возвращается значение от 0 до 255.
//
Процедура ПолучитьДополнительныйЦветПоКрасныйЗеленыйСиний(Красный, Зеленый, Синий, НовыйКрасный, НовыйЗеленый, НовыйСиний) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ПолучитьДополнительныйЦветПоКрасныйЗеленыйСиний(Красный, Зеленый, Синий, НовыйКрасный, НовыйЗеленый, НовыйСиний)

ВариантОтчетаПередУдалением

Описание, пример вызова

// Обработчик подписки на событие ВариантОтчетаПередУдалением.
//
// Параметры:
//  Источник - СправочникОбъект.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа
//  Отказ - Булево - признак отказа удаления объекта.
//
Процедура ВариантОтчетаПередУдалением(Источник, Отказ) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ВариантОтчетаПередУдалением(Источник, Отказ)

ЗаполнитьСтруктуруЦелейИВариантыАнализа

Описание, пример вызова

// Процедура заполняет справочники "Категории целей", "Структура целей" и "Варианты анализа целевых показателей",
// а также регистр сведений "Целевые значение вариантов анализа" по заданному шаблону.
// Если ранее демонстрационные показатели уже были созданы, то восстанавливаются стандартные настройки.
// Процедура используется только при обновлении информационной базы, первом запуске
// и может быть вызвана из раздела "Администрирование".
//
Процедура ЗаполнитьСтруктуруЦелейИВариантыАнализа() Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ЗаполнитьСтруктуруЦелейИВариантыАнализа()

ЗаполнитьДиаграммуДляМонитора

Описание, пример вызова

// Возвращает заполненную и настроенную диаграмму для монитора показателей.
//
// Параметры:
//  Диаграмма - Диаграмма - исходный объект.
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//  ИсточникСПараметрами - См. ИнициализироватьИсточникДанных
//
// Возвращаемое значение:
//  Диаграмма - заполненная данными и настроенная диаграмма.
//
Функция ЗаполнитьДиаграммуДляМонитора(Диаграмма, ВариантАнализа, ИсточникСПараметрами) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ЗаполнитьДиаграммуДляМонитора(Диаграмма, ВариантАнализа, ИсточникСПараметрами)

ЗаполнитьТаблицуДляМонитора

Описание, пример вызова

// Заполняет таблицу значений для монитора показателей
//
// Параметры:
//  ТаблицаЗначенийМонитора - ТаблицаЗначений - исходный объект
//  ИдентификаторЭлементаФормы - Строка - строковый идентификатор элемента формы, определяющий уникальность
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа
//  ИсточникСПараметрами - См. ИнициализироватьИсточникДанных
//
Процедура ЗаполнитьТаблицуДляМонитора(ТаблицаЗначенийМонитора, ИдентификаторЭлементаФормы, ВариантАнализа, ИсточникСПараметрами) Экспорт

Пример вызова

МониторингЦелевыхПоказателей.ЗаполнитьТаблицуДляМонитора(ТаблицаЗначенийМонитора, ИдентификаторЭлементаФормы, ВариантАнализа, ИсточникСПараметрами)

ПолучитьДиаграммуПриОшибкахРасчета

Описание, пример вызова

// Возвращает диаграмму с сообщением об ошибке в заголовке
//
// Параметры:
//  ДиаграммаПриОшибках - Диаграмма - диаграмма, в которой будет установлено сообщение об ошибке
//  ТекстОшибки - Строка - текст выводимой ошибки.
//
// Возвращаемое значение:
//  Диаграмма - диаграмма, в которой будет установлено сообщение об ошибке.
//
Функция ПолучитьДиаграммуПриОшибкахРасчета(ДиаграммаПриОшибках, ТекстОшибки) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьДиаграммуПриОшибкахРасчета(ДиаграммаПриОшибках, ТекстОшибки)

ПолучитьВалютуПоУмолчанию

Описание, пример вызова

// Возвращает валюту по умолчанию для заполнения настроек структуры целей и вариантов анализа.
//
// Возвращаемое значение:
//  СправочникСсылка.Валюты - валюта по умолчанию для настроек.
//
Функция ПолучитьВалютуПоУмолчанию() Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьВалютуПоУмолчанию()

ПолучитьИмяЗначенияПеречисления

Описание, пример вызова

// Возвращает имя значения объекта метаданных перечисление по ссылке.
//
// Параметры:
//  ПеречислениеСсылка - ПеречислениеСсылка - значение перечисления.
//
// Возвращаемое значение:
//  Строка - Если не найдено, то пустая строка.
//
Функция ПолучитьИмяЗначенияПеречисления(ПеречислениеСсылка) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьИмяЗначенияПеречисления(ПеречислениеСсылка)

ПолучитьИндексКартинкиСостоянияДляПоказателя

Описание, пример вызова

// Возвращает индекс картинки, характеризующей состояние(статус) показателя для списка.
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//
// Возвращаемое значение:
//  Число - индекс картинки в коллекции.
//
Функция ПолучитьИндексКартинкиСостоянияДляПоказателя(ВариантАнализа, ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьИндексКартинкиСостоянияДляПоказателя(ВариантАнализа, ИсточникДанных)

ПолучитьИндексКартинкиТрендаДляПоказателя

Описание, пример вызова

// Возвращает индекс картинки, характеризующей тренд(характер изменений) показателя для списка.
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//
// Возвращаемое значение:
//  Число - индекс картинки в коллекции.
//
Функция ПолучитьИндексКартинкиТрендаДляПоказателя(ВариантАнализа, ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьИндексКартинкиТрендаДляПоказателя(ВариантАнализа, ИсточникДанных)

ПолучитьКартинкуСостоянияДляПоказателя

Описание, пример вызова

// Возвращает картинку, характеризующую состояние(статус) показателя
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа
//  ИсточникДанных   - ТаблицаЗначений с данными для диаграммы.
//
// Возвращаемое значение:
//  Картинка    - картинка из библиотеки картинок.
//
Функция ПолучитьКартинкуСостоянияДляПоказателя(ВариантАнализа, ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьКартинкуСостоянияДляПоказателя(ВариантАнализа, ИсточникДанных)

ПолучитьКартинкуТрендаДляПоказателя

Описание, пример вызова

// Возвращает картинку, характеризующую тренд(характер изменений) показателя
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//
// Возвращаемое значение:
//  Число - индекс картинки из библиотеки.
//
Функция ПолучитьКартинкуТрендаДляПоказателя(ВариантАнализа, ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьКартинкуТрендаДляПоказателя(ВариантАнализа, ИсточникДанных)

ПолучитьОписаниеТиповСтроки

Описание, пример вызова

// Служебная функция, предназначенная для получения описания типов строки
//
// Параметры:
//  ДлинаСтроки - Число - количество символов в строке.
//
// Возвращаемое значение:
//  ОписаниеТипов - описание строкового типа заданной длины.
//
Функция ПолучитьОписаниеТиповСтроки(ДлинаСтроки) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьОписаниеТиповСтроки(ДлинаСтроки)

ПолучитьОписаниеТиповБулево

Описание, пример вызова

// Служебная функция, предназначенная для получения описания типов булево.
//
// Возвращаемое значение:
//  ОписаниеТипов - описание булевого типа.
//
Функция ПолучитьОписаниеТиповБулево() Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьОписаниеТиповБулево()

ПолучитьСвойстваВариантаАнализа

Описание, пример вызова

// Возвращает структуру, содержащую все свойства варианта анализа
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//
// Возвращаемое значение:
//  Структура - структура реквизитов и сопутствующих данных варианта анализа.
//
Функция ПолучитьСвойстваВариантаАнализа(ВариантАнализа, ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьСвойстваВариантаАнализа(ВариантАнализа, ИсточникДанных)

ПолучитьСокращенноеПредставлениеЧисла

Описание, пример вызова

// Возвращает представление числа в виде тыс., млн
//
// Параметры:
//  ИсходноеЧисло - Число - форматируемое число
//  Разрядность - Число - количество знаков после запятой
//  ВидПредставленияЧисла - ПеречислениеСсылка.ВидыПредставленияЧисел - вид представления возвращаемой строки.
//
// Возвращаемое значение:
//  Строка - строковое представление числа в виде <ФорматированноеЧисло> <Размерность>.
//
Функция ПолучитьСокращенноеПредставлениеЧисла(ИсходноеЧисло, Разрядность, ВидПредставленияЧисла) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьСокращенноеПредставлениеЧисла(ИсходноеЧисло, Разрядность, ВидПредставленияЧисла)

ПолучитьСтрокуПредставленияЧисел

Описание, пример вызова

// Возвращает строку для видов тыс., млн
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//
// Возвращаемое значение:
//  Строка - представление размерности числа (пустая строка, "тыс." или "млн.").
//
Функция ПолучитьСтрокуПредставленияЧисел(ВариантАнализа) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьСтрокуПредставленияЧисел(ВариантАнализа)

СтатистикаИсточниковДанныхПоЗонамВнимания

Описание, пример вызова

// Возвращает количества источников данных с разбивкой по зонам внимания и вариантам отображения.
//
// Параметры:
//  НаборИсточниковДанных - ТаблицаЗначений - анализируемый набор
//  УчитыватьВариантыОтображения - Булево
//
// Возвращаемое значение:
//  Структура - содержит количества источников данных.
//
Функция СтатистикаИсточниковДанныхПоЗонамВнимания(НаборИсточниковДанных, УчитыватьВариантыОтображения = Ложь) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.СтатистикаИсточниковДанныхПоЗонамВнимания(НаборИсточниковДанных, УчитыватьВариантыОтображения);

СтатистикаИсточниковДанныхПоСостояниям

Описание, пример вызова

// Возвращает количества источников данных с разбивкой по состояниям и вариантам отображения.
//
// Параметры:
//  НаборИсточниковДанных - ТаблицаЗначений - анализируемый набор
//  УчитыватьВариантыОтображения - Булево
//
// Возвращаемое значение:
//  Структура - содержит количества источников данных.
//
Функция СтатистикаИсточниковДанныхПоСостояниям(НаборИсточниковДанных, УчитыватьВариантыОтображения = Ложь) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.СтатистикаИсточниковДанныхПоСостояниям(НаборИсточниковДанных, УчитыватьВариантыОтображения);

ТипыАнализаИДиаграмм

Описание, пример вызова

// Возвращает свойства типов анализа - доступные типы диаграмм,
// доступность объекта анализа, требуется ли оформление типа анализа.
//
// Возвращаемое значение:
//   ТаблицаЗначений - Описание:
// * ТипАнализа - ПеречислениеСсылка.ТипыАнализаПоказателей -
// * ТипДиаграммы - ПеречислениеСсылка.ТипыДиаграммПоказателей -
// * ОформлениеПокомпонентногоСравненияДоступно - Булево -
// * ОбъектАнализаДоступен - Булево -
// * ПериодСравненияДоступен - Булево -
// * ПрогнозированиеДоступно - Булево -
// * ВыводитьМаркерыТочекДоступно - Булево -
// * ВыводитьМаркерТочекПрогнозаДоступно - Булево -
// * ВыводитьПодписиКДиаграммамДоступно - Булево -
// * ОкантовкаДиаграммДоступно - Булево -
// * РежимСглаживанияДиаграммДоступно - Булево -
Функция ТипыАнализаИДиаграмм() Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ТипыАнализаИДиаграмм()

ПолучитьЦветаСостоянияИТрендаПоказателя

Описание, пример вызова

// Возвращает цвета, характеризующие состояние(статус) и тренд (изменение) показателя.
//
// Параметры:
//  ВариантАнализа - СправочникСсылка.ВариантыАнализаЦелевыхПоказателей - Ссылка на вариант анализа.
//  ИсточникДанных - См. ПолучитьИсточникДанныхВариантаАнализаИзДемоДанных
//
// Возвращаемое значение:
//  Структура - со свойствами:
//    *ЦветСостояния - Цвет - цвет состояния.
//    *ЦветТренда - Цвет - цвет тренда.
//
Функция ПолучитьЦветаСостоянияИТрендаПоказателя(ВариантАнализа, ИсточникДанных) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПолучитьЦветаСостоянияИТрендаПоказателя(ВариантАнализа, ИсточникДанных)

ПрименитьКТаблицеУсловие

Описание, пример вызова

// Возвращает таблицу значений с примененным к ней отбором
//
// Параметры:
//  ТаблицаЗначений - ТаблицаЗначений - обрабатываемая таблица
//  СтруктураОтборов - Структура - применяемые отборы.
//
// Возвращаемое значение:
//  ТаблицаЗначений - обработанная таблица.
//
Функция ПрименитьКТаблицеУсловие(ТаблицаЗначений, СтруктураОтборов) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПрименитьКТаблицеУсловие(ТаблицаЗначений, СтруктураОтборов)

ПрименитьКТаблицеУсловиеНЕ

Описание, пример вызова

// Возвращает таблицу значений с примененным к ней отбором по условию НЕ
//
// Параметры:
//  ТаблицаЗначений - ТаблицаЗначений - обрабатываемая таблица
//  СтруктураОтборов - Структура - применяемые отборы.
//
// Возвращаемое значение:
//  ТаблицаЗначений - обработанная таблица.
//
Функция ПрименитьКТаблицеУсловиеНЕ(ТаблицаЗначений, СтруктураОтборов) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПрименитьКТаблицеУсловиеНЕ(ТаблицаЗначений, СтруктураОтборов)

ПроверитьСхемуКомпоновкиДанных

Описание, пример вызова

// Возвращает результат проверки шаблона расчета целевого показателя
//
// Параметры:
//  МакетСКДПоказателя - СхемаКомпоновкиДанных - проверяемый шаблон расчета.
//
// Возвращаемое значение:
//  Структура - содержит признак корректности шаблона и описание ошибки
//      МакетКорректный - Булево
//      ОписаниеОшибок - Массив - обнаруженные ошибки.
//
Функция ПроверитьСхемуКомпоновкиДанных(МакетСКДПоказателя) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПроверитьСхемуКомпоновкиДанных(МакетСКДПоказателя)

УникальныйИдентификаторВСтроку

Описание, пример вызова

// Возвращает строковое представление уникального идентификатора.
// Символы "-" заменяются на "_".
//
// Параметры:
//  УникальныйИдентификатор - УникальныйИдентификатор - идентификатор, который требуется преобразовать в строку.
//
// Возвращаемое значение:
//  Строка - строковое представление уникального идентификатора.
//
Функция УникальныйИдентификаторВСтроку(УникальныйИдентификатор) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.УникальныйИдентификаторВСтроку(УникальныйИдентификатор)

СтрокуВУникальныйИдентификатор

Описание, пример вызова

// Возвращает уникальный идентификатор из строки, которая была получена функцией УникальныйИдентификаторВСтроку.
//
// Параметры:
//  Строка - Строка - строковое представление уникального идентификатора, полученное функцией УникальныйИдентификаторВСтроку.
//
// Возвращаемое значение:
//  УникальныйИдентификатор - идентификатор, полученный из строки.
//
Функция СтрокуВУникальныйИдентификатор(Строка) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.СтрокуВУникальныйИдентификатор(Строка)

ПредставлениеСостояния

Описание, пример вызова

// Возвращает локализованное представление состояния
//
// Параметры:
//  Состояние - Строка - строковое значение состояния показателя.
//
// Возвращаемое значение:
//  Строка - локализованное, адаптированное для интерфейса представление состояния.
//
Функция ПредставлениеСостояния(Состояние) Экспорт

Пример вызова

Результат = МониторингЦелевыхПоказателей.ПредставлениеСостояния(Состояние)