Настройка Π²ΠΈΠ΄ΠΆΠ΅Ρ‚ΠΎΠ² с ΠΏΠΎΠΌΠΎΡ‰ΡŒΡŽ JavaScript API

Π’Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ Π½Π°ΡΡ‚Ρ€Π°ΠΈΠ²Π°Ρ‚ΡŒ ΡΡƒΡ‰Π΅ΡΡ‚Π²ΡƒΡŽΡ‰ΠΈΠ΅ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Ρ‹ с ΠΏΠΎΠΌΠΎΡ‰ΡŒΡŽ JavaScript API. Для этой Ρ†Π΅Π»ΠΈ Π²Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΠΈ, описанныС Π½ΠΈΠΆΠ΅.

API доступСн Π² Ρ€Π΅Π΄Π°ΠΊΡ‚ΠΎΡ€Π΅ ΠΊΠΎΠ΄Π° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π° Π² Visiology Designer.

ΠœΠ΅Ρ‚ΠΎΠ΄Ρ‹

visApi().setFilterSelectedValues(widgetGuid, values, handler) void

УстанавливаСт Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ Ρ…ΠΎΡ‚ΠΈΠΌ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€.

values: string[][] - массив массивов Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ Π½ΡƒΠΆΠ½ΠΎ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ, ΠΊΠ°ΠΊ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€. ΠŸΡ€ΠΈΠΌΠ΅Ρ€: [["Москва"], ["Казань"]]. Для сброса Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π° Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ пустой массив: [].

handler: Function() => void - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС Ρ‚ΠΎΠ³ΠΎ, ΠΊΠ°ΠΊ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ Π±Ρ‹Π» установлСн.


visApi().setDateFilterSelectedValues(widgetGuid, values) void

УстанавливаСт Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Π΅ Π΄Π°Ρ‚Ρ‹ Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ Π€ΠΈΠ»ΡŒΡ‚Ρ€ ΠΏΠΎ Π΄Π°Ρ‚Π°ΠΌ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ Ρ…ΠΎΡ‚ΠΈΠΌ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€.

values: Date[][] - массив Π΄Π°Ρ‚, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ Π½ΡƒΠΆΠ½ΠΎ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ Π² Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ ΠΏΠΎ Π΄Π°Ρ‚Π°ΠΌ. ΠŸΡ€ΠΈΠΌΠ΅Ρ€ для мноТСствСнного Π²Ρ‹Π±ΠΎΡ€Π° (ΠΎΡ‚ ΠΈ Π΄ΠΎ): [new Date(), new Date()]. ΠŸΡ€ΠΈΠΌΠ΅Ρ€ для Π΅Π΄ΠΈΠ½ΠΈΡ‡Π½ΠΎΠ³ΠΎ Π²Ρ‹Π±ΠΎΡ€Π°: [new Date()]. Для сброса Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π° Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ пустой массив: [].


visApi().getWidgetDataByGuid(widgetGuid) Promise<{ data: DataFrame, selected : string[][] }>

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Π΄Π°Π½Π½Ρ‹Π΅ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°. Асинхронная функция. На Π΄Π°Π½Π½Ρ‹ΠΉ ΠΌΠΎΠΌΠ΅Π½Ρ‚ Π½Π΅ Ρ€Π°Π±ΠΎΡ‚Π°Π΅Ρ‚ для Π‘Π²ΠΎΠ΄Π½ΠΎΠΉ Ρ‚Π°Π±Π»ΠΈΡ†Ρ‹ ΠΈ Π’Π°Π±Π»ΠΈΡ†Ρ‹.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π΄Π°Π½Π½Ρ‹Π΅ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ ΠΏΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ.

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅ΠΌΡ‹ΠΉ ΠΎΡ‚Π²Π΅Ρ‚: data: DataFrame - Π΄Π°Π½Π½Ρ‹Π΅ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°. selected: string[][] - массив Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Ρ… Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ (Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ΠΎΠ²).


visApi().getSelectedValues(widgetGuid) string[][] = [[" Москва ", " 2020 "], [" Казань ", "2021"]]

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Π΅ значСния (Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Ρ‹) Π½Π° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅.


visApi().getFilterIsOpen(widgetGuid) boolean

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ состояниС Π²Ρ‹ΠΏΠ°Π΄Π°ΡŽΡ‰Π΅Π³ΠΎ списка Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ Β«Π€ΠΈΠ»ΡŒΡ‚Ρ€Β».


