Eksport wykresów d3.js do pliku PNG (ze wsparciem dla IE11 & EDGE)

401
views

Jeśli na Twojej stronie są dostępne jakieś wykresy możesz spodziewać się tego, że prędzej czy później Twoi użytkownicy zapragną ich eksportu do pliku. Dzisiaj chciałbym opisać prosty sposób na eksportowanie wykresów narysowanych na SVG, w moim wypadku opartych o bibliotekę d3.js (ale to w sumie nie jest ważne co je namalowało ;-)) jako plik PNG z przeźroczystym tłem.

Sposób może w miarę prosty, ale jeśli Twoja aplikacja musi obsługiwać IE11 i EDGE, możesz spodziewać się problemów. Przypadek? Nie sądzę. I właśnie tego głównie będzie dotyczyć ten post – opisu jak się z tym uporałem.

Podstawowa funkcjonalność

Jeden z moich postów dotyczył wykresów malowanych przy pomocy biblioteki d3.js więc wykorzystam podstawy, które zostały tam zaimplementowane. Do tego co zostało wcześniej wypracowane dodałem przycisk, po kliknięciu którego będzie wykonywany eksport.

Element canvas

Aby wyeksportować dane zapisane w formacie SVG do pliku PNG z pomocą przychodzi element canvas. Poniżej przedstawiony jest kod funkcji, która przygotuje element canvas w rozmiarach opartych o rozmiary elementu SVG.

Konwersja danych

Trzeba zakodować dane zapisane w SVG do base64.

Zapis obrazu na elemencie canvas

W drugiej linii tworzony jest obiekt Image, do którego przypisywane są dane zakodowane w formacie base64 (linia 4). Po załadowaniu danych na obraz można go umieścić w elemencie canvas (linia 6).

Obsługa kliknięcia w guzik i zapis do pliku

Po kliknięciu w przycisk trzeba wywołać funkcje, które zostały przedstawione powyżej.

Proces trzeba zacząć od pobrania elementu SVG, który nas interesuje (3 linia), następnie tworzony jest element canvas na podstawie SVG oraz następuje konwersja danych (4 i 5 linia). W ostatnim kroku wywoływana jest funkcja, która zapisuje dane na elemencie canva (7 linia), a jako 3 argument przekazywany jest callback, w którym wyciągamy dane BLOB z elementu canva (8 linia), które można już zapisać jako normalny plik, trzeba jedynie wyzwolić proces pobierania. Można napisać do tego swoje parę linii kodu, ale ja użyłem do tego prostej biblioteki FileSaver.js (9 linia), którą również polecam bo zapewnia nam poprawne działanie na wszystkich popularnych przeglądarkach.

Style wykresów powinny być zahardkodowane inline

Jedną z niefajnych kwestii, które muszą być spełnione aby eksportowane wykresy wyglądały identycznie jak na stronie jest fakt, że wszystkie style muszą być dodane inline, a nie w pliku CSS. Może istnieje jakieś bardziej eleganckie rozwiązanie, ale przyznam szczerze, że ilość tych tyli była na tyle mała, że nie widziałem sensu większego researchu.

To działa!

Powyższe rozwiązanie działa na większości popularnych przeglądarek, jednak nie na Internet Explorer. Chyba nikogo to nie zaskoczyło. Jednak trzeba się z tym jakoś uporać.

Wsparcie dla IE 11, Edge

Znalazłem rozwiązania, które zapewnią optymalne działanie dla wersji 11 i Edge (starszych nie testowałem).

IE posiada własną implementację funkcji canvas.toBlob

Pierwsza nieprawidłowość, która zablokowała działanie w przeglądarkach IE jest dość prosta w naprawie, jednak zaskakująca. Większość przeglądarek korzysta z asynchronicznej funkcji canvas.toBlob, która zwraca obiekt BLOB z elementu canva, ale przeglądarki z rodziny Microsoft posiadają swojego synchronicznego odpowiednika o tajemniczej nazwie canvas.msToBlob.

No więc trzeba trochę zmodyfikować wcześniejszy kod i używać funkcji msToBlob jeśli jest dostępna…

Funkcja ctx.drawImage nie działa jak należy w IE11

Problem napotkany z działaniem funkcji ctx.drawImage w IE11 mocno mnie zaskoczył. Nie dlatego, że coś nie działa jak należy. Zaskoczył mnie bo problrm występuje w specyficznym momencie i było to zgłaszane kilkukrotnie w Issue Trackerach z Microsoftu, jednak nic z tym nie zrobiono.

Funkcja ctx.drawImage nie działa w momencie kiedy obrazek, który chcemy wrzucić do elementu canvas jest zakodowany w formacie base64 i problem występuje prawdopodobnie ze względu na implementację CORS w przeglądarce IE11.

W obejściu tego problemu z pomocą przyszła mi biblioteka canvg, która jakoś sobie poradziła z tym problemem. Bibliotekę używam tylko i wyłącznie dla przeglądarki IE11 jako wyjątek w celu zapewnienia działania funkcjonalności. Problem związany z tą biblioteką jest taki, że wykryłem wycieki pamięci podczas jej używania, dlatego jest ona wykorzystywana tylko warunkowo.

Zamiast zwykłej funkcji drawOnCanvas, dodałem drugą drawOnCanvasForIE11, która jest używana tylko w tym szczególnym przypadku

Działający przykład