PdfExportOptions
in package
PDF export settings.
Table of Contents
- FONT_BIGGER = 'bigger'
- Larger font size.
- FONT_NORMAL = 'normal'
- Regular font size.
- FONT_SMALLER = 'smaller'
- Smaller font size.
- PAPER_A4 = 'A4'
- Paper size A4.
- PAPER_A5 = 'A5'
- Paper size A5.
- $columns : int
- Number of columns.
- $fontSize : string
- Font size.
- $metadata : array<string|int, string>
- Additional metadata to include in the output.
- $paperSize : string
- Paper size.
- $printHiddenChords : bool
- Should the output include chords marked as hidden for print?
- __construct() : mixed
- getColumns() : int
- getFontSize() : string
- getMetadata() : array<string|int, string>
- getPaperSize() : string
- isPrintHiddenChords() : bool
- setColumns() : PdfExportOptions
- setFontSize() : PdfExportOptions
- setMetadata() : PdfExportOptions
- setPaperSize() : PdfExportOptions
- setPrintHiddenChords() : PdfExportOptions
Constants
FONT_BIGGER
Larger font size.
public
string
FONT_BIGGER
= 'bigger'
FONT_NORMAL
Regular font size.
public
string
FONT_NORMAL
= 'normal'
FONT_SMALLER
Smaller font size.
public
string
FONT_SMALLER
= 'smaller'
PAPER_A4
Paper size A4.
public
string
PAPER_A4
= 'A4'
PAPER_A5
Paper size A5.
public
string
PAPER_A5
= 'A5'
Properties
$columns
Number of columns.
private
int
$columns
$fontSize
Font size.
private
string
$fontSize
Must be one of the FONT_* constants.
$metadata
Additional metadata to include in the output.
private
array<string|int, string>
$metadata
$paperSize
Paper size.
private
string
$paperSize
Must be one of the PAPER_* constants.
$printHiddenChords
Should the output include chords marked as hidden for print?
private
bool
$printHiddenChords
Methods
__construct()
public
__construct() : mixed
Return values
mixed —getColumns()
public
getColumns() : int
Return values
int —number of columns
getFontSize()
public
getFontSize() : string
Return values
string —font size
getMetadata()
public
getMetadata() : array<string|int, string>
Return values
array<string|int, string> —additional metadata
getPaperSize()
public
getPaperSize() : string
Return values
string —paper size
isPrintHiddenChords()
public
isPrintHiddenChords() : bool
Return values
bool —show non-printed chords?
setColumns()
public
setColumns(int $columns) : PdfExportOptions
Parameters
- $columns : int
-
number of columns
Return values
PdfExportOptions —setFontSize()
public
setFontSize(string $fontSize) : PdfExportOptions
Parameters
- $fontSize : string
-
font size
Return values
PdfExportOptions —setMetadata()
public
setMetadata(array<string|int, string> $metadata) : PdfExportOptions
Parameters
- $metadata : array<string|int, string>
-
additional metadata
Return values
PdfExportOptions —setPaperSize()
public
setPaperSize(string $paperSize) : PdfExportOptions
Parameters
- $paperSize : string
-
paper size
Return values
PdfExportOptions —setPrintHiddenChords()
public
setPrintHiddenChords(bool $printHiddenChords) : PdfExportOptions
Parameters
- $printHiddenChords : bool
-
show non-printed chords?