visApi().getDrillLevel(widgetGuid) number

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Ρ‚Π΅ΠΊΡƒΡ‰ΠΈΠΉ ΡƒΡ€ΠΎΠ²Π΅Π½ΡŒ drilldown Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ (гистограмма, круговая, Π³Ρ€Π°Ρ„ΠΈΠΊ).

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, ΡƒΡ€ΠΎΠ²Π΅Π½ΡŒ drilldown ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ.


visApi().getDrillPath(widgetGuid) string[][]

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ ΠΏΡƒΡ‚ΡŒ ΠΊ Ρ‚Π΅ΠΊΡƒΡ‰Π΅ΠΌΡƒ ΡƒΡ€ΠΎΠ²Π½ΡŽ drilldown Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ (гистограмма, круговая, Π³Ρ€Π°Ρ„ΠΈΠΊ).

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, ΠΏΡƒΡ‚ΡŒ ΠΊ Ρ‚Π΅ΠΊΡƒΡ‰Π΅ΠΌΡƒ ΡƒΡ€ΠΎΠ²Π½ΡŽ drilldown ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ.


visApi().drillDown(widgetGuid, values) void

ΠŸΡ€ΠΎΠΈΠ·Π²ΠΎΠ΄ΠΈΡ‚ drilldown (ΠΏΡ€ΠΎΠ²Π°Π»ΠΈΠ²Π°Π½ΠΈΠ΅ Π½Π° ΡΠ»Π΅Π΄ΡƒΡŽΡ‰ΠΈΠΉ ΡƒΡ€ΠΎΠ²Π΅Π½ΡŒ) Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π² ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ Π½ΡƒΠΆΠ½ΠΎ произвСсти drilldown.

values: string[] - Π·Π½Π°Ρ‡Π΅Π½ΠΈΠ΅, ΠΏΠΎ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌΡƒ Π½ΡƒΠΆΠ½ΠΎ произвСсти drilldown. ΠŸΠ΅Ρ€Π΅Π΄Π°Π΅Ρ‚ΡΡ массив, Ρ‚Π°ΠΊ ΠΊΠ°ΠΊ Π½Π° ΠΎΠ΄Π½ΠΎΠΌ ΡƒΡ€ΠΎΠ²Π½Π΅ ΠΌΠΎΠΆΠ΅Ρ‚ Π±Ρ‹Ρ‚ΡŒ Ρ€Π°Π·Π±ΠΈΠ΅Π½ΠΈΠ΅ ΠΏΠΎ нСскольким измСрСниям. Если ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ null, Ρ‚ΠΎ drilldown ΠΏΡ€ΠΎΠΈΠ·ΠΎΠΉΠ΄Π΅Ρ‚ ΠΏΠΎ Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹ΠΌ значСниям Π½Π° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅.


visApi().exportWidgetData("xxx")

ЭкспортируСт Π΄Π°Π½Π½Ρ‹Π΅ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π° Π² Excel-Ρ„Π°ΠΉΠ».

xxx – ΠΈΠ΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.


visApi().drillUp(widgetGuid) void

ΠŸΡ€ΠΎΠΈΠ·Π²ΠΎΠ΄ΠΈΡ‚ drillup (Π²ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ Π½Π° ΠΎΠ΄ΠΈΠ½ ΡƒΡ€ΠΎΠ²Π΅Π½ΡŒ Π²Π²Π΅Ρ€Ρ…Π΅ послС drilldown) Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π² ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ Π½ΡƒΠΆΠ½ΠΎ произвСсти drillup.


visApi().setExcludeFilterSelectedValues(widgetGuid, values, handler) void

УстанавливаСт ΠΈΡΠΊΠ»ΡŽΡ‡Π°ΡŽΡ‰ΠΈΠΉ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ Π²Ρ‹ Ρ…ΠΎΡ‚ΠΈΠ΅ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€.

values: string[][] - массив массивов Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Π΅ Π½ΡƒΠΆΠ½ΠΎ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ ΠΊΠ°ΠΊ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€. ΠŸΡ€ΠΈΠΌΠ΅Ρ€: [["Москва"], ["Казань"]]. Для сброса Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π° Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ пустой массив: [].

handler: Function() => voidΒ - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС Ρ‚ΠΎΠ³ΠΎ, ΠΊΠ°ΠΊ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ Π±Ρ‹Π» установлСн.

Π€ΡƒΠ½ΠΊΡ†ΠΈΠΈ, структуры ΠΎΡ‚Π²Π΅Ρ‚ΠΎΠ² ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Ρ… ΠΌΠΎΠ³ΡƒΡ‚ часто ΠΈΠ·ΠΌΠ΅Π½ΡΡ‚ΡŒΡΡ

Π’ Π΄Π°Π½Π½ΠΎΠΌ Ρ€Π°Π·Π΄Π΅Π»Π΅ приводятся Ρ„ΡƒΠ½ΠΊΡ†ΠΈΠΈ, структуры ΠΎΡ‚Π²Π΅Ρ‚ΠΎΠ² ΠΊΠΎΡ‚ΠΎΡ€Ρ‹Ρ… ΠΌΠΎΠ³ΡƒΡ‚ часто ΠΈΠ·ΠΌΠ΅Π½ΡΡ‚ΡŒΡΡ. ΠŸΠΎΡΡ‚ΠΎΠΌΡƒ Π΄Π°Π½Π½Ρ‹Π΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΠΈ Π½Π΅ рСкомСндуСтся ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ.

visApi().getWidgets() object[]

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ ΠΎΠ±ΡŠΠ΅ΠΊΡ‚Ρ‹ всСх Π²ΠΈΠ΄ΠΆΠ΅Ρ‚ΠΎΠ² Π½Π° Π²Ρ‹Π±Ρ€Π°Π½Π½ΠΎΠΌ листС. Π˜ΠΌΠ΅Π΅Ρ‚ ΡΠ»ΠΎΠΆΠ½ΡƒΡŽ структуру для ΠΊΠ°ΠΆΠ΄ΠΎΠ³ΠΎ Ρ‚ΠΈΠΏΠ° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.


visApi().getSelectedWidgets() object[]

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ ΠΎΠ±ΡŠΠ΅ΠΊΡ‚Ρ‹ Π²Ρ‹Π΄Π΅Π»Π΅Π½Π½Ρ‹Ρ… Π²ΠΈΠ΄ΠΆΠ΅Ρ‚ΠΎΠ² Π½Π° Π²Ρ‹Π±Ρ€Π°Π½Π½ΠΎΠΌ листС. Π˜ΠΌΠ΅Π΅Ρ‚ ΡΠ»ΠΎΠΆΠ½ΡƒΡŽ структуру для ΠΊΠ°ΠΆΠ΄ΠΎΠ³ΠΎ Ρ‚ΠΈΠΏΠ° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.


visApi().getWidgetByGuid(widgetGuid) object

Π’ΠΎΠ·Π²Ρ€Π°Ρ‰Π°Π΅Ρ‚ ΠΎΠ±ΡŠΠ΅ΠΊΡ‚ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π° Π½Π° Π²Ρ‹Π±Ρ€Π°Π½Π½ΠΎΠΌ лист. Π˜ΠΌΠ΅Π΅Ρ‚ ΡΠ»ΠΎΠΆΠ½ΡƒΡŽ структуру для ΠΊΠ°ΠΆΠ΄ΠΎΠ³ΠΎ Ρ‚ΠΈΠΏΠ° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ»ΡƒΡ‡ΠΈΡ‚ΡŒ.

Β 

Бобытия

visApi().onSelectedValuesChangedListener({ guid, widgetGuid }, handler) void

Подписка Π½Π° ΠΈΠ·ΠΌΠ΅Π½Π΅Π½ΠΈΠ΅ Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Ρ… Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ΠΎΠ² Ρƒ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ Β guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° ΠΈΠ·ΠΌΠ΅Π½Π΅Π½ΠΈΠ΅ Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Ρ… Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ (Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ΠΎΠ²) ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ΄ΠΏΠΈΡΠ°Ρ‚ΡŒΡΡ.

handler: Function({ widgetGuid: string, filter: WidgetDataFilter, selectedValues: string[][]) => void - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся ΠΏΡ€ΠΈ ΠΈΠ·ΠΌΠ΅Π½Π΅Π½ΠΈΠΈ Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Ρ… Π·Π½Π°Ρ‡Π΅Π½ΠΈΠΉ (Ρ„ΠΈΠ»ΡŒΡ‚Ρ€ΠΎΠ²) Π½Π° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅. filter: WidgetDataFilter - информация ΠΎ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π΅. widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π² ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌ ΠΈΠ·ΠΌΠ΅Π½ΠΈΠ»ΠΈ Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Π΅ значСния. selectedValues: string[][] - Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Π΅ значСния.


visApi().onWidgetLoadedListener({ guid, widgetGuid }, handler) void

Подписка Π½Π° Π·Π°Π³Ρ€ΡƒΠ·ΠΊΡƒ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° Π·Π°Π³Ρ€ΡƒΠ·ΠΊΡƒ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ΄ΠΏΠΈΡΠ°Ρ‚ΡŒΡΡ.

handler: Function({ widgetGuid: string }) => voidΒ  - функция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΈ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°. Если Π²ΠΈΠ΄ΠΆΠ΅Ρ‚ ΡƒΠΆΠ΅ загрузился, Ρ‚ΠΎ функция сработаСт сразу. widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ загрузился. ΠŸΡ€ΠΈΠΌΠ΅Ρ‡Π°Π½ΠΈΠ΅: функция вызываСтся сразу послС выполнСния js ΠΊΠΎΠ΄Π° Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π΅ доТидаясь Π΅Π³ΠΎ отрисовки.


visApi().onAllWidgetsLoadedListener({ guid }, handler) void

Подписка Π½Π° Π·Π°Π³Ρ€ΡƒΠ·ΠΊΡƒ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

handler: Function() => void - функция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΈ всСх Π²ΠΈΠ΄ΠΆΠ΅Ρ‚ΠΎΠ². ΠŸΡ€ΠΈΠΌΠ΅Ρ‡Π°Π½ΠΈΠ΅: функция вызываСтся сразу послС выполнСния js ΠΊΠΎΠ΄Π° послСднСго Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π΅ доТидаясь Π΅Π³ΠΎ отрисовки.


visApi().onFilterIsOpenChangedListener({ guid, widgetGuid }, handler) void

Подписка Π½Π° Π·Π°Π³Ρ€ΡƒΠ·ΠΊΡƒ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°.

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π° Β«Π€ΠΈΠ»ΡŒΡ‚Ρ€Β», Π½Π° ΠΎΡ‚ΠΊΡ€Ρ‹Ρ‚ΠΈΠ΅ Π²Ρ‹ΠΏΠ°Π΄Π°ΡŽΡ‰Π΅Π³ΠΎ списка ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ΄ΠΏΠΈΡΠ°Ρ‚ΡŒΡΡ.

handler: Function({ widgetGuid: string, isOpen: boolean }) => voidΒ  - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС открытия/закрытия Π²Ρ‹ΠΏΠ°Π΄Π°ΡŽΡ‰Π΅Π³ΠΎ списка Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ Β«Π€ΠΈΠ»ΡŒΡ‚Ρ€Β». widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π° Β«Π€ΠΈΠ»ΡŒΡ‚Ρ€Β», Π²Ρ‹ΠΏΠ°Π΄Π°ΡŽΡ‰ΠΈΠΉ список ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ ΠΎΡ‚ΠΊΡ€Ρ‹Π»ΠΈ/Π·Π°ΠΊΡ€Ρ‹Π»ΠΈ. isOpen: boolean - true, Ссли Π²Ρ‹ΠΏΠ°Π΄Π°ΡŽΡ‰ΠΈΠΉ список ΠΎΡ‚ΠΊΡ€Ρ‹Ρ‚.


visApi().onDrillDownListener({ guid, widgetGuid }, handler) void

Подписка Π½Π° drilldown Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ (гистограмма, круговая, Π³Ρ€Π°Ρ„ΠΈΠΊ).

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° drilldown ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ΄ΠΏΠΈΡΠ°Ρ‚ΡŒΡΡ.

handler: Function({ widgetGuid: string, widgetDataContainer: WidgetDataContainer, hierarchyPath: string[][], selectedValues: string[][] }) => voidΒ  - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС Ρ‚ΠΎΠ³ΠΎ, ΠΊΠ°ΠΊ ΠΏΡ€ΠΎΠΈΠ·ΠΎΡˆΠ΅Π» drilldown Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅. widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Ρƒ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ происходит drilldown. widgetDataContainer: WidgetDataContainer - Π΄Π°Π½Π½Ρ‹Π΅ Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π° послС drilldown. hierarchyPath: string[][] - ΠΏΡƒΡ‚ΡŒ ΠΊ Ρ‚Π΅ΠΊΡƒΡ‰Π΅ΠΌΡƒ ΡƒΡ€ΠΎΠ²Π½ΡŽ. selectedValues: string[][] - Π²Ρ‹Π±Ρ€Π°Π½Π½ΠΎΠ΅ Π·Π½Π°Ρ‡Π΅Π½ΠΈΠ΅ ΠΏΡ€ΠΈ drilldown.


visApi().onDrillUpListener({ guid, widgetGuid }, handler) void

Подписка Π½Π° drillup Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ (гистограмма, круговая, Π³Ρ€Π°Ρ„ΠΈΠΊ).

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° drillup ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ΄ΠΏΠΈΡΠ°Ρ‚ΡŒΡΡ.

handler: Function({ widgetGuid: string, hierarchyPath: string[][] }) => voidΒ  - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся послС Ρ‚ΠΎΠ³ΠΎ, ΠΊΠ°ΠΊ ΠΏΡ€ΠΎΠΈΠ·ΠΎΡˆΠ΅Π» drillup Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅. widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Ρƒ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ происходит drilldown. hierarchyPath: string[][] - ΠΏΡƒΡ‚ΡŒ ΠΊ Ρ‚Π΅ΠΊΡƒΡ‰Π΅ΠΌΡƒ ΡƒΡ€ΠΎΠ²Π½ΡŽ.


visApi().onBeforeDrillDownListener({ guid, widgetGuid }, handler) void

Подписка, которая вызываСтся ΠΏΠ΅Ρ€Π΅Π΄ Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΎΠΉ Π΄Π°Π½Π½Ρ‹Ρ… для drilldown Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅ (гистограмма, круговая, Π³Ρ€Π°Ρ„ΠΈΠΊ).

guid: string - ΠΏΡ€ΠΎΠΈΠ·Π²ΠΎΠ»ΡŒΠ½Ρ‹ΠΉ guid подписываСмого события. Π˜ΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠ΅Ρ‚ΡΡ, Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π² памяти Π½Π΅ накапливались подписки. Если ΠΏΠΎΠ²Ρ‚ΠΎΡ€Π½ΠΎ ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚ΡŒ эту ΠΆΠ΅ Ρ„ΡƒΠ½ΠΊΡ†ΠΈΡŽ с Ρ‚Π°ΠΊΠΈΠΌ ΠΆΠ΅ guid, Ρ‚ΠΎ старая подписка ΠΎΡ‚ΠΏΠΈΡˆΠ΅Ρ‚ΡΡ.

widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Π½Π° ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ Π½ΡƒΠΆΠ½ΠΎ ΠΏΠΎΠ΄ΠΏΠΈΡΠ°Ρ‚ΡŒΡΡ.

handler: Function({ widgetGuid: string, hierarchyPath: string[][], selectedValues: string[][] }) => voidΒ  - Ѐункция ΠΎΠ±Ρ€Π°Ρ‚Π½ΠΎΠΉ связи, которая вызываСтся ΠΏΠ΅Ρ€Π΅Π΄ Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΎΠΉ Π΄Π°Π½Π½Ρ‹Ρ… для drilldown Π² Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π΅. widgetGuid: string - guid Π²ΠΈΠ΄ΠΆΠ΅Ρ‚Π°, Ρƒ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠ³ΠΎ происходит drilldown. hierarchyPath: string[][] - ΠΏΡƒΡ‚ΡŒ ΠΊ Ρ‚Π΅ΠΊΡƒΡ‰Π΅ΠΌΡƒ ΡƒΡ€ΠΎΠ²Π½ΡŽ. selectedValues: string[][] - Π²Ρ‹Π±Ρ€Π°Π½Π½ΠΎΠ΅ Π·Π½Π°Ρ‡Π΅Π½ΠΈΠ΅ ΠΏΡ€ΠΈ drilldown.

Β 

ОписаниС ΠΎΠ±ΡŠΠ΅ΠΊΡ‚ΠΎΠ²

DataFrame

primaryData: DataFrameItem - ΠΎΠ±ΡŠΠ΅ΠΊΡ‚, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ Ρ…Ρ€Π°Π½ΠΈΡ‚ Π΄Π°Π½Π½Ρ‹Π΅, сгруппированныС ΠΏΠΎ ΠΏΠ΅Ρ€Π²ΠΎΠΌΡƒ ΠΈΠ·ΠΌΠ΅Ρ€Π΅Π½ΠΈΡŽ (гистограмма, Π³Ρ€Π°Ρ„ΠΈΠΊ ΠΈ Ρ‚.Π΄.).

secondaryData: DataFrameItem - ΠΎΠ±ΡŠΠ΅ΠΊΡ‚, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ Ρ…Ρ€Π°Π½ΠΈΡ‚ Π΄Π°Π½Π½Ρ‹Π΅, сгруппированныС ΠΏΠΎ Π²Ρ‚ΠΎΡ€ΠΎΠΌΡƒ ΠΈΠ·ΠΌΠ΅Ρ€Π΅Π½ΠΈΡŽ (сводная Ρ‚Π°Π±Π»ΠΈΡ†Π°). ΠœΠΎΠΆΠ΅Ρ‚ Π±Ρ‹Ρ‚ΡŒ пустым, Ссли группируСтся Ρ‚ΠΎΠ»ΡŒΠΊΠΎ ΠΏΠΎ ΠΎΠ΄Π½ΠΎΠΌΡƒ ΠΈΠ·ΠΌΠ΅Ρ€Π΅Π½ΠΈΡŽ.

DataFrameItem

key: object - Π·Π½Π°Ρ‡Π΅Π½ΠΈΠ΅, ΠΏΠΎ ΠΊΠΎΡ‚ΠΎΡ€ΠΎΠΌΡƒ, сгруппированы Items.

values: List<object> - значСния ΠΏΠΎΠΊΠ°Π·Π°Ρ‚Π΅Π»Π΅ΠΉ ΠΏΠΎ сгруппированному элСмСнту.

items: List<DataFrameItem> - ΠΎΠ±ΡŠΠ΅ΠΊΡ‚, ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΉ Ρ…Ρ€Π°Π½ΠΈΡ‚ Π΄Π°Π½Π½Ρ‹Π΅, сгруппированныС ΠΏΠΎ ΠΎΠ΄Π½ΠΎΠΌΡƒ ΠΈΠ·ΠΌΠ΅Ρ€Π΅Π½ΠΈΡŽ. Если Π³Ρ€ΡƒΠΏΠΏΠΈΡ€ΡƒΠ΅ΠΌ ΠΏΠΎ нСскольким измСрСниям, Π±ΡƒΠ΄Π΅Ρ‚ Π²Π»ΠΎΠΆΠ΅Π½Π½Ρ‹ΠΉ Items Π²Π½ΡƒΡ‚Ρ€ΠΈ ΠΊΠ°ΠΆΠ΄ΠΎΠ³ΠΎ ΠΎΡ‚Π΄Π΅Π»ΡŒΠ½ΠΎ взятого item.

metadata: List<ValueMetadata> - ΠΌΠ΅Ρ‚Π°Π΄Π°Π½Π½Ρ‹Π΅ ΠΏΠΎΠΊΠ°Π·Π°Ρ‚Π΅Π»Π΅ΠΉ.

ValueMetadata

displayName: string - ΠΎΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ°Π΅ΠΌΠΎΠ΅ Π½Π°Π·Π²Π°Π½ΠΈΠ΅ столбца.

columnName: string - ΠΎΡ€ΠΈΠ³ΠΈΠ½Π°Π»ΡŒΠ½ΠΎΠ΅ Π½Π°Π·Π²Π°Π½ΠΈΠ΅ столбца.

dataType: string - Ρ‚ΠΈΠΏ Π΄Π°Π½Π½Ρ‹Ρ… столбца.

WidgetDataFilter

type: FilterType - Ρ‚ΠΈΠΏ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π°.

values: string[][] - Π²Ρ‹Π±Ρ€Π°Π½Π½Ρ‹Π΅ значСния Π² случаС, ΠΊΠΎΠ³Π΄Π° type Ρ€Π°Π²Π΅Π½ In.

columns: Column[] - список ΠΊΠΎΠ»ΠΎΠ½ΠΎΠΊ, ΠΏΠΎ ΠΊΠΎΡ‚ΠΎΡ€Ρ‹ΠΌ ΠΈΠ΄Π΅Ρ‚ Ρ„ΠΈΠ»ΡŒΡ‚Ρ€Π°Ρ†ΠΈΡ.

from: Date | null - выбранная Π΄Π°Ρ‚Π° "ΠΎΡ‚" Π² случаС, ΠΊΠΎΠ³Π΄Π° type Ρ€Π°Π²Π΅Π½ Between.

to: Date | null - выбранная Π΄Π°Ρ‚Π° "Π΄ΠΎ" Π² случаС, ΠΊΠΎΠ³Π΄Π° type Ρ€Π°Π²Π΅Π½ Between.

Β