Gadget API

• brak

Zwraca true, jeżeli aktualnie zalogowany użytkownik jest właścicielem dashboardu.

if(Gadget.isOwner()){
	// konfiguracja etc...
}

• brak

Zwraca identyfikator gadżetu

var id = Gadget.getId();

• brak

Zwraca klucz gadżetu. Klucz gadżetu składa się z klucza wtyczki oraz klucza modułu np. com.suncode.plugin.dashboard:introduction

var key = Gadget.getKey();

• brak

Zwraca aktualny tytuł gadżetu

var title = Gadget.getTitle();

• title: nowy tytuł gadżetu

Zmienia tekst belki tytułowej gadżetu

Gadget.setTitle('tytuł');

• brak

Uaktualnia rozmiar gadżetu do jego poprawnej wysokości. Wykorzystywane, chcemy wymusić ponowne obliczenie automatycznej wysokości gadżetu (np. załadowanie dynamicznej treści).

Gadget.refreshSize();

• brak

Zwraca true jeżeli gadżet ma zaznaczoną opcję Dopasowana wysokość. Tak skonfigurowany gadżet próbuje dopasować się do faktycznej zawartości.

if(Gadget.hasAutoHeight() == false){
	// akcja
}

• brak

Włącza opcję Dopasowana wysokość. Wysokość gadżetu zostanie dopasowana do zawartości.

Gadget.enableAutoHeight();

• brak

Pobiera wysokość gadżetu w pixelach.

var h = Gadget.getHeight();

• height: nowa wysokość gadżetu (int)

Zmienia wysokość gadżetu. Jeżeli opcja Dopasowana wysokość była aktywna, zostanie ona wyłączona.

Gadget.setHeight(500);

• timeout (opcjonalny) : okres (w sekundach), za który gadżet ma zostać odświeżony

.

Odświeża gadżet, pobierając ponownie zawartość gadżetu zgodnie z jego url. Podczas odświeżenia widoczna jest maska ładowania.

// odśwież natychmiast
Gadget.refresh();
Gadget.refresh(0);
 
// odśwież za 60 minut
Gadget.refresh(60);
 
// nie odświeżaj
Gadget.refresh(-1);
 

• forceChange (opcjonalny): jeżeli true:
  • wyświetlone okno nie ma przycisku Anuluj, co wymusza na użytkowniku zmianę ustawień na poprawne wartości.

Wyświetla widok konfiguracji gadżetu, opcjonalnie zmuszając go do poprawienia konfiguracji.

Gadget.showConfiguration(true);

• brak

Zwraca wszystkie właściwości gadżetu. Zwrócony obiekt ma następującą budowę:

{
	'propertyname': {
		name: 'propertyname',
		value: 'propertyValue',
		type: 'text'
	},
	'secondproperty': {
		...
	},
	...
}

// pobranie wszystkich
var props = Gadget.getProperties();
 
// pobranie konkretnej właściwości
var nameProperty = props['name']

• name: nazwa właściwości, którą chcemy odczytać

Odczytuje podaną właściwość po nazwie. Wynik:

{
	name: 'name',
	value: 'value',
	type: 'text'
}

var nameProperty = Gadget.getProperty('name');

• function: funkcja, wywołana podczas zmiany wysokości gadżetu
  • parametry przekazane do funkcji
    1. newHeight - nowa wysokość w pixelach
    2. newWidth - nowa szerokość w pixelach

• scope (opcjonalny): scope w którym wywołana będzie funkcja

Dodaje EventListener do zdarzenia Resize panelu.

Gadget.onResize(function(gadget){
	console.log('Resized');
});