ddreport

package module
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2026 License: MIT Imports: 27 Imported by: 0

README

DdDesignReport

Library reporting dengan designer drag and drop. Template didesain di browser, disimpan sebagai JSON, lalu di-render oleh satu core (Go) menjadi PDF, HTML, XLSX, XLS, atau CSV dari backend Go, Java, Kotlin, atau Node.js.

designer/   designer drag and drop (vanilla JS, tanpa dependency) + aplikasi standalone
ddreport.go core renderer (library Go)
fonts/      font bundel (TrueType, SIL OFL), disematkan ke binary
cmd/        binary `ddreport`, dipakai oleh wrapper di bawah dan untuk menjalankan designer
java/       wrapper Java / Kotlin
node/       wrapper Node.js

Designer

Sebagai aplikasi terpisah, lengkap dengan preview:

go build -o ddreport ./cmd/ddreport
./ddreport -serve 127.0.0.1:8080      # buka http://127.0.0.1:8080

Sebagai library di frontend apa pun (npm install ddreport-designer):

import { createDesigner } from 'ddreport-designer'

const designer = createDesigner(document.getElementById('designer'), {
  template: savedTemplate,            // opsional
  onChange: t => save(t),             // dipanggil setiap ada perubahan
  lang: 'id',                         // opsional: antarmuka Indonesia (default 'en')
  theme: 'auto',                      // opsional: 'light' (default), 'dark', atau 'auto'
  fontBase: '/fonts/',                // opsional: URL font bawaan (`ddreport -serve` menyajikannya di /fonts/)
  fonts: ['Inter'],                   // opsional: font tambahan yang didaftarkan di backend
  fields: ['name', 'qty', 'price'],   // opsional: nama field data untuk menu Field; ubah dengan designer.setFields()
  data: sampleData,                   // opsional: data contoh; chart di kanvas digambar darinya; ubah dengan designer.setData()
  preview: async t => {               // opsional, memunculkan tombol Preview
    const res = await fetch('/api/report/preview', { method: 'POST', body: JSON.stringify(t) })
    return res.text()                 // HTML hasil render backend (format "html")
  },
})
designer.getTemplate()                // JSON untuk dikirim ke backend

Designer punya ribbon seperti pengolah kata:

Tab Isi
Home Undo/redo, cut/copy/paste/duplicate, font, ukuran, bold/italic/underline, warna teks, highlight, rata kiri/tengah/kanan/kanan-kiri, rata atas/tengah/bawah, spasi baris, wrap, perataan dan distribusi elemen, urutan depan/belakang
Insert Text box, tabel (baris × kolom), gambar, kotak, garis, chart, barcode/QR, field data (nama field diambil dari data contoh)
Layout Ukuran kertas (A4, A5, Letter, Legal, F4), orientasi, margin per sisi, warna dan gambar latar halaman, urutan data, grouping, pemisah angka, bahasa tanggal, pemisah CSV
View Zoom, penggaris, snap, preview

Chart di kanvas digambar dari data contoh (opsi data), dan barcode tampil sebagai kodenya; hasil cetak tetap dari renderer. Tampilannya menyesuaikan lebar tempat designer dipasang: di layar sempit panel properti pindah ke bawah dan halaman dipaskan ke lebar. Zoom ada di bilah status bawah, dan bisa langsung di kanvas: Ctrl + scroll (atau pinch di trackpad) memperbesar di titik kursor, cubit dua jari di layar sentuh, serta Ctrl + = / - / 0.

Klik tombol di tab Insert atau seret ke band. Klik ganda teks atau sel tabel untuk mengetik langsung di halaman; pilih sebagian teks lalu tekan B/I/U untuk memformat bagian itu saja. Shift-klik, atau seret kotak di area kosong, untuk memilih banyak elemen. Geser elemen untuk memindah (termasuk ke band lain), tarik pegangan biru di sudut kanan bawah untuk mengubah ukuran (juga dengan sentuhan), tarik tepi bawah band untuk mengubah tingginya. Untuk menghapus: klik tombol merah × di sudut elemen terpilih, seret elemen ke tempat sampah yang muncul saat menggeser, atau tekan Delete.

Pintasan: Ctrl+Z / Ctrl+Y (mengetik di satu kolom properti dihitung satu langkah undo), Ctrl+C / X / V / D, Ctrl+A, Ctrl+B / I / U, Ctrl+= / Ctrl+- / Ctrl+0 (zoom), tombol panah (dengan Shift = 10pt), Delete. Tahan Alt saat menggeser untuk mematikan snap.

Ctrl+C / Ctrl+X menaruh elemen terpilih di clipboard sistem, jadi bisa ditempel di designer lain (tab atau laporan lain). Menempel teks biasa membuat text box baru. Untuk tabel, klik sebuah sel lalu pakai tombol di panel properti untuk menyisipkan atau menghapus baris dan kolom di sebelahnya. Klik kanvas kosong untuk mengatur band: tinggi, kepala/kaki halaman hanya di halaman pertama atau terakhir, dan band yang dimulai di halaman baru.

Aplikasi standalone juga punya tombol ekspor PDF, HTML, XLSX, XLS, dan CSV, serta antarmuka Indonesia lewat ?lang=id. Esc saat mengetik membatalkan; New dan Templates… bisa dibatalkan dengan Ctrl+Z.

Preview (tombol mata di bilah status, atau tab View) membuka hasil cetak HTML dengan data contoh: tiap halaman tampil sebagai lembar terpisah, dipaskan ke lebar jendela, dengan jumlah halamannya. Preview dan ekspor butuh halaman dibuka dari ddreport -serve; jika tidak, designer mengatakannya.

Template siap pakai

Delapan template ada di designer/templates/ (faktur, laporan penjualan, struk kasir, slip gaji, sertifikat, surat resmi, daftar stok, label produk). Tiap file berisi template dan data contohnya. Di aplikasi standalone pilih lewat Templates…; go test mencetak semuanya ke setiap format.

Template

Band Muncul
header, columnHeader, footer di setiap halaman; "pages": "first" hanya di halaman pertama, "last" (footer) hanya di halaman terakhir
groupHeader, groupFooter sebelum dan sesudah setiap grup; tanpa groupBy, sekali di sekitar semua baris. Judul grup diulang di atas halaman tempat grupnya berlanjut
detail untuk setiap baris data
summary sekali, setelah baris terakhir

"newPage": true pada groupHeader, detail, groupFooter, atau summary memulai band itu di halaman baru. Band yang lebih tinggi dari satu halaman (misalnya surat panjang dengan Wrap) berlanjut ke halaman berikutnya, baris demi baris; tidak ada teks yang terpotong. Footer yang ikut memanjang tetap di dalam margin bawah.

Placeholder di dalam teks:

Placeholder Arti
{{field}}, {{customer.name}} field dari baris, lalu dari data utama
{{page}}, {{pages}} nomor dan jumlah halaman
{{sum(f)}}, {{avg(f)}}, {{min(f)}}, {{max(f)}}, {{count()}} agregat: per grup di band grup dan detail, seluruh baris di band lain
{{qty * price}}, {{sum(qty * price)}}, {{(price - disc) / 1.11}} perhitungan dengan + - * / dan kurung, juga di dalam agregat
{{unit-price}}, {{[unit-price] * qty}} nama field yang bukan satu kata: langsung jika berdiri sendiri, dalam kurung siku di dalam perhitungan
{{price:2}}, {{sum(price):0}} angka dengan N desimal dan pemisah ribuan (thousands / decimal di template, default , dan .; "thousands": "none" tanpa pemisah ribuan)
{{date:dd MMMM yyyy}}, {{now:dd/MM/yyyy HH:mm}} tanggal dengan pola yyyy yy MMMM MMM MM M dd d EEEE EEE HH H mm ss, teks dalam 'kutip'. {{now}} adalah waktu laporan dibuat. Nama bulan dan hari Indonesia dengan "locale": "id"
{{if(paid, 'LUNAS', 'BELUM')}}, {{upper(name)}}, {{round(x, 2)}} fungsi if, upper, lower, round; perbandingan = != < > <= >=, and, or, not, teks dalam 'kutip'

Angka yang dikirim sebagai teks ("18000", seperti dari BigDecimal atau kolom numeric database) dihitung sebagai angka di rumus, agregat, format :N, dan chart. Hasil hitungan tanpa :N tidak menampilkan sisa pembulatan (0.1 + 0.2 menjadi 0.3).

Urutan: sortBy mengurutkan baris, misalnya "kategori, -total" (- untuk menurun). Angka diurutkan sebagai angka.

Grouping: isi groupBy dengan nama field. Baris dengan nilai yang sama dikumpulkan menjadi satu grup, urut sesuai kemunculan pertama (atau sesuai sortBy). Sampai tiga tingkat: "region, city, store"; tingkat kedua memakai band groupHeader2 / groupFooter2, tingkat ketiga groupHeader3 / groupFooter3, dan agregat di tiap band menghitung grup tingkatnya. Judul semua grup yang sedang berjalan diulang di atas halaman baru. Di designer, band tingkat 2 dan 3 muncul begitu Group by berisi dua atau tiga field.

Sheet per grup: "sheetPerGroup": true membuat XLSX dan XLS berisi satu sheet untuk setiap grup tingkat pertama, dinamai sesuai grupnya (dengan aturan nama sheet Excel: maksimal 31 huruf, tanpa []:*?/\, tidak kembar). Tiap sheet berisi judul kolom, baris, dan totalnya sendiri. groupPageBreak memulai setiap grup di halaman baru.

Format teks: font (lihat Font), fontSize, lineHeight, bold, italic, underline, color, fill (highlight), align (left, center, right, justify), valign (top, middle, bottom). Sebagian teks bisa diformat dengan tag <b>, <i>, <u>: Total <b>{{sum(price):2}}</b>.

Tabel: elemen table dengan cells (teks per sel, boleh berisi placeholder), cols (lebar relatif kolom), aligns (rata per kolom), border, dan fill. Tabel satu baris di band detail menjadi baris data berbingkai.

Gaya tabel, semuanya bisa diatur di panel properti:

Properti Arti
header, headerFill, headerColor baris pertama menjadi judul: tebal, dengan warna latar dan teks sendiri
footer, footerFill, footerColor baris terakhir menjadi baris total (footer). Di designer, mencentang total row menambah satu baris di bawah
stripe warna latar baris isi selang-seling
textColor warna teks isi; color adalah warna garis
grid garis yang digambar: all (default), outer (bingkai luar saja), rows (garis antar-baris saja)
heights tinggi relatif baris, seperti cols: [2,1,1] membuat baris pertama dua kali lebih tinggi
padding jarak teks dari tepi sel dalam pt (default 3 mendatar, 2 tegak)
cellStyle gaya per sel, dengan kunci "baris,kolom" dari 0: fill, color, align, bold, italic, serta colSpan / rowSpan untuk menggabung sel
data nama daftar di data, misalnya items: baris di antara judul dan baris total diulang untuk setiap item (lihat di bawah)
headerLine, footerLine, frame garis lebih tebal (pt) di bawah baris judul, di atas baris total, dan di sekeliling tabel; garis judul ikut diulang di halaman berikutnya, bingkai tertutup di setiap halaman

Tabel data (data): satu tabel untuk daftar di dalam data, misalnya item sebuah pesanan. Baris pertama (header) dan terakhir (footer) dicetak sekali; baris di antaranya diulang per item. Di baris yang diulang, {{field}} adalah field item itu dan {{index}} nomor urutnya; di judul dan baris total, agregat menghitung semua item ({{sum(qty * price):0}}). Taruh di band detail untuk daftar per baris data (pesanan dengan itemnya), atau di summary/header untuk daftar di data utama.

{ "type": "table", "data": "items", "header": true, "footer": true, "border": 1, "grow": true,
  "cells": [["No", "Barang", "Jumlah"],
            ["{{index}}", "{{name}}", "{{qty * price:0}}"],
            ["Total", "", "{{sum(qty * price):0}}"]],
  "cellStyle": { "2,0": { "colSpan": 2, "align": "right" } } }

Tabel yang lebih panjang dari satu halaman berlanjut ke halaman berikutnya: baris tidak pernah terpotong di tengah, dan baris judul diulang di atas setiap halaman. Dengan grow, setiap baris setinggi selnya yang paling panjang. Di XLSX dan XLS, warna latar dan warna teks sel ikut terbawa, dan tabel data menghasilkan satu baris spreadsheet per item.

Di designer: klik sebuah sel, lalu bagian Sel di panel kanan mengatur warna, rata, tebal/miring, serta Gabung ke kanan / Gabung ke bawah / Pisahkan (teks sel yang tergabung ikut dipindahkan). Seret garis antar kolom atau antar baris pada tabel terpilih untuk mengubah lebar dan tingginya. Saat mengetik di sel, Enter menyimpan, Shift+Enter membuat baris baru, Tab / Shift+Tab pindah ke sel berikutnya / sebelumnya. Sel yang disalin dari Excel bisa ditempel langsung ke tabel mulai dari sel yang diklik.

Tampil jika: setiap elemen bisa punya showIf, misalnya paid = 'yes' atau total > 0. Jika kondisinya salah, elemen tidak dicetak (di Excel dan CSV selnya kosong). Kondisi yang salah tulis tetap menampilkan elemen, agar kesalahannya terlihat.

Gambar: PNG, JPEG, atau GIF sebagai data URI. src boleh berupa placeholder seperti {{photo}} yang nilainya data URI dari data, untuk foto produk atau tanda tangan; gambar yang kosong atau rusak dibiarkan kosong, tanpa menggagalkan laporan.

Garis: datar atau tegak sesuai bentuknya; "slope": "down" atau "up" untuk garis miring.

Halaman: page.marginTop / marginRight / marginBottom / marginLeft, page.background (warna), dan page.backgroundImage (gambar yang memenuhi halaman, misalnya kop surat atau watermark).

Teks panjang: centang grow pada elemen teks agar teks dibungkus dan band ikut bertambah tinggi. Elemen di bawahnya turun, kotak dan garis vertikal di sekelilingnya ikut memanjang.

Chart: bar, hbar (batang mendatar), line, pie, atau donut. label adalah nama field baris dan value nama field atau perhitungan (qty * price); nilai dijumlahkan per label. bar, hbar, dan line punya skala nilai yang selalu memuat nol, jadi nilai negatif tampil di bawah garis nol; label kategori ditampilkan selang-seling bila terlalu rapat. pie dan donut menggambar nilai negatif sebagai nol; legendanya selalu punya tempat di samping pie, dan irisan terkecil yang tidak muat digabung menjadi "Other" ("Lainnya" dengan locale id). Chart garis memberi titik di setiap nilai.

Barcode: elemen barcode dengan format qr (default) atau code128. Isinya ada di text dan boleh memuat placeholder, misalnya https://example.com/verify/{{id}}. "showText": true mencetak teksnya di bawah kode. QR code diberi ruang kosong dua modul di sekelilingnya (di dalam kotaknya) agar mudah dipindai di samping elemen lain.

Sub-laporan: elemen subreport dengan data (nama daftar, misalnya lines) dan report (template dengan band sendiri: header, columnHeader, groupHeader... sampai tiga tingkat, detail, summary; footer tidak dipakai, dan sortBy / groupBy boleh diisi). Laporan itu dicetak untuk setiap item di dalam kotak elemen, dan band induknya ikut memanjang. Di band detail setiap baris mendapat sub-laporannya sendiri, misalnya setiap pesanan dengan rincian per jenisnya. Field induk tetap bisa dipakai di dalamnya ({{number}}), {{index}} adalah nomor item. Sub-laporan yang lebih panjang dari satu halaman berlanjut tanpa memotong band, dengan header dan judul kolomnya diulang. Di designer: tab Insert > Sub-report, lalu Edit sub-report… (atau klik ganda) membuka designer untuk band-bandnya, selebar kotaknya.

CSV, XLSX, dan XLS: elemen teks dan sel tabel di band detail menjadi kolom. Teks di band lain (judul kolom, subtotal, total) masuk ke kolom yang sejajar dengannya. Di XLSX dan XLS, teks bold tetap bold, {{f:2}} menjadi format angka, dan lebar kolom mengikuti desain. xls ditulis sebagai XML Spreadsheet 2003; Excel menampilkan satu peringatan format saat membukanya. CSV diawali BOM UTF-8 agar Excel membaca huruf seperti é dengan benar; "csvSeparator": ";" untuk Excel berbahasa Indonesia atau Eropa yang memakai ;. Di CSV, teks yang berawalan seperti formula (=, @, +, -) diberi tanda kutip tunggal di depan agar tidak dijalankan spreadsheet.

{ "number": "INV-001", "customer": { "name": "Budi" }, "rows": [{ "name": "Kopi", "qty": 2 }] }

Backend

Go

import ddreport "github.com/gvjavx/DdDesignReport"

pdf, err := ddreport.Render(templateJSON, data, "pdf") // "pdf" | "html" | "xlsx" | "xls" | "csv"

Java, Kotlin, dan Node.js memanggil binary ddreport. Paketnya membawa binary untuk Windows, Linux, dan macOS (x64 dan arm64); DDREPORT_BIN menunjuk binary lain bila perlu. Binary-nya juga ada di setiap GitHub Release.

Java (Maven Central, io.github.gvjavx:ddreport): tambahkan wrapper-nya dan binary untuk sistem tempat aplikasi berjalan, dengan classifier linux-x64, linux-arm64, windows-x64, windows-arm64, darwin-x64, atau darwin-arm64.

<dependency><groupId>io.github.gvjavx</groupId><artifactId>ddreport</artifactId><version>0.1.1</version></dependency>
<dependency><groupId>io.github.gvjavx</groupId><artifactId>ddreport</artifactId><version>0.1.1</version><classifier>linux-x64</classifier></dependency>
// Gradle
implementation("io.github.gvjavx:ddreport:0.1.1")
runtimeOnly("io.github.gvjavx:ddreport:0.1.1:linux-x64")

Package Java-nya tetap io.ddreport (import io.ddreport.DdReport).

byte[] pdf = DdReport.render(templateJson, dataJson, "pdf");
// batas waktu default 1 menit; atau DdReport.render(templateJson, dataJson, "pdf", Duration.ofSeconds(30))

Kotlin

val pdf = DdReport.render(templateJson, dataJson, "pdf")

Node.js (npm install ddreport; binary untuk sistemnya ikut terpasang)

const { render, renderAsync } = require('ddreport')
const pdf = render(template, data, 'pdf')            // Buffer, sinkron
const pdf2 = await renderAsync(template, data, 'pdf') // tidak memblokir event loop; pakai ini di server
// batas waktu default 60 detik; ubah dengan { timeout: 30000 } sebagai argumen keempat

HTTP: ddreport -serve juga menerima POST /render?format=pdf dengan body {"template": ..., "data": ...}. Render berjalan paling banyak sejumlah prosesor sekaligus; permintaan lain menunggu giliran.

Font

Helvetica, Times, dan Courier adalah font bawaan PDF. Selain itu ikut dibundel: Roboto, Open Sans, Lato, Montserrat, Lora, Playfair Display, dan Great Vibes (lisensi SIL OFL, di fonts/). Font bundel mencakup huruf Latin, Kiril, Yunani, dan Vietnam; di PDF dan HTML huruf yang dipakai ikut disematkan, jadi hasilnya sama di mana pun dibuka.

Font lain bisa didaftarkan dengan file Nama-Regular.ttf, Nama-Bold.ttf, Nama-Italic.ttf, Nama-BoldItalic.ttf (hanya Regular yang wajib):

ddreport.AddFonts(os.DirFS("fonts-saya"))                       // atau:
ddreport.Families["Inter"] = &ddreport.Family{Regular: regular, Bold: bold}

Untuk binary (Java, Kotlin, Node.js, -serve): set DDREPORT_FONTS ke folder berisi file-file itu. Agar namanya muncul di designer, berikan opsi fonts: ['Inter'].

Font non-Latin di PDF

Font bawaan PDF hanya mencakup huruf Latin. Untuk aksara lain, berikan font TrueType:

ddreport.Font, _ = os.ReadFile("NotoSans-Regular.ttf")
ddreport.FontBold, _ = os.ReadFile("NotoSans-Bold.ttf") // opsional

Untuk binary (Java, Kotlin, Node.js, -serve): set DDREPORT_FONT dan DDREPORT_FONT_BOLD ke path file .ttf.

Rilis

Tag versi menjalankan .github/workflows/release.yml: binary untuk setiap sistem dibangun dan dilampirkan ke GitHub Release, paketnya dicoba, lalu diterbitkan ke npm (ddreport, ddreport-<sistem>, ddreport-designer) dan Maven Central (io.github.gvjavx:ddreport).

git tag v0.1.0 && git push origin v0.1.0

npm memakai trusted publishing: setiap paket di npmjs.com mencantumkan gvjavx/DdDesignReport dan release.yml sebagai trusted publisher, sehingga CI menerbitkan tanpa token; NPM_TOKEN hanya dipakai untuk versi pertama paket baru. Untuk Maven dibutuhkan secret MAVEN_CENTRAL_USERNAME, MAVEN_CENTRAL_PASSWORD (user token Central Portal), MAVEN_GPG_PRIVATE_KEY, dan MAVEN_GPG_PASSPHRASE untuk Maven. Registry yang secret-nya belum ada dilewati; versi yang sudah terbit tidak diterbitkan lagi. node release/build.mjs 0.1.0 membangun semuanya di dist/ secara lokal.

Test

go test ./...                         # core, binary, template, dan test regresi
go build -o ddreport ./cmd/ddreport
export DDREPORT_BIN="$PWD/ddreport"   # PowerShell: $env:DDREPORT_BIN = "$PWD\ddreport.exe"
node --test node/test.js              # wrapper Node.js
npm install --no-save playwright && npx playwright install chromium firefox webkit
node designer/run-tests.mjs           # designer di Chromium, Firefox, dan WebKit (mesin Safari)
javac -d out java/io/ddreport/DdReport.java java/DdReportTest.java
java -cp out DdReportTest             # wrapper Java

Designer: sajikan folder designer/ dengan web server (npx serve designer) lalu buka /test.html; halaman itu menjalankan pemeriksaan otomatis pada designer.

.github/workflows/test.yml menjalankan semua test Go, Node.js, dan Java di Linux dan Windows, serta test designer di Chromium, Firefox, dan WebKit, di setiap push.

Documentation

Overview

Package ddreport renders report templates made in the drag-and-drop designer (JSON) to PDF, HTML, XLSX or CSV.

Index

Constants

This section is empty.

Variables

View Source
var BundledFonts embed.FS

BundledFonts holds the bundled TrueType files, named Family-Face.ttf (Face is Regular, Bold, Italic or BoldItalic), with their licences. `ddreport -serve` hands them to the designer.

View Source
var Families = map[string]*Family{}

Families are the fonts a template can name besides the built-in Helvetica, Times and Courier. It starts with the bundled ones (see BundledFonts); add your own at startup:

ddreport.Families["Inter"] = &ddreport.Family{Regular: regular, Bold: bold}
View Source
var Font, FontBold []byte

Font and FontBold replace the built-in PDF font, which only covers Latin (cp1252), with TrueType data. Set them once at startup when reports contain other scripts. FontBold falls back to Font.

Functions

func AddFonts

func AddFonts(fsys fs.FS) error

AddFonts adds every Family-Face.ttf file of fsys (at its root or under fonts/) to Families. "OpenSans-Bold.ttf" is the bold face of "Open Sans".

func Render

func Render(template []byte, data any, format string) ([]byte, error)

Render fills template with data and returns the report in the given format: "pdf", "html", "xlsx", "xls" or "csv". data is anything that marshals to a JSON object (fields plus a row array under DataKey) or to a JSON array of rows.

Types

type Band

type Band struct {
	Height   float64
	Elements []Element
	Pages    string // header, column header, footer: "first" for the first page only, "last" (footer) for the last
	NewPage  bool   // group header, detail, group footer, summary: start on a new page
}

Band is a horizontal strip of the report. Header, ColumnHeader and Footer repeat on every page, Detail repeats per data row, GroupHeader and GroupFooter surround each group (and, without GroupBy, all the rows as one group), Summary follows the last row. A group header is repeated at the top of a page its group continues on.

type CellStyle

type CellStyle struct {
	Fill, Color, Align string // #rrggbb background and text colour; left | center | right | justify
	Bold, Italic       *bool  // unset: as the row
	ColSpan, RowSpan   int
}

CellStyle overrides the look of one table cell, and merges it with its neighbours: ColSpan cells to the right, RowSpan rows down.

type Element

type Element struct {
	Type       string // text | rect | line | image | chart | table | barcode | subreport
	X, Y, W, H float64
	// Text may contain {{field}}, {{a.b}}, {{page}}, {{pages}}, {{now}}, the
	// aggregates {{sum(f)}}, {{avg(f)}}, {{min(f)}}, {{max(f)}}, {{count()}},
	// which run over the group inside group and detail bands and over all rows
	// elsewhere, and the expressions described in expr.go. ":N" formats a
	// number with N decimals ({{sum(price):2}}), a pattern formats a date
	// ({{date:dd MMMM yyyy}}). Parts of it can be styled with <b>, <i> and <u>.
	Text                    string
	ShowIf                  string // condition such as paid = 'yes'; when false the element is not printed
	Font                    string // Helvetica (default) | Times | Courier | a name in Families
	FontSize                float64
	LineHeight              float64 // multiple of the font size, default 1.2
	Bold, Italic, Underline bool
	Grow                    bool   // text: the band grows with the wrapped text instead of clipping it
	Align                   string // left | center | right | justify
	VAlign                  string // text: top (default) | middle | bottom
	Color                   string // #rrggbb, text or stroke colour
	Fill                    string // #rrggbb, background
	Border                  float64
	Src                     string // image: PNG, JPEG or GIF data URI, or a placeholder such as {{photo}} whose value is one
	Slope                   string // line: "down" from top left to bottom right, "up" from bottom left to top right; otherwise flat or upright
	ShowText                bool   // barcode: print its text under it

	Chart        string // bar | hbar | line | pie | donut
	Label, Value string // chart: row fields; values are summed per label

	Format string // barcode: qr (default) | code128; its content is Text

	Cells     [][]string // table: cell texts, row by row
	Cols      []float64  // table: relative column widths, default equal
	Aligns    []string   // table: alignment per column
	TextColor string     // table: colour of the body text; Color is the colour of its lines
	// table: the first row is a header and the last a total row, both bold,
	// each with its own background and text colour
	Header, Footer          bool
	HeaderFill, HeaderColor string
	FooterFill, FooterColor string
	Stripe                  string               // table: background of every second body row
	Grid                    string               // table: which lines a border draws: all (default) | outer | rows
	Data                    string               // table: field with a list; the rows between header and total row repeat for each item
	Heights                 []float64            // table: relative row heights, default equal
	Padding                 *float64             // table: room around a cell's text, default 3pt across and 2pt down
	CellStyle               map[string]CellStyle // table: the look and merging of single cells, keyed "row,column" from 0
	HeaderLine, FooterLine  float64              // table: a heavier line under the header row and over the total row, in pt
	Report                  *Template            // subreport: the report printed for each item of Data, in the element's box
	Frame                   float64              // table: a heavier line around the whole table, in pt

	Points []float64 // internal: x,y pairs of a "poly" (charts), x,y,w,h of the dark runs of a "code" (barcodes); relative to X,Y
	// contains filtered or unexported fields
}

type Family

type Family struct{ Regular, Bold, Italic, BoldItalic []byte }

Family is a TrueType font family. Only Regular is required: a missing bold or italic face falls back to the closest one there is.

type Page

type Page struct {
	Width, Height                                    float64
	Margin                                           float64 // all four sides, unless set per side
	MarginTop, MarginRight, MarginBottom, MarginLeft float64
	Background                                       string // #rrggbb
	BackgroundImage                                  string // data URI, stretched over the page
}

type Template

type Template struct {
	Page           Page
	DataKey        string // key of the row array in the data, default "rows"
	SortBy         string // row fields to sort by, "-" for descending: "category, -total"
	GroupBy        string // row field; rows with the same value form a group. Up to three, "region, city, store", group inside each other
	GroupPageBreak bool   // every group starts on a new page
	Thousands      string // separators used by {{field:2}}, default "," and "."; "none" for no thousands separator
	Decimal        string
	Locale         string // "id" for Indonesian month and day names in dates, English otherwise
	CSVSeparator   string // , (default), ; or a tab
	SheetPerGroup  bool   // xlsx, xls: a worksheet for each group of the first GroupBy field
	Bands          struct {
		Header, ColumnHeader, GroupHeader, Detail, GroupFooter, Summary, Footer Band
		GroupHeader2, GroupFooter2, GroupHeader3, GroupFooter3                  Band // the second and third levels of GroupBy
	}
	// contains filtered or unexported fields
}

Template is the JSON document produced by the designer. All sizes are in points.

Directories

Path Synopsis
cmd
ddreport command
Command ddreport renders a report: it reads {"template": ..., "data": ...} on stdin and writes the report to stdout.
Command ddreport renders a report: it reads {"template": ..., "data": ...} on stdin and writes the report to stdout.
Package designer embeds the report designer and its ready-made templates so `ddreport -serve` can host them.
Package designer embeds the report designer and its ready-made templates so `ddreport -serve` can host them.
examples
go command
Run from the repository root: go run ./examples/go
Run from the repository root: go run ./examples/go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL