Tytuł wizualizacji

Przez: Nazwa firmy
Strona główna: Adres URL Twojej firmy

Spis treści

Overview
Przykład
Wczytuję
Format danych
Opcje konfiguracji
Metody
Zdarzenia
Zasady dotyczące danych
Lokalizacja
Notes

Omówienie

Wstaw tutaj krótki opis wyglądu wizualizacji i jej działania. Na przykład: Mapa 3D to trójwymiarowa, możliwa do manipulacji mapa krajów z sferami przypisanymi do określonych regionów. Wielkość i kolor kuli zależą od wartości. Mapa jest renderowana w przeglądarce za pomocą osadzonego odtwarzacza Flash.

Przykład

Opisz swój przykład w zdaniu lub dwóch zdaniach. Umieść w tagu <pre> umieszczony przykład działający oraz kod HTML przykładu na całą stronę, aby umożliwić użytkownikom wycinanie i wklejanie hostowanego przykładu.

Dodaj działający przykładowy kod do tego bloku <div>.

<html>
<head>
  <script type='text/javascript' src='your.url.here'></script>
  <script type='text/javascript' src='//www.google.com/jsapi'></script>
  <script type='text/javascript'>

... Your code here ...

  </script>
</head>

<body>
    <div id='example_canvas'></div>
</body>

</html>

Wczytywanie i tworzenie instancji

Wczytaj tę wizualizację z http://xxx.com tak jak tutaj:

 <script style='text/javascript' src='http://your.url.here'></script>

Nazwa klasy wizualizacji to your.visualization.class.name. Oto przykład utworzenia jej instancji w języku JavaScript:

  var visualization = new your.visualization.class(container_div);

Format danych

Opisz format danych w tabeli danych. Wyjaśnij znaczenie kolumn, wierszy i formatu każdej z nich.

Opcje konfiguracji

Poniższe opcje można dodać do obiektu options przekazywanego do metody draw() wizualizacji.

Nazwa	Typ	Domyślne	Opis
`option_name`	type	wartość domyślna	Pełny opis działania tej opcji. Opisz przypadki skrajne, jakie inne opcje trzeba ustawić, aby zadziałało, z czym występuje konflikt itp.

Metody

Tutaj wymień metody. Pamiętaj, aby opisać parametry i wyniki każdego z nich. Jeszcze lepiej, jeśli dodajesz przykłady. Jeśli parametr jest opcjonalny, podaj go i opisz wartość domyślną. Opisz pełny zakres wartości, jakie może przyjmować każdy parametr.

Metoda	Typ zwracanej wartości	Opis
`draw(data, options)`	Brak	Szczegółowe informacje o metodzie Draw().
`getSelection()`	Tablica elementów zaznaczenia	Implementacja standardowa `getSelection()`. Czy zaznaczenie jest wierszem? Kolumna? Komórka? Czy można dokonać wyboru wielokrotnego?
`setSelection(selection)`	Brak	Implementacja standardowa `setSelection()`. Czy zaznaczenie jest wierszem? Kolumna? Komórka? Czy można dokonać wyboru wielokrotnego?
twojametoda(param1, param2)	Ciąg znaków	Opis metody. param1 – wartość ciągu znaków, która określa imię słonia, które ma być wyświetlane na obrazie. param2 [opcjonalny] – wartość liczbowa określająca wagę słonia w funtach. Zakres wynosi od 200 do 4000 włącznie. Ta liczba określa rozmiar słonia na zdjęciu. Wartość domyślna to 1800.

Zdarzenia

Utwórz listę zdarzeń, które są widoczne w wizualizacji. Pamiętaj, aby opisać, jakie wartości są przekazywane do modułu obsługi zdarzeń, i jak ich używać. Jeszcze lepiej, jeśli dodajesz przykłady.

Nazwa	Opis	Właściwości
`select`	Standardowe zdarzenie wyboru. Zwraca coś	Brak

Zasady dotyczące danych

Omów zasady dotyczące danych i wyjaśnij, jak postępujesz z danymi klientów. Na przykład: „Cały kod i dane są przetwarzane i renderowane w przeglądarce. Żadne dane nie są wysyłane na żaden serwer”.

Lokalizacja

Zakodowane na stałe ciągi znaków w tej wizualizacji mogą być wyświetlane w tych językach, zależnie od ustawień przeglądarki użytkownika:

LUB

Ta wizualizacja nie obsługuje lokalizacji.

Uwagi

Tutaj dodaj dodatkowe informacje o znanych problemach, przypadkach użycia itp.