creator

func (*Background) SetBorderRadius ¶

func (_cb *Background) SetBorderRadius(topLeft, topRight, bottomLeft, bottomRight float64)

SetBorderRadius sets the radius of the background corners.

func (*Block) AddAnnotation ¶

func (_bb *Block) AddAnnotation(annotation *_fee.PdfAnnotation)

AddAnnotation adds an annotation to the current block. The annotation will be added to the page the block will be rendered on.

func (*Block) Angle ¶

func (_gff *Block) Angle() float64

Angle returns the block rotation angle in degrees.

func (*Block) Draw ¶

func (_bfe *Block) Draw(d Drawable) error

Draw draws the drawable d on the block. Note that the drawable must not wrap, i.e. only return one block. Otherwise an error is returned.

func (*Block) DrawTemplate ¶

func (_eed *Block) DrawTemplate(c *Creator, r _fg.Reader, data interface{}, options *TemplateOptions) error

DrawTemplate renders the template provided through the specified reader, using the specified `data` and `options`. Creator templates are first executed as text/template *Template instances, so the specified `data` is inserted within the template. The second phase of processing is actually parsing the template, translating it into creator components and rendering them using the provided options. Both the `data` and `options` parameters can be nil.

func (*Block) DrawWithContext ¶

func (_caa *Block) DrawWithContext(d Drawable, ctx DrawContext) error

DrawWithContext draws the Block using the specified drawing context.

func (*Block) GeneratePageBlocks ¶

func (_fbg *Block) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the block contents on a template Page block. Implements the Drawable interface.

func (*Block) GetMargins ¶

func (_bfg *Block) GetMargins() (float64, float64, float64, float64)

GetMargins returns the Block's margins: left, right, top, bottom.

func (*Block) Height ¶

func (_cdd *Block) Height() float64

Height returns the Block's height.

func (*Block) RotatedSize ¶

func (_feed *Block) RotatedSize() (float64, float64)

RotatedSize returns the width and height of the rotated block.

func (*Block) Scale ¶

func (_fbac *Block) Scale(sx, sy float64)

Scale block by specified factors in the x and y directions.

func (*Block) ScaleToHeight ¶

func (_bce *Block) ScaleToHeight(h float64)

ScaleToHeight scales the Block to a specified height, maintaining the same aspect ratio.

func (*Block) ScaleToWidth ¶

func (_cdea *Block) ScaleToWidth(w float64)

ScaleToWidth scales the Block to a specified width, maintaining the same aspect ratio.

func (*Block) SetAngle ¶

func (_cde *Block) SetAngle(angleDeg float64)

SetAngle sets the rotation angle in degrees.

func (*Block) SetMargins ¶

func (_cbe *Block) SetMargins(left, right, top, bottom float64)

SetMargins sets the Block's left, right, top, bottom, margins.

func (*Block) SetPos ¶

func (_ea *Block) SetPos(x, y float64)

SetPos sets the Block's positioning to absolute mode with the specified coordinates.

func (*Block) Width ¶

func (_gfb *Block) Width() float64

Width returns the Block's width.

func (*Chapter) Add ¶

func (_aec *Chapter) Add(d Drawable) error

Add adds a new Drawable to the chapter. Currently supported Drawables: - *Paragraph - *StyledParagraph - *Image - *Chart - *Table - *Division - *List - *Rectangle - *Ellipse - *Line - *Block, - *PageBreak - *Chapter

func (*Chapter) GeneratePageBlocks ¶

func (_ggbg *Chapter) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generate the Page blocks. Multiple blocks are generated if the contents wrap over multiple pages.

func (*Chapter) GetHeading ¶

func (_dfc *Chapter) GetHeading() *Paragraph

GetHeading returns the chapter heading paragraph. Used to give access to address style: font, sizing etc.

func (*Chapter) GetMargins ¶

func (_ceeb *Chapter) GetMargins() (float64, float64, float64, float64)

GetMargins returns the Chapter's margin: left, right, top, bottom.

func (*Chapter) NewSubchapter ¶

func (_fbcb *Chapter) NewSubchapter(title string) *Chapter

NewSubchapter creates a new child chapter with the specified title.

func (*Chapter) SetIncludeInTOC ¶

func (_adbc *Chapter) SetIncludeInTOC(includeInTOC bool)

SetIncludeInTOC sets a flag to indicate whether or not to include in tOC.

func (*Chapter) SetMargins ¶

func (_gca *Chapter) SetMargins(left, right, top, bottom float64)

SetMargins sets the Chapter margins: left, right, top, bottom. Typically not needed as the creator's page margins are used.

func (*Chapter) SetShowNumbering ¶

func (_bde *Chapter) SetShowNumbering(show bool)

SetShowNumbering sets a flag to indicate whether or not to show chapter numbers as part of title.

func (*Chart) GeneratePageBlocks ¶

func (_dfgb *Chart) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the chart onto a block.

func (*Chart) GetMargins ¶

func (_gbee *Chart) GetMargins() (float64, float64, float64, float64)

GetMargins returns the margins of the chart (left, right, top, bottom).

func (*Chart) Height ¶

func (_beea *Chart) Height() float64

Height returns the height of the chart.

func (*Chart) SetMargins ¶

func (_gccd *Chart) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the chart component.

func (*Chart) SetPos ¶

func (_afe *Chart) SetPos(x, y float64)

SetPos sets the position of the chart to the specified coordinates. This method sets the chart to use absolute positioning.

func (*Chart) Width ¶

func (_eccga *Chart) Width() float64

Width returns the width of the chart. In relative positioning mode, all the available context width is used at render time.

func (*Creator) AddPage ¶

func (_efga *Creator) AddPage(page *_fee.PdfPage) error

AddPage adds the specified page to the creator. NOTE: If the page has a Rotate flag, the creator will take care of transforming the contents to maintain the correct orientation.

func (*Creator) Context ¶

func (_fceg *Creator) Context() DrawContext

Context returns the current drawing context.

func (*Creator) CreateFrontPage ¶

func (_gfgg *Creator) CreateFrontPage(genFrontPageFunc func(_dddd FrontpageFunctionArgs))

CreateFrontPage sets a function to generate a front Page.

func (*Creator) CreateTableOfContents ¶

func (_gfada *Creator) CreateTableOfContents(genTOCFunc func(_gacf *TOC) error)

CreateTableOfContents sets a function to generate table of contents.

func (*Creator) Draw ¶

func (_aage *Creator) Draw(d Drawable) error

Draw processes the specified Drawable widget and generates blocks that can be rendered to the output document. The generated blocks can span over one or more pages. Additional pages are added if the contents go over the current page. Each generated block is assigned to the creator page it will be rendered to. In order to render the generated blocks to the creator pages, call Finalize, Write or WriteToFile.

func (*Creator) DrawFooter ¶

func (_feea *Creator) DrawFooter(drawFooterFunc func(_fdgb *Block, _cfdff FooterFunctionArgs))

DrawFooter sets a function to draw a footer on created output pages.

func (*Creator) DrawHeader ¶

func (_acf *Creator) DrawHeader(drawHeaderFunc func(_afdb *Block, _ebecd HeaderFunctionArgs))

DrawHeader sets a function to draw a header on created output pages.

func (*Creator) DrawTemplate ¶

func (_fcd *Creator) DrawTemplate(r _fg.Reader, data interface{}, options *TemplateOptions) error

DrawTemplate renders the template provided through the specified reader, using the specified `data` and `options`. Creator templates are first executed as text/template *Template instances, so the specified `data` is inserted within the template. The second phase of processing is actually parsing the template, translating it into creator components and rendering them using the provided options. Both the `data` and `options` parameters can be nil.

func (*Creator) EnableFontSubsetting ¶

func (_bdfg *Creator) EnableFontSubsetting(font *_fee.PdfFont)

EnableFontSubsetting enables font subsetting for `font` when the creator output is written to file. Embeds only the subset of the runes/glyphs that are actually used to display the file. Subsetting can reduce the size of fonts significantly.

func (*Creator) Finalize ¶

func (_aebe *Creator) Finalize() error

Finalize renders all blocks to the creator pages. In addition, it takes care of adding headers and footers, as well as generating the front page, table of contents and outlines. Finalize is automatically called before writing the document out. Calling the method manually can be useful when adding external pages to the creator, using the AddPage method, as it renders all creator blocks to the added pages, without having to write the document out. NOTE: TOC and outlines are generated only if the AddTOC and AddOutlines fields of the creator are set to true (enabled by default). Furthermore, TOCs and outlines without content are skipped. TOC and outline content is added automatically when using the chapter component. TOCs and outlines can also be set externally, using the SetTOC and SetOutlineTree methods. Finalize should only be called once, after all draw calls have taken place, as it will return immediately if the creator instance has been finalized.

func (*Creator) Flip ¶

func (_aeebe *Creator) Flip(flipH, flipV bool) error

Flip flips the active page on the specified axes. If `flipH` is true, the page is flipped horizontally. Similarly, if `flipV` is true, the page is flipped vertically. If both are true, the page is flipped both horizontally and vertically. NOTE: the flip transformations are applied when the creator is finalized, which is at write time in most cases.

func (*Creator) GetOptimizer ¶

func (_abdg *Creator) GetOptimizer() _fee.Optimizer

GetOptimizer returns current PDF optimizer.

func (*Creator) Height ¶

func (_fbacg *Creator) Height() float64

Height returns the current page height.

func (*Creator) MoveDown ¶

func (_bebe *Creator) MoveDown(dy float64)

MoveDown moves the drawing context down by relative displacement dy (negative goes up).

func (*Creator) MoveRight ¶

func (_baa *Creator) MoveRight(dx float64)

MoveRight moves the drawing context right by relative displacement dx (negative goes left).

func (*Creator) MoveTo ¶

func (_bcab *Creator) MoveTo(x, y float64)

MoveTo moves the drawing context to absolute coordinates (x, y).

func (*Creator) MoveX ¶

func (_caca *Creator) MoveX(x float64)

MoveX moves the drawing context to absolute position x.

func (*Creator) MoveY ¶

func (_aceda *Creator) MoveY(y float64)

MoveY moves the drawing context to absolute position y.

func (*Creator) NewChapter ¶

func (_bcfb *Creator) NewChapter(title string) *Chapter

NewChapter creates a new chapter with the specified title as the heading.

func (*Creator) NewCurve ¶

func (_dcd *Creator) NewCurve(x1, y1, cx, cy, x2, y2 float64) *Curve

NewCurve returns new instance of Curve between points (x1,y1) and (x2, y2) with control point (cx,cy).

func (*Creator) NewCurvePolygon ¶

func (_fgbb *Creator) NewCurvePolygon(rings [][]_bg.CubicBezierCurve) *CurvePolygon

NewCurvePolygon creates a new curve polygon.

func (*Creator) NewDivision ¶

func (_aaef *Creator) NewDivision() *Division

NewDivision returns a new Division container component.

func (*Creator) NewEllipse ¶

func (_dec *Creator) NewEllipse(xc, yc, width, height float64) *Ellipse

NewEllipse creates a new ellipse with the center at (`xc`, `yc`), having the specified width and height. NOTE: In relative positioning mode, `xc` and `yc` are calculated using the current context. Furthermore, when the fit mode is set to fill the available space, the ellipse is scaled so that it occupies the entire context width while maintaining the original aspect ratio.

func (*Creator) NewFilledCurve ¶

func (_ebdg *Creator) NewFilledCurve() *FilledCurve

NewFilledCurve returns a instance of filled curve.

func (*Creator) NewImage ¶

func (_ggc *Creator) NewImage(img *_fee.Image) (*Image, error)

NewImage create a new image from a unidoc image (model.Image).

func (*Creator) NewImageFromData ¶

func (_edg *Creator) NewImageFromData(data []byte) (*Image, error)

NewImageFromData creates an Image from image data.

func (*Creator) NewImageFromFile ¶

func (_dff *Creator) NewImageFromFile(path string) (*Image, error)

NewImageFromFile creates an Image from a file.

func (*Creator) NewImageFromGoImage ¶

func (_dfe *Creator) NewImageFromGoImage(goimg _a.Image) (*Image, error)

NewImageFromGoImage creates an Image from a go image.Image data structure.

func (*Creator) NewInvoice ¶

func (_faae *Creator) NewInvoice() *Invoice

NewInvoice returns an instance of an empty invoice.

func (*Creator) NewLine ¶

func (_bffae *Creator) NewLine(x1, y1, x2, y2 float64) *Line

NewLine creates a new line between (x1, y1) to (x2, y2), using default attributes. NOTE: In relative positioning mode, `x1` and `y1` are calculated using the current context and `x2`, `y2` are used only to calculate the position of the second point in relation to the first one (used just as a measurement of size). Furthermore, when the fit mode is set to fill the context width, `x2` is set to the right edge coordinate of the context.

func (*Creator) NewLinearGradientColor ¶

func (_bfba *Creator) NewLinearGradientColor(colorPoints []*ColorPoint) *LinearShading

NewLinearGradientColor creates a linear gradient color that could act as a color in other components.

func (*Creator) NewList ¶

func (_ebgc *Creator) NewList() *List

NewList creates a new list.

func (*Creator) NewPage ¶

func (_cfgc *Creator) NewPage() *_fee.PdfPage

NewPage adds a new Page to the Creator and sets as the active Page.

func (*Creator) NewPageBreak ¶

func (_cebb *Creator) NewPageBreak() *PageBreak

NewPageBreak create a new page break.

func (*Creator) NewParagraph ¶

func (_fef *Creator) NewParagraph(text string) *Paragraph

NewParagraph creates a new text paragraph. Default attributes: Font: Helvetica, Font size: 10 Encoding: WinAnsiEncoding Wrap: enabled Text color: black

func (*Creator) NewPolyBezierCurve ¶

func (_ggd *Creator) NewPolyBezierCurve(curves []_bg.CubicBezierCurve) *PolyBezierCurve

NewPolyBezierCurve creates a new composite Bezier (polybezier) curve.

func (*Creator) NewPolygon ¶

func (_ebed *Creator) NewPolygon(points [][]_bg.Point) *Polygon

NewPolygon creates a new polygon.

func (*Creator) NewPolyline ¶

func (_affc *Creator) NewPolyline(points []_bg.Point) *Polyline

NewPolyline creates a new polyline.

func (*Creator) NewRadialGradientColor ¶

func (_dafd *Creator) NewRadialGradientColor(x float64, y float64, innerRadius float64, outerRadius float64, colorPoints []*ColorPoint) *RadialShading

NewRadialGradientColor creates a radial gradient color that could act as a color in other componenents. Note: The innerRadius must be smaller than outerRadius for the circle to render properly.

func (*Creator) NewRectangle ¶

func (_aaeg *Creator) NewRectangle(x, y, width, height float64) *Rectangle

NewRectangle creates a new rectangle with the left corner at (`x`, `y`), having the specified width and height. NOTE: In relative positioning mode, `x` and `y` are calculated using the current context. Furthermore, when the fit mode is set to fill the available space, the rectangle is scaled so that it occupies the entire context width while maintaining the original aspect ratio.

func (*Creator) NewStyledParagraph ¶

func (_dabcd *Creator) NewStyledParagraph() *StyledParagraph

NewStyledParagraph creates a new styled paragraph. Default attributes: Font: Helvetica, Font size: 10 Encoding: WinAnsiEncoding Wrap: enabled Text color: black

func (*Creator) NewStyledTOCLine ¶

func (_ffb *Creator) NewStyledTOCLine(number, title, page TextChunk, level uint, style TextStyle) *TOCLine

NewStyledTOCLine creates a new table of contents line with the provided style.

func (*Creator) NewTOC ¶

func (_dfac *Creator) NewTOC(title string) *TOC

NewTOC creates a new table of contents.

func (*Creator) NewTOCLine ¶

func (_cggb *Creator) NewTOCLine(number, title, page string, level uint) *TOCLine

NewTOCLine creates a new table of contents line with the default style.

func (*Creator) NewTable ¶

func (_ffgg *Creator) NewTable(cols int) *Table

NewTable create a new Table with a specified number of columns.

func (*Creator) NewTextStyle ¶

func (_befe *Creator) NewTextStyle() TextStyle

NewTextStyle creates a new text style object which can be used to style chunks of text. Default attributes: Font: Helvetica Font size: 10 Encoding: WinAnsiEncoding Text color: black

func (*Creator) PageFinalize ¶

func (_aaga *Creator) PageFinalize(pageFinalizeFunc func(_eagbd PageFinalizeFunctionArgs) error)

PageFinalize sets a function to be called for each page before finalization (i.e. the last stage of page processing before they get written out). The callback function allows final touch-ups for each page, and it provides information that might not be known at other stages of designing the document (e.g. the total number of pages). Unlike the header/footer functions, which are limited to the top/bottom margins of the page, the finalize function can be used draw components anywhere on the current page.

func (*Creator) RotateDeg ¶

func (_fbga *Creator) RotateDeg(angleDeg int64) error

RotateDeg rotates the current active page by angle degrees. An error is returned on failure, which can be if there is no currently active page, or the angleDeg is not a multiple of 90 degrees.

func (*Creator) SetForms ¶

func (_dfde *Creator) SetForms(form *_fee.PdfAcroForm) error

SetForms adds an Acroform to a PDF file. Sets the specified form for writing.

func (*Creator) SetOptimizer ¶

func (_dafb *Creator) SetOptimizer(optimizer _fee.Optimizer)

SetOptimizer sets the optimizer to optimize PDF before writing.

func (*Creator) SetOutlineTree ¶

func (_ddfc *Creator) SetOutlineTree(outlineTree *_fee.PdfOutlineTreeNode)

SetOutlineTree adds the specified outline tree to the PDF file generated by the creator. Adding an external outline tree disables the automatic generation of outlines done by the creator for the relevant components.

func (*Creator) SetPageLabels ¶

func (_ecac *Creator) SetPageLabels(pageLabels _dd.PdfObject)

SetPageLabels adds the specified page labels to the PDF file generated by the creator. See section 12.4.2 "Page Labels" (p. 382 PDF32000_2008). NOTE: for existing PDF files, the page label ranges object can be obtained using the model.PDFReader's GetPageLabels method.

func (*Creator) SetPageMargins ¶

func (_eff *Creator) SetPageMargins(left, right, top, bottom float64)

SetPageMargins sets the page margins: left, right, top, bottom. The default page margins are 10% of document width.

func (*Creator) SetPageSize ¶

func (_cfdf *Creator) SetPageSize(size PageSize)

SetPageSize sets the Creator's page size. Pages that are added after this will be created with this Page size. Does not affect pages already created.

Common page sizes are defined as constants. Examples: 1. c.SetPageSize(creator.PageSizeA4) 2. c.SetPageSize(creator.PageSizeA3) 3. c.SetPageSize(creator.PageSizeLegal) 4. c.SetPageSize(creator.PageSizeLetter)

For custom sizes: Use the PPMM (points per mm) and PPI (points per inch) when defining those based on physical page sizes:

Examples: 1. 10x15 sq. mm: SetPageSize(PageSize{10*creator.PPMM, 15*creator.PPMM}) where PPMM is points per mm. 2. 3x2 sq. inches: SetPageSize(PageSize{3*creator.PPI, 2*creator.PPI}) where PPI is points per inch.

func (*Creator) SetPdfWriterAccessFunc ¶

func (_aeec *Creator) SetPdfWriterAccessFunc(pdfWriterAccessFunc func(_ebdd *_fee.PdfWriter) error)

SetPdfWriterAccessFunc sets a PdfWriter access function/hook. Exposes the PdfWriter just prior to writing the PDF. Can be used to encrypt the output PDF, etc.

Example of encrypting with a user/owner password "password" Prior to calling c.WriteFile():

c.SetPdfWriterAccessFunc(func(w *model.PdfWriter) error {
	userPass := []byte("password")
	ownerPass := []byte("password")
	err := w.Encrypt(userPass, ownerPass, nil)
	return err
})

func (*Creator) SetTOC ¶

func (_eaed *Creator) SetTOC(toc *TOC)

SetTOC sets the table of content component of the creator. This method should be used when building a custom table of contents.

func (*Creator) TOC ¶

func (_ccf *Creator) TOC() *TOC

TOC returns the table of contents component of the creator.

func (*Creator) Width ¶

func (_ccce *Creator) Width() float64

Width returns the current page width.

func (*Creator) Write ¶

func (_cecg *Creator) Write(ws _fg.Writer) error

Write output of creator to io.Writer interface.

func (*Creator) WriteToFile ¶

func (_eedb *Creator) WriteToFile(outputPath string) error

WriteToFile writes the Creator output to file specified by path.

func (*Curve) GeneratePageBlocks ¶

func (_ddcb *Curve) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the curve onto page blocks.

func (*Curve) SetColor ¶

func (_cfaa *Curve) SetColor(col Color)

SetColor sets the line color.

func (*Curve) SetWidth ¶

func (_affcb *Curve) SetWidth(width float64)

SetWidth sets line width.

func (*CurvePolygon) GeneratePageBlocks ¶

func (_gcgf *CurvePolygon) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the composite curve polygon on a new block representing the page. Implements the Drawable interface.

func (*CurvePolygon) SetBorderColor ¶

func (_gecb *CurvePolygon) SetBorderColor(color Color)

SetBorderColor sets the border color.

func (*CurvePolygon) SetBorderOpacity ¶

func (_addc *CurvePolygon) SetBorderOpacity(opacity float64)

SetBorderOpacity sets the border opacity.

func (*CurvePolygon) SetBorderWidth ¶

func (_fcacb *CurvePolygon) SetBorderWidth(borderWidth float64)

SetBorderWidth sets the border width.

func (*CurvePolygon) SetFillColor ¶

func (_cbgb *CurvePolygon) SetFillColor(color Color)

SetFillColor sets the fill color.

func (*CurvePolygon) SetFillOpacity ¶

func (_efgc *CurvePolygon) SetFillOpacity(opacity float64)

SetFillOpacity sets the fill opacity.

func (*Division) Add ¶

func (_gag *Division) Add(d VectorDrawable) error

Add adds a VectorDrawable to the Division container. Currently supported VectorDrawables: - *Paragraph - *StyledParagraph - *Image - *Chart - *Rectangle - *Ellipse - *Line - *Table - *Division - *List

func (*Division) EnablePageWrap ¶

func (_dfcg *Division) EnablePageWrap(enable bool)

EnablePageWrap controls whether the division is wrapped across pages. If disabled, the division is moved in its entirety on a new page, if it does not fit in the available height. By default, page wrapping is enabled. If the height of the division is larger than an entire page, wrapping is enabled automatically in order to avoid unwanted behavior. Currently, page wrapping can only be disabled for vertical divisions.

func (*Division) GeneratePageBlocks ¶

func (_egad *Division) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generates the page blocks for the Division component. Multiple blocks are generated if the contents wrap over multiple pages.

func (*Division) Height ¶

func (_cdeb *Division) Height() float64

Height returns the height of the division, assuming all components are stacked on top of each other.

func (*Division) Inline ¶

func (_abfcd *Division) Inline() bool

Inline returns whether the inline mode of the division is active.

func (*Division) Margins ¶

func (_faab *Division) Margins() (_geda, _bbf, _gdfc, _debe float64)

Margins returns the margins of the component.

func (*Division) Padding ¶

func (_aafc *Division) Padding() (_edba, _cgdc, _dfdb, _fbgab float64)

Padding returns the padding of the component.

func (*Division) SetBackground ¶

func (_gccde *Division) SetBackground(background *Background)

SetBackground sets the background properties of the component.

func (*Division) SetInline ¶

func (_dafe *Division) SetInline(inline bool)

SetInline sets the inline mode of the division.

func (*Division) SetMargins ¶

func (_afcg *Division) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the component. The margins are applied around the division.

func (*Division) SetPadding ¶

func (_cdbe *Division) SetPadding(left, right, top, bottom float64)

SetPadding sets the padding of the component. The padding represents inner margins which are applied around the contents of the division. The background of the component is not affected by its padding.

func (*Division) Width ¶

func (_bbcg *Division) Width() float64

Width is not used as the division component is designed to fill all the available space, depending on the context. Returns 0.

func (*Ellipse) BorderColor ¶

func (_fbce *Ellipse) BorderColor() Color

BorderColor returns the border color of the ellipse.

func (*Ellipse) BorderOpacity ¶

func (_bbbcb *Ellipse) BorderOpacity() float64

BorderOpacity returns the border opacity of the ellipse (0-1).

func (*Ellipse) BorderWidth ¶

func (_agbg *Ellipse) BorderWidth() float64

BorderWidth returns the border width of the ellipse.

func (*Ellipse) FillColor ¶

func (_ddea *Ellipse) FillColor() Color

FillColor returns the fill color of the ellipse.

func (*Ellipse) FillOpacity ¶

func (_bgec *Ellipse) FillOpacity() float64

FillOpacity returns the fill opacity of the ellipse (0-1).

func (*Ellipse) FitMode ¶

func (_ebdc *Ellipse) FitMode() FitMode

FitMode returns the fit mode of the ellipse.

func (*Ellipse) GeneratePageBlocks ¶

func (_dbdb *Ellipse) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the ellipse on a new block representing the page.

func (*Ellipse) GetCoords ¶

func (_caad *Ellipse) GetCoords() (float64, float64)

GetCoords returns the center coordinates of ellipse (`xc`, `yc`).

func (*Ellipse) GetMargins ¶

func (_cbce *Ellipse) GetMargins() (float64, float64, float64, float64)

GetMargins returns the margins of the ellipse: left, right, top, bottom.

func (*Ellipse) Height ¶

func (_fcfb *Ellipse) Height() float64

Height returns the height of the ellipse.

func (*Ellipse) Positioning ¶

func (_ecae *Ellipse) Positioning() Positioning

Positioning returns the type of positioning the ellipse is set to use.

func (*Ellipse) Scale ¶

func (_cbcb *Ellipse) Scale(xFactor, yFactor float64)

Scale scales the ellipse dimensions by the specified factors.

func (*Ellipse) ScaleToHeight ¶

func (_bbff *Ellipse) ScaleToHeight(h float64)

ScaleToHeight scales the ellipse to the specified height. The width of the ellipse is scaled so that the aspect ratio is maintained.

func (*Ellipse) ScaleToWidth ¶

func (_ggcf *Ellipse) ScaleToWidth(w float64)

ScaleToWidth scales the ellipse to the specified width. The height of the ellipse is scaled so that the aspect ratio is maintained.

func (*Ellipse) SetBorderColor ¶

func (_bfbg *Ellipse) SetBorderColor(col Color)

SetBorderColor sets the border color of the ellipse.

func (*Ellipse) SetBorderOpacity ¶

func (_bdgcg *Ellipse) SetBorderOpacity(opacity float64)

SetBorderOpacity sets the border opacity of the ellipse.

func (*Ellipse) SetBorderWidth ¶

func (_eccc *Ellipse) SetBorderWidth(bw float64)

SetBorderWidth sets the border width of the ellipse.

func (*Ellipse) SetCoords ¶

func (_gfcg *Ellipse) SetCoords(xc, yc float64)

SetCoords sets the center coordinates of the ellipse.

func (*Ellipse) SetFillColor ¶

func (_bdb *Ellipse) SetFillColor(col Color)

SetFillColor sets the fill color of the ellipse.

func (*Ellipse) SetFillOpacity ¶

func (_dabe *Ellipse) SetFillOpacity(opacity float64)

SetFillOpacity sets the fill opacity of the ellipse.

func (*Ellipse) SetFitMode ¶

func (_dgdg *Ellipse) SetFitMode(fitMode FitMode)

SetFitMode sets the fit mode of the ellipse. NOTE: The fit mode is only applied if relative positioning is used.

func (*Ellipse) SetHeight ¶

func (_gdab *Ellipse) SetHeight(height float64)

SetHeight sets the height of the ellipse.

func (*Ellipse) SetMargins ¶

func (_bag *Ellipse) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the ellipse. NOTE: ellipse margins are only applied if relative positioning is used.

func (*Ellipse) SetPositioning ¶

func (_defd *Ellipse) SetPositioning(position Positioning)

SetPositioning sets the positioning of the ellipse (absolute or relative).

func (*Ellipse) SetWidth ¶

func (_dcce *Ellipse) SetWidth(width float64)

SetWidth sets the width of the ellipse.

func (*Ellipse) Width ¶

func (_cbbd *Ellipse) Width() float64

Width returns the width of the ellipse.

func (*FilledCurve) AppendCurve ¶

func (_egdc *FilledCurve) AppendCurve(curve _bg.CubicBezierCurve) *FilledCurve

AppendCurve appends a Bezier curve to the filled curve.

func (*FilledCurve) GeneratePageBlocks ¶

func (_eddf *FilledCurve) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the filled curve on page blocks.

func (*FilledCurve) SetBorderColor ¶

func (_dfec *FilledCurve) SetBorderColor(color Color)

SetBorderColor sets the border color for the path.

func (*FilledCurve) SetFillColor ¶

func (_fae *FilledCurve) SetFillColor(color Color)

SetFillColor sets the fill color for the path.

func (*GraphicSVG) GeneratePageBlocks ¶

func (_eedbb *GraphicSVG) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draw graphic svg into block.

func (*GraphicSVG) GetMargins ¶

func (_ggdb *GraphicSVG) GetMargins() (float64, float64, float64, float64)

GetMargins returns the margins of the graphic svg (left, right, top, bottom).

func (*GraphicSVG) Height ¶

func (_bfcb *GraphicSVG) Height() float64

Height returns the height of the graphic svg.

func (*GraphicSVG) Scale ¶

func (_fdbg *GraphicSVG) Scale(xFactor, yFactor float64)

Scale sets the scale ratio with `X` factor and `Y` factor for the graphic svg.

func (*GraphicSVG) ScaleToHeight ¶

func (_cfec *GraphicSVG) ScaleToHeight(h float64)

ScaleToHeight sets the graphic svg scaling factor with the given height.

func (*GraphicSVG) ScaleToWidth ¶

func (_gaff *GraphicSVG) ScaleToWidth(w float64)

ScaleToWidth sets the graphic svg scaling factor with the given width.

func (*GraphicSVG) SetMargins ¶

func (_ecdea *GraphicSVG) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the graphic svg component.

func (*GraphicSVG) SetPos ¶

func (_bbgcb *GraphicSVG) SetPos(x, y float64)

SetPos sets the position of the graphic svg to the specified coordinates. This method sets the graphic svg to use absolute positioning.

func (*GraphicSVG) Width ¶

func (_ddca *GraphicSVG) Width() float64

Width returns the width of the graphic svg.

func (*Image) ConvertToBinary ¶

func (_eeae *Image) ConvertToBinary() error

ConvertToBinary converts current image data into binary (Bi-level image) format. If provided image is RGB or GrayScale the function converts it into binary image using histogram auto threshold method.

func (*Image) FitMode ¶

func (_dagb *Image) FitMode() FitMode

FitMode returns the fit mode of the image.

func (*Image) GeneratePageBlocks ¶

func (_adbga *Image) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generate the Page blocks. Draws the Image on a block, implementing the Drawable interface.

func (*Image) GetHorizontalAlignment ¶

func (_ffa *Image) GetHorizontalAlignment() HorizontalAlignment

GetHorizontalAlignment returns the horizontal alignment of the image.

func (*Image) GetMargins ¶

func (_cdbd *Image) GetMargins() (float64, float64, float64, float64)

GetMargins returns the Image's margins: left, right, top, bottom.

func (*Image) Height ¶

func (_cdac *Image) Height() float64

Height returns Image's document height.

func (*Image) Scale ¶

func (_ada *Image) Scale(xFactor, yFactor float64)

Scale scales Image by a constant factor, both width and height.

func (*Image) ScaleToHeight ¶

func (_fcgc *Image) ScaleToHeight(h float64)

ScaleToHeight scale Image to a specified height h, maintaining the aspect ratio.

func (*Image) ScaleToWidth ¶

func (_ecacf *Image) ScaleToWidth(w float64)

ScaleToWidth scale Image to a specified width w, maintaining the aspect ratio.

func (*Image) SetAngle ¶

func (_dgcea *Image) SetAngle(angle float64)

SetAngle sets Image rotation angle in degrees.

func (*Image) SetEncoder ¶

func (_daee *Image) SetEncoder(encoder _dd.StreamEncoder)

SetEncoder sets the encoding/compression mechanism for the image.

func (*Image) SetFitMode ¶

func (_eede *Image) SetFitMode(fitMode FitMode)

SetFitMode sets the fit mode of the image. NOTE: The fit mode is only applied if relative positioning is used.

func (*Image) SetHeight ¶

func (_gdfa *Image) SetHeight(h float64)

SetHeight sets the Image's document height to specified h.

func (*Image) SetHorizontalAlignment ¶

func (_baff *Image) SetHorizontalAlignment(alignment HorizontalAlignment)

SetHorizontalAlignment sets the horizontal alignment of the image.

func (*Image) SetMargins ¶

func (_bcbd *Image) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins for the Image (in relative mode): left, right, top, bottom.

func (*Image) SetOpacity ¶

func (_fefe *Image) SetOpacity(opacity float64)

SetOpacity sets opacity for Image.

func (*Image) SetPos ¶

func (_gaac *Image) SetPos(x, y float64)

SetPos sets the absolute position. Changes object positioning to absolute.

func (*Image) SetWidth ¶

func (_beec *Image) SetWidth(w float64)

SetWidth set the Image's document width to specified w. This does not change the raw image data, i.e. no actual scaling of data is performed. That is handled by the PDF viewer.

func (*Image) Width ¶

func (_ffeb *Image) Width() float64

Width returns Image's document width.

func (*Invoice) AddInfo ¶

func (_gefe *Invoice) AddInfo(description, value string) (*InvoiceCell, *InvoiceCell)

AddInfo is used to append a piece of invoice information in the template information table.

func (*Invoice) AddLine ¶

func (_dcef *Invoice) AddLine(values ...string) []*InvoiceCell

AddLine appends a new line to the invoice line items table.

func (*Invoice) AddSection ¶

func (_fdbb *Invoice) AddSection(title, content string)

AddSection adds a new content section at the end of the invoice.

func (*Invoice) AddTotalLine ¶

func (_afcc *Invoice) AddTotalLine(desc, value string) (*InvoiceCell, *InvoiceCell)

AddTotalLine adds a new line in the invoice totals table.

func (*Invoice) AddressHeadingStyle ¶

func (_geeb *Invoice) AddressHeadingStyle() TextStyle

AddressHeadingStyle returns the style properties used to render the heading of the invoice address sections.

func (*Invoice) AddressStyle ¶

func (_ddcc *Invoice) AddressStyle() TextStyle

AddressStyle returns the style properties used to render the content of the invoice address sections.

func (*Invoice) AppendColumn ¶

func (_gecbf *Invoice) AppendColumn(description string) *InvoiceCell

AppendColumn appends a column to the line items table.

func (*Invoice) BuyerAddress ¶

func (_ebad *Invoice) BuyerAddress() *InvoiceAddress

BuyerAddress returns the buyer address used in the invoice template.

func (*Invoice) Columns ¶

func (_bebgb *Invoice) Columns() []*InvoiceCell

Columns returns all the columns in the invoice line items table.

func (*Invoice) Date ¶

func (_abgc *Invoice) Date() (*InvoiceCell, *InvoiceCell)

Date returns the invoice date description and value cells. The returned values can be used to customize the styles of the cells.

func (*Invoice) DueDate ¶

func (_bace *Invoice) DueDate() (*InvoiceCell, *InvoiceCell)

DueDate returns the invoice due date description and value cells. The returned values can be used to customize the styles of the cells.

func (*Invoice) GeneratePageBlocks ¶

func (_dfgdf *Invoice) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generate the Page blocks. Multiple blocks are generated if the contents wrap over multiple pages.

func (*Invoice) InfoLines ¶

func (_adea *Invoice) InfoLines() [][2]*InvoiceCell

InfoLines returns all the rows in the invoice information table as description-value cell pairs.

func (*Invoice) InsertColumn ¶

func (_agdd *Invoice) InsertColumn(index uint, description string) *InvoiceCell

InsertColumn inserts a column in the line items table at the specified index.

func (*Invoice) Lines ¶

func (_cbag *Invoice) Lines() [][]*InvoiceCell

Lines returns all the rows of the invoice line items table.

func (*Invoice) Logo ¶

func (_ggcd *Invoice) Logo() *Image

Logo returns the logo of the invoice.

func (*Invoice) NewCell ¶

func (_adccb *Invoice) NewCell(value string) *InvoiceCell

NewCell returns a new invoice table cell.

func (*Invoice) NewCellProps ¶

func (_faacb *Invoice) NewCellProps() InvoiceCellProps

NewCellProps returns the default properties of an invoice cell.

func (*Invoice) NewColumn ¶

func (_fed *Invoice) NewColumn(description string) *InvoiceCell

NewColumn returns a new column for the line items invoice table.

func (*Invoice) NoteHeadingStyle ¶

func (_cefg *Invoice) NoteHeadingStyle() TextStyle

NoteHeadingStyle returns the style properties used to render the heading of the invoice note sections.

func (*Invoice) NoteStyle ¶

func (_efcg *Invoice) NoteStyle() TextStyle

NoteStyle returns the style properties used to render the content of the invoice note sections.

func (*Invoice) Notes ¶

func (_dfgg *Invoice) Notes() (string, string)

Notes returns the notes section of the invoice as a title-content pair.

func (*Invoice) Number ¶

func (_efcc *Invoice) Number() (*InvoiceCell, *InvoiceCell)

Number returns the invoice number description and value cells. The returned values can be used to customize the styles of the cells.

func (*Invoice) Sections ¶

func (_bcad *Invoice) Sections() [][2]string

Sections returns the custom content sections of the invoice as title-content pairs.

func (*Invoice) SellerAddress ¶

func (_cfdc *Invoice) SellerAddress() *InvoiceAddress

SellerAddress returns the seller address used in the invoice template.

func (*Invoice) SetAddressHeadingStyle ¶

func (_gfcde *Invoice) SetAddressHeadingStyle(style TextStyle)

SetAddressHeadingStyle sets the style properties used to render the heading of the invoice address sections.

func (*Invoice) SetAddressStyle ¶

func (_beab *Invoice) SetAddressStyle(style TextStyle)

SetAddressStyle sets the style properties used to render the content of the invoice address sections.

func (*Invoice) SetBuyerAddress ¶

func (_bfddf *Invoice) SetBuyerAddress(address *InvoiceAddress)

SetBuyerAddress sets the buyer address of the invoice.

func (*Invoice) SetColumns ¶

func (_gacde *Invoice) SetColumns(cols []*InvoiceCell)

SetColumns overwrites any columns in the line items table. This should be called before AddLine.

func (*Invoice) SetDate ¶

func (_fdce *Invoice) SetDate(date string) (*InvoiceCell, *InvoiceCell)

SetDate sets the date of the invoice.

func (*Invoice) SetDueDate ¶

func (_cbfg *Invoice) SetDueDate(dueDate string) (*InvoiceCell, *InvoiceCell)

SetDueDate sets the due date of the invoice.

func (*Invoice) SetLogo ¶

func (_afcea *Invoice) SetLogo(logo *Image)

SetLogo sets the logo of the invoice.

func (*Invoice) SetNoteHeadingStyle ¶

func (_ffcg *Invoice) SetNoteHeadingStyle(style TextStyle)

SetNoteHeadingStyle sets the style properties used to render the heading of the invoice note sections.

func (*Invoice) SetNoteStyle ¶

func (_begc *Invoice) SetNoteStyle(style TextStyle)

SetNoteStyle sets the style properties used to render the content of the invoice note sections.

func (*Invoice) SetNotes ¶

func (_eeba *Invoice) SetNotes(title, content string)

SetNotes sets the notes section of the invoice.

func (*Invoice) SetNumber ¶

func (_bcdbf *Invoice) SetNumber(number string) (*InvoiceCell, *InvoiceCell)

SetNumber sets the number of the invoice.

func (*Invoice) SetSellerAddress ¶

func (_beedcc *Invoice) SetSellerAddress(address *InvoiceAddress)

SetSellerAddress sets the seller address of the invoice.

func (*Invoice) SetSubtotal ¶

func (_aefa *Invoice) SetSubtotal(value string)

SetSubtotal sets the subtotal of the invoice.

func (*Invoice) SetTerms ¶

func (_edaa *Invoice) SetTerms(title, content string)

SetTerms sets the terms and conditions section of the invoice.

func (*Invoice) SetTitle ¶

func (_eeadd *Invoice) SetTitle(title string)

SetTitle sets the title of the invoice.

func (*Invoice) SetTitleStyle ¶

func (_fdaf *Invoice) SetTitleStyle(style TextStyle)

SetTitleStyle sets the style properties of the invoice title.

func (*Invoice) SetTotal ¶

func (_ddcbf *Invoice) SetTotal(value string)

SetTotal sets the total of the invoice.

func (*Invoice) Subtotal ¶

func (_fgce *Invoice) Subtotal() (*InvoiceCell, *InvoiceCell)

Subtotal returns the invoice subtotal description and value cells. The returned values can be used to customize the styles of the cells.

func (*Invoice) Terms ¶

func (_ecge *Invoice) Terms() (string, string)

Terms returns the terms and conditions section of the invoice as a title-content pair.

func (*Invoice) Title ¶

func (_gbfa *Invoice) Title() string

Title returns the title of the invoice.

func (*Invoice) TitleStyle ¶

func (_eeca *Invoice) TitleStyle() TextStyle

TitleStyle returns the style properties used to render the invoice title.

func (*Invoice) Total ¶

func (_afae *Invoice) Total() (*InvoiceCell, *InvoiceCell)

Total returns the invoice total description and value cells. The returned values can be used to customize the styles of the cells.

func (*Invoice) TotalLines ¶

func (_bedg *Invoice) TotalLines() [][2]*InvoiceCell

TotalLines returns all the rows in the invoice totals table as description-value cell pairs.

func (*Line) Color ¶

func (_cdae *Line) Color() Color

Color returns the color of the line.

func (*Line) DashPattern ¶

func (_ccfe *Line) DashPattern() (_cgga []int64, _fbca int64)

DashPattern returns the dash pattern of the line.

func (*Line) FitMode ¶

func (_ffaa *Line) FitMode() FitMode

FitMode returns the fit mode of the line.

func (*Line) GeneratePageBlocks ¶

func (_adfbb *Line) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the line on a new block representing the page. Implements the Drawable interface.

func (*Line) GetCoords ¶

func (_eaegg *Line) GetCoords() (float64, float64, float64, float64)

GetCoords returns the (x1, y1), (x2, y2) points defining the Line.

func (*Line) GetMargins ¶

func (_fcegg *Line) GetMargins() (float64, float64, float64, float64)

GetMargins returns the margins of the line: left, right, top, bottom.

func (*Line) Height ¶

func (_adbd *Line) Height() float64

Height returns the height of the line.

func (*Line) Length ¶

func (_ecfg *Line) Length() float64

Length calculates and returns the length of the line.

func (*Line) LineWidth ¶

func (_deec *Line) LineWidth() float64

LineWidth returns the width of the line.

func (*Line) Opacity ¶

func (_dfeg *Line) Opacity() float64

Opacity returns the opacity of the line.

func (*Line) Positioning ¶

func (_fddb *Line) Positioning() Positioning

Positioning returns the type of positioning the line is set to use.

func (*Line) SetColor ¶

func (_dbcg *Line) SetColor(color Color)

SetColor sets the line color. Use ColorRGBFromHex, ColorRGBFrom8bit or ColorRGBFromArithmetic to create the color object.

func (*Line) SetDashPattern ¶

func (_acag *Line) SetDashPattern(dashArray []int64, dashPhase int64)

SetDashPattern sets the dash pattern of the line. NOTE: the dash pattern is taken into account only if the style of the line is set to dashed.

func (*Line) SetFitMode ¶

func (_ceff *Line) SetFitMode(fitMode FitMode)

SetFitMode sets the fit mode of the line. NOTE: The fit mode is only applied if relative positioning is used.

func (*Line) SetLineWidth ¶

func (_aedga *Line) SetLineWidth(width float64)

SetLineWidth sets the line width.

func (*Line) SetMargins ¶

func (_dbdef *Line) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the line. NOTE: line margins are only applied if relative positioning is used.

func (*Line) SetOpacity ¶

func (_eacg *Line) SetOpacity(opacity float64)

SetOpacity sets the opacity of the line (0-1).

func (*Line) SetPositioning ¶

func (_bccg *Line) SetPositioning(positioning Positioning)

SetPositioning sets the positioning of the line (absolute or relative).

func (*Line) SetStyle ¶

func (_gdad *Line) SetStyle(style _bg.LineStyle)

SetStyle sets the style of the line (solid or dashed).

func (*Line) Style ¶

func (_dabf *Line) Style() _bg.LineStyle

Style returns the style of the line.

func (*Line) Width ¶

func (_dfea *Line) Width() float64

Width returns the width of the line. NOTE: Depending on the fit mode the line is set to use, its width may be calculated at runtime (e.g. when using FitModeFillWidth).

func (*LinearShading) AddColorStop ¶

func (_dggd *LinearShading) AddColorStop(color Color, point float64)

AddColorStop add color stop info for rendering gradient color.

func (*LinearShading) AddPatternResource ¶

func (_addb *LinearShading) AddPatternResource(block *Block) (_cfcce _dd.PdfObjectName, _adae error)

AddPatternResource adds pattern dictionary inside the resources dictionary.

func (*LinearShading) AddShadingResource ¶

func (_fdbbf *LinearShading) AddShadingResource(block *Block) (_dgfef _dd.PdfObjectName, _dged error)

AddShadingResource adds shading dictionary inside the resources dictionary.

func (*LinearShading) SetAngle ¶

func (_dacg *LinearShading) SetAngle(angle float64)

SetAngle would set the angle at which the gradient is rendered.

The default angle would be 0 where the gradient would be rendered from left to right side.

func (*LinearShading) SetAntiAlias ¶

func (_acacc *LinearShading) SetAntiAlias(enable bool)

SetAntiAlias enables anti alias config.

Anti alias is disabled by default.

func (*LinearShading) SetBackgroundColor ¶

func (_eddfc *LinearShading) SetBackgroundColor(backgroundColor Color)

SetBackgroundColor set background color of the shading area.

By default the background color is set to white.

func (*LinearShading) SetBoundingBox ¶

func (_dede *LinearShading) SetBoundingBox(x, y, width, height float64)

SetBoundingBox set gradient color bounding box where the gradient would be rendered.

func (*LinearShading) SetExtends ¶

func (_gcab *LinearShading) SetExtends(start bool, end bool)

SetExtends specifies whether ot extend the shading beyond the starting and ending points.

Text extends is set to `[]bool{false, false}` by default.

func (*LinearShading) ToPdfShadingPattern ¶

func (_bcfe *LinearShading) ToPdfShadingPattern() *_fee.PdfShadingPatternType2

ToPdfShadingPattern generates a new model.PdfShadingPatternType2 object.

func (*LinearShading) ToRGB ¶

func (_gbaa *LinearShading) ToRGB() (float64, float64, float64)

ToRGB implements interface Color. Note: It's not directly used since shading color works differently than regular color.

func (*List) Add ¶

func (_abca *List) Add(item VectorDrawable) (*TextChunk, error)

Add appends a new item to the list. The supported components are: *Paragraph, *StyledParagraph, *Division, *Image, *Table, and *List. Returns the marker used for the newly added item. The returned marker object can be used to change the text and style of the marker for the current item.

func (*List) AddTextItem ¶

func (_acagc *List) AddTextItem(text string) (*StyledParagraph, *TextChunk, error)

AddTextItem appends a new item with the specified text to the list. The method creates a styled paragraph with the specified text and returns it so that the item style can be customized. The method also returns the marker used for the newly added item. The marker object can be used to change the text and style of the marker for the current item.

func (*List) GeneratePageBlocks ¶

func (_aaed *List) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generate the Page blocks. Multiple blocks are generated if the contents wrap over multiple pages.

func (*List) Height ¶

func (_cfba *List) Height() float64

Height returns the height of the list.

func (*List) Indent ¶

func (_aefe *List) Indent() float64

Indent returns the left offset of the list when nested into another list.

func (*List) Margins ¶

func (_gbafa *List) Margins() (float64, float64, float64, float64)

Margins returns the margins of the list: left, right, top, bottom.

func (*List) Marker ¶

func (_eace *List) Marker() *TextChunk

Marker returns the marker used for the list items. The marker instance can be used the change the text and the style of newly added list items.

func (*List) SetIndent ¶

func (_adfbc *List) SetIndent(indent float64)

SetIndent sets the left offset of the list when nested into another list.

func (*List) SetMargins ¶

func (_bfgd *List) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the paragraph.

func (*List) Width ¶

func (_gfaff *List) Width() float64

Width is not used. The list component is designed to fill into the available width depending on the context. Returns 0.

func (*Margins) Horizontal ¶

func (_ace *Margins) Horizontal() float64

Horizontal returns total horizontal (left + right) margin.

func (*Margins) Vertical ¶

func (_aada *Margins) Vertical() float64

Vertical returns total vertical (top + bottom) margin.

func (*PageBreak) GeneratePageBlocks ¶

func (_gaccf *PageBreak) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generates a page break block.

func (*Paragraph) GeneratePageBlocks ¶

func (_adfd *Paragraph) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generates the page blocks. Multiple blocks are generated if the contents wrap over multiple pages. Implements the Drawable interface.

func (*Paragraph) GetMargins ¶

func (_efdd *Paragraph) GetMargins() (float64, float64, float64, float64)

GetMargins returns the Paragraph's margins: left, right, top, bottom.

func (*Paragraph) Height ¶

func (_eebc *Paragraph) Height() float64

Height returns the height of the Paragraph. The height is calculated based on the input text and how it is wrapped within the container. Does not include Margins.

func (*Paragraph) SetAngle ¶

func (_dgfe *Paragraph) SetAngle(angle float64)

SetAngle sets the rotation angle of the text.

func (*Paragraph) SetColor ¶

func (_dbec *Paragraph) SetColor(col Color)

SetColor sets the color of the Paragraph text.

Example:

1. p := NewParagraph("Red paragraph") // Set to red color with a hex code: p.SetColor(creator.ColorRGBFromHex("#ff0000"))

2. Make Paragraph green with 8-bit rgb values (0-255 each component) p.SetColor(creator.ColorRGBFrom8bit(0, 255, 0)

3. Make Paragraph blue with arithmetic (0-1) rgb components. p.SetColor(creator.ColorRGBFromArithmetic(0, 0, 1.0)

func (*Paragraph) SetEnableWrap ¶

func (_ebff *Paragraph) SetEnableWrap(enableWrap bool)

SetEnableWrap sets the line wrapping enabled flag.

func (*Paragraph) SetFont ¶

func (_bdebg *Paragraph) SetFont(font *_fee.PdfFont)

SetFont sets the Paragraph's font.

func (*Paragraph) SetFontSize ¶

func (_bccgg *Paragraph) SetFontSize(fontSize float64)

SetFontSize sets the font size in document units (points).

func (*Paragraph) SetLineHeight ¶

func (_cegca *Paragraph) SetLineHeight(lineheight float64)

SetLineHeight sets the line height (1.0 default).

func (*Paragraph) SetMargins ¶

func (_cabf *Paragraph) SetMargins(left, right, top, bottom float64)

SetMargins sets the Paragraph's margins.

func (*Paragraph) SetMaxLines ¶

func (_bcabb *Paragraph) SetMaxLines(maxLines int)

SetMaxLines sets the maximum number of lines before the paragraph text is truncated.

func (*Paragraph) SetPos ¶

func (_egaga *Paragraph) SetPos(x, y float64)

SetPos sets absolute positioning with specified coordinates.

func (*Paragraph) SetText ¶

func (_baga *Paragraph) SetText(text string)

SetText sets the text content of the Paragraph.

func (*Paragraph) SetTextAlignment ¶

func (_aacb *Paragraph) SetTextAlignment(align TextAlignment)

SetTextAlignment sets the horizontal alignment of the text within the space provided.

func (*Paragraph) SetWidth ¶

func (_gcfe *Paragraph) SetWidth(width float64)

SetWidth sets the the Paragraph width. This is essentially the wrapping width, i.e. the width the text can extend to prior to wrapping over to next line.

func (*Paragraph) Text ¶

func (_cbcd *Paragraph) Text() string

Text sets the text content of the Paragraph.

func (*Paragraph) Width ¶

func (_dabb *Paragraph) Width() float64

Width returns the width of the Paragraph.

func (*PolyBezierCurve) GeneratePageBlocks ¶

func (_fdddb *PolyBezierCurve) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the composite Bezier curve on a new block representing the page. Implements the Drawable interface.

func (*PolyBezierCurve) SetBorderColor ¶

func (_cbaa *PolyBezierCurve) SetBorderColor(color Color)

SetBorderColor sets the border color.

func (*PolyBezierCurve) SetBorderOpacity ¶

func (_cddf *PolyBezierCurve) SetBorderOpacity(opacity float64)

SetBorderOpacity sets the border opacity.

func (*PolyBezierCurve) SetBorderWidth ¶

func (_cbfb *PolyBezierCurve) SetBorderWidth(borderWidth float64)

SetBorderWidth sets the border width.

func (*PolyBezierCurve) SetFillColor ¶

func (_gggg *PolyBezierCurve) SetFillColor(color Color)

SetFillColor sets the fill color.

func (*PolyBezierCurve) SetFillOpacity ¶

func (_cecgf *PolyBezierCurve) SetFillOpacity(opacity float64)

SetFillOpacity sets the fill opacity.

func (*Polygon) GeneratePageBlocks ¶

func (_agbge *Polygon) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the polygon on a new block representing the page. Implements the Drawable interface.

func (*Polygon) SetBorderColor ¶

func (_aebg *Polygon) SetBorderColor(color Color)

SetBorderColor sets the border color.

func (*Polygon) SetBorderOpacity ¶

func (_cbff *Polygon) SetBorderOpacity(opacity float64)

SetBorderOpacity sets the border opacity.

func (*Polygon) SetBorderWidth ¶

func (_dcfcg *Polygon) SetBorderWidth(borderWidth float64)

SetBorderWidth sets the border width.

func (*Polygon) SetFillColor ¶

func (_ffce *Polygon) SetFillColor(color Color)

SetFillColor sets the fill color.

func (*Polygon) SetFillOpacity ¶

func (_afcca *Polygon) SetFillOpacity(opacity float64)

SetFillOpacity sets the fill opacity.

func (*Polyline) GeneratePageBlocks ¶

func (_edfb *Polyline) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the polyline on a new block representing the page. Implements the Drawable interface.

func (*Polyline) SetLineColor ¶

func (_cafa *Polyline) SetLineColor(color Color)

SetLineColor sets the line color.

func (*Polyline) SetLineOpacity ¶

func (_aacd *Polyline) SetLineOpacity(opacity float64)

SetLineOpacity sets the line opacity.

func (*Polyline) SetLineWidth ¶

func (_acbc *Polyline) SetLineWidth(lineWidth float64)

SetLineWidth sets the line width.

func (Positioning) IsAbsolute ¶

func (_edef Positioning) IsAbsolute() bool

IsAbsolute checks if the positioning is absolute.

func (Positioning) IsRelative ¶

func (_aaf Positioning) IsRelative() bool

IsRelative checks if the positioning is relative.

func (*RadialShading) AddColorStop ¶

func (_dbfg *RadialShading) AddColorStop(color Color, point float64)

AddColorStop add color stop info for rendering gradient color.

func (*RadialShading) AddPatternResource ¶

func (_ddcgd *RadialShading) AddPatternResource(block *Block) (_gagb _dd.PdfObjectName, _aeeg error)

AddPatternResource adds pattern dictionary inside the resources dictionary.

func (*RadialShading) AddShadingResource ¶

func (_gfba *RadialShading) AddShadingResource(block *Block) (_aafdb _dd.PdfObjectName, _fabg error)

AddShadingResource adds shading dictionary inside the resources dictionary.

func (*RadialShading) SetAnchor ¶

func (_cadd *RadialShading) SetAnchor(anchor AnchorPoint)

SetAnchor set gradient position anchor. Default to center.

func (*RadialShading) SetAntiAlias ¶

func (_dbdd *RadialShading) SetAntiAlias(enable bool)

SetAntiAlias enables anti alias config.

Anti alias is disabled by default.

func (*RadialShading) SetBackgroundColor ¶

func (_bgaad *RadialShading) SetBackgroundColor(backgroundColor Color)

SetBackgroundColor set background color of the shading area.

By default the background color is set to white.

func (*RadialShading) SetBoundingBox ¶

func (_bada *RadialShading) SetBoundingBox(x, y, width, height float64)

SetBoundingBox set gradient color bounding box where the gradient would be rendered.

func (*RadialShading) SetExtends ¶

func (_becb *RadialShading) SetExtends(start bool, end bool)

SetExtends specifies whether ot extend the shading beyond the starting and ending points.

Text extends is set to `[]bool{false, false}` by default.

func (*RadialShading) ToPdfShadingPattern ¶

func (_gada *RadialShading) ToPdfShadingPattern() *_fee.PdfShadingPatternType3

ToPdfShadingPattern generates a new model.PdfShadingPatternType3 object.

func (*RadialShading) ToRGB ¶

func (_fdda *RadialShading) ToRGB() (float64, float64, float64)

ToRGB implements interface Color. Note: It's not directly used since shading color works differently than regular color.

func (*Rectangle) BorderColor ¶

func (_gcgff *Rectangle) BorderColor() Color

BorderColor returns the border color of the rectangle.

func (*Rectangle) BorderOpacity ¶

func (_ecgebf *Rectangle) BorderOpacity() float64

BorderOpacity returns the border opacity of the rectangle (0-1).

func (*Rectangle) BorderWidth ¶

func (_bddf *Rectangle) BorderWidth() float64

BorderWidth returns the border width of the rectangle.

func (*Rectangle) FillColor ¶

func (_cdbc *Rectangle) FillColor() Color

FillColor returns the fill color of the rectangle.

func (*Rectangle) FillOpacity ¶

func (_adfaf *Rectangle) FillOpacity() float64

FillOpacity returns the fill opacity of the rectangle (0-1).

func (*Rectangle) FitMode ¶

func (_dgeb *Rectangle) FitMode() FitMode

FitMode returns the fit mode of the rectangle.

func (*Rectangle) GeneratePageBlocks ¶

func (_aebf *Rectangle) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks draws the rectangle on a new block representing the page. Implements the Drawable interface.

func (*Rectangle) GetCoords ¶

func (_caaa *Rectangle) GetCoords() (float64, float64)

GetCoords returns the upper left corner coordinates of the rectangle (`x`, `y`).

func (*Rectangle) GetMargins ¶

func (_edaf *Rectangle) GetMargins() (float64, float64, float64, float64)

GetMargins returns the margins of the rectangle: left, right, top, bottom.

func (*Rectangle) Height ¶

func (_aeed *Rectangle) Height() float64

Height returns the height of the rectangle. NOTE: the returned value does not include the border width of the rectangle.

func (*Rectangle) Positioning ¶

func (_dcbf *Rectangle) Positioning() Positioning

Positioning returns the type of positioning the rectangle is set to use.

func (*Rectangle) Scale ¶

func (_aafd *Rectangle) Scale(xFactor, yFactor float64)

Scale scales the rectangle dimensions by the specified factors.

func (*Rectangle) ScaleToHeight ¶

func (_fccf *Rectangle) ScaleToHeight(h float64)

ScaleToHeight scales the rectangle to the specified height. The width of the rectangle is scaled so that the aspect ratio is maintained.

func (*Rectangle) ScaleToWidth ¶

func (_bdca *Rectangle) ScaleToWidth(w float64)

ScaleToWidth scales the rectangle to the specified width. The height of the rectangle is scaled so that the aspect ratio is maintained.

func (*Rectangle) SetBorderColor ¶

func (_fcca *Rectangle) SetBorderColor(col Color)

SetBorderColor sets border color of the rectangle.

func (*Rectangle) SetBorderOpacity ¶

func (_fecb *Rectangle) SetBorderOpacity(opacity float64)

SetBorderOpacity sets the border opacity of the rectangle.

func (*Rectangle) SetBorderRadius ¶

func (_dfed *Rectangle) SetBorderRadius(topLeft, topRight, bottomLeft, bottomRight float64)

SetBorderRadius sets the radius of the rectangle corners.

func (*Rectangle) SetBorderWidth ¶

func (_decc *Rectangle) SetBorderWidth(bw float64)

SetBorderWidth sets the border width of the rectangle.

func (*Rectangle) SetCoords ¶

func (_agbgb *Rectangle) SetCoords(x, y float64)

SetCoords sets the upper left corner coordinates of the rectangle.

func (*Rectangle) SetFillColor ¶

func (_adee *Rectangle) SetFillColor(col Color)

SetFillColor sets the fill color of the rectangle.

func (*Rectangle) SetFillOpacity ¶

func (_gbef *Rectangle) SetFillOpacity(opacity float64)

SetFillOpacity sets the fill opacity of the rectangle.

func (*Rectangle) SetFitMode ¶

func (_dbfe *Rectangle) SetFitMode(fitMode FitMode)

SetFitMode sets the fit mode of the rectangle. NOTE: The fit mode is only applied if relative positioning is used.

func (*Rectangle) SetHeight ¶

func (_afec *Rectangle) SetHeight(height float64)

SetHeight sets the height of the rectangle.

func (*Rectangle) SetMargins ¶

func (_gdag *Rectangle) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins of the rectangle. NOTE: rectangle margins are only applied if relative positioning is used.

func (*Rectangle) SetPositioning ¶

func (_egee *Rectangle) SetPositioning(position Positioning)

SetPositioning sets the positioning of the rectangle (absolute or relative).

func (*Rectangle) SetWidth ¶

func (_debba *Rectangle) SetWidth(width float64)

SetWidth sets the width of the rectangle.

func (*Rectangle) Width ¶

func (_gfeea *Rectangle) Width() float64

Width returns the width of the rectangle. NOTE: the returned value does not include the border width of the rectangle.

func (*StyledParagraph) AddExternalLink ¶

func (_cfbad *StyledParagraph) AddExternalLink(text, url string) *TextChunk

AddExternalLink adds a new external link to the paragraph. The text parameter represents the text that is displayed and the url parameter sets the destionation of the link.

func (*StyledParagraph) AddInternalLink ¶

func (_eccd *StyledParagraph) AddInternalLink(text string, page int64, x, y, zoom float64) *TextChunk

AddInternalLink adds a new internal link to the paragraph. The text parameter represents the text that is displayed. The user is taken to the specified page, at the specified x and y coordinates. Position 0, 0 is at the top left of the page. The zoom of the destination page is controlled with the zoom parameter. Pass in 0 to keep the current zoom value.

func (*StyledParagraph) Append ¶

func (_gbgdf *StyledParagraph) Append(text string) *TextChunk

Append adds a new text chunk to the paragraph.

func (*StyledParagraph) EnableWordWrap ¶

func (_bfdda *StyledParagraph) EnableWordWrap(val bool)

EnableWordWrap sets the paragraph word wrap flag.

func (*StyledParagraph) GeneratePageBlocks ¶

func (_bcgde *StyledParagraph) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generates the page blocks. Multiple blocks are generated if the contents wrap over multiple pages. Implements the Drawable interface.

func (*StyledParagraph) GetMargins ¶

func (_fbbe *StyledParagraph) GetMargins() (float64, float64, float64, float64)

GetMargins returns the Paragraph's margins: left, right, top, bottom.

func (*StyledParagraph) Height ¶

func (_fdcd *StyledParagraph) Height() float64

Height returns the height of the Paragraph. The height is calculated based on the input text and how it is wrapped within the container. Does not include Margins.

func (*StyledParagraph) Insert ¶

func (_ffbf *StyledParagraph) Insert(index uint, text string) *TextChunk

Insert adds a new text chunk at the specified position in the paragraph.

func (*StyledParagraph) Reset ¶

func (_geegb *StyledParagraph) Reset()

Reset removes all the text chunks the paragraph contains.

func (*StyledParagraph) SetAngle ¶

func (_ceaa *StyledParagraph) SetAngle(angle float64)

SetAngle sets the rotation angle of the text.

func (*StyledParagraph) SetEnableWrap ¶

func (_eagc *StyledParagraph) SetEnableWrap(enableWrap bool)

SetEnableWrap sets the line wrapping enabled flag.

func (*StyledParagraph) SetLineHeight ¶

func (_deead *StyledParagraph) SetLineHeight(lineheight float64)

SetLineHeight sets the line height (1.0 default).

func (*StyledParagraph) SetMargins ¶

func (_acggb *StyledParagraph) SetMargins(left, right, top, bottom float64)

SetMargins sets the Paragraph's margins.

func (*StyledParagraph) SetPos ¶

func (_dcfeg *StyledParagraph) SetPos(x, y float64)

SetPos sets absolute positioning with specified coordinates.

func (*StyledParagraph) SetText ¶

func (_dacgf *StyledParagraph) SetText(text string) *TextChunk

SetText replaces all the text of the paragraph with the specified one.

func (*StyledParagraph) SetTextAlignment ¶

func (_afdab *StyledParagraph) SetTextAlignment(align TextAlignment)

SetTextAlignment sets the horizontal alignment of the text within the space provided.

func (*StyledParagraph) SetTextOverflow ¶

func (_gacaf *StyledParagraph) SetTextOverflow(textOverflow TextOverflow)

SetTextOverflow controls the behavior of paragraph text which does not fit in the available space.

func (*StyledParagraph) SetTextVerticalAlignment ¶

func (_edag *StyledParagraph) SetTextVerticalAlignment(align TextVerticalAlignment)

SetTextVerticalAlignment sets the vertical alignment of the text within the bounds of the styled paragraph.

Note: Currently Styled Paragraph doesn't support TextVerticalAlignmentBottom as that option only used for aligning text chunks.

In order to change the vertical alignment of individual text chunks, use TextChunk.VerticalAlignment.

func (*StyledParagraph) SetWidth ¶

func (_dddfg *StyledParagraph) SetWidth(width float64)

SetWidth sets the the Paragraph width. This is essentially the wrapping width, i.e. the width the text can extend to prior to wrapping over to next line.

func (*StyledParagraph) Width ¶

func (_agga *StyledParagraph) Width() float64

Width returns the width of the Paragraph.

func (*TOC) Add ¶

func (_egagc *TOC) Add(number, title, page string, level uint) *TOCLine

Add adds a new line with the default style to the table of contents.

func (*TOC) AddLine ¶

func (_egbd *TOC) AddLine(line *TOCLine) *TOCLine

AddLine adds a new line with the provided style to the table of contents.

func (*TOC) GeneratePageBlocks ¶

func (_bccge *TOC) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generate the Page blocks. Multiple blocks are generated if the contents wrap over multiple pages.

func (*TOC) Heading ¶

func (_eggfd *TOC) Heading() *StyledParagraph

Heading returns the heading component of the table of contents.

func (*TOC) Lines ¶

func (_fdcde *TOC) Lines() []*TOCLine

Lines returns all the lines the table of contents has.

func (*TOC) SetHeading ¶

func (_bebgf *TOC) SetHeading(text string, style TextStyle)

SetHeading sets the text and the style of the heading of the TOC component.

func (*TOC) SetLineLevelOffset ¶

func (_gaag *TOC) SetLineLevelOffset(levelOffset float64)

SetLineLevelOffset sets the amount of space an indentation level occupies for all new lines of the table of contents.

func (*TOC) SetLineMargins ¶

func (_ddafb *TOC) SetLineMargins(left, right, top, bottom float64)

SetLineMargins sets the margins for all new lines of the table of contents.

func (*TOC) SetLineNumberStyle ¶

func (_dgbfc *TOC) SetLineNumberStyle(style TextStyle)

SetLineNumberStyle sets the style for the numbers part of all new lines of the table of contents.

func (*TOC) SetLinePageStyle ¶

func (_gfcb *TOC) SetLinePageStyle(style TextStyle)

SetLinePageStyle sets the style for the page part of all new lines of the table of contents.

func (*TOC) SetLineSeparator ¶

func (_bageg *TOC) SetLineSeparator(separator string)

SetLineSeparator sets the separator for all new lines of the table of contents.

func (*TOC) SetLineSeparatorStyle ¶

func (_ebfdf *TOC) SetLineSeparatorStyle(style TextStyle)

SetLineSeparatorStyle sets the style for the separator part of all new lines of the table of contents.

func (*TOC) SetLineStyle ¶

func (_beefd *TOC) SetLineStyle(style TextStyle)

SetLineStyle sets the style for all the line components: number, title, separator, page. The style is applied only for new lines added to the TOC component.

func (*TOC) SetLineTitleStyle ¶

func (_ecbcgb *TOC) SetLineTitleStyle(style TextStyle)

SetLineTitleStyle sets the style for the title part of all new lines of the table of contents.

func (*TOC) SetShowLinks ¶

func (_abbbg *TOC) SetShowLinks(showLinks bool)

SetShowLinks sets visibility of links for the TOC lines.

func (*TOCLine) GeneratePageBlocks ¶

func (_bfgbaa *TOCLine) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generate the Page blocks. Multiple blocks are generated if the contents wrap over multiple pages.

func (*TOCLine) GetMargins ¶

func (_aceaa *TOCLine) GetMargins() (float64, float64, float64, float64)

GetMargins returns the margins of the TOC line: left, right, top, bottom.

func (*TOCLine) Level ¶

func (_fdebg *TOCLine) Level() uint

Level returns the indentation level of the TOC line.

func (*TOCLine) LevelOffset ¶

func (_geade *TOCLine) LevelOffset() float64

LevelOffset returns the amount of space an indentation level occupies.

func (*TOCLine) Link ¶

func (_gbgfc *TOCLine) Link() (_cfgcf int64, _ccfec, _fdadd float64)

Link returns link information for this line.

func (*TOCLine) SetLevel ¶

func (_degcg *TOCLine) SetLevel(level uint)

SetLevel sets the indentation level of the TOC line.

func (*TOCLine) SetLevelOffset ¶

func (_acfgd *TOCLine) SetLevelOffset(levelOffset float64)

SetLevelOffset sets the amount of space an indentation level occupies.

func (*TOCLine) SetLink ¶

func (_bcca *TOCLine) SetLink(page int64, x, y float64)

SetLink makes the line an internal link. The text parameter represents the text that is displayed. The user is taken to the specified page, at the specified x and y coordinates. Position 0, 0 is at the top left of the page.

func (*TOCLine) SetMargins ¶

func (_faacbe *TOCLine) SetMargins(left, right, top, bottom float64)

SetMargins sets the margins TOC line.

func (*TOCLine) SetStyle ¶

func (_decgb *TOCLine) SetStyle(style TextStyle)

SetStyle sets the style for all the line components: number, title, separator, page.

func (*Table) AddSubtable ¶

func (_daba *Table) AddSubtable(row, col int, subtable *Table)

AddSubtable copies the cells of the subtable in the table, starting with the specified position. The table row and column indices are 1-based, which makes the position of the first cell of the first row of the table 1,1. The table is automatically extended if the subtable exceeds its columns. This can happen when the subtable has more columns than the table or when one or more columns of the subtable starting from the specified position exceed the last column of the table.

func (*Table) Cols ¶

func (_gade *Table) Cols() int

Cols returns the total number of columns the table has.

func (*Table) CurCol ¶

func (_cdfad *Table) CurCol() int

CurCol returns the currently active cell's column number.

func (*Table) CurRow ¶

func (_bedab *Table) CurRow() int

CurRow returns the currently active cell's row number.

func (*Table) EnablePageWrap ¶

func (_cfcff *Table) EnablePageWrap(enable bool)

EnablePageWrap controls whether the table is wrapped across pages. If disabled, the table is moved in its entirety on a new page, if it does not fit in the available height. By default, page wrapping is enabled. If the height of the table is larger than an entire page, wrapping is enabled automatically in order to avoid unwanted behavior.

func (*Table) EnableRowWrap ¶

func (_agaee *Table) EnableRowWrap(enable bool)

EnableRowWrap controls whether rows are wrapped across pages. NOTE: Currently, row wrapping is supported for rows using StyledParagraphs.

func (*Table) GeneratePageBlocks ¶

func (_edge *Table) GeneratePageBlocks(ctx DrawContext) ([]*Block, DrawContext, error)

GeneratePageBlocks generates the table page blocks. Multiple blocks are generated if the contents wrap over multiple pages. Implements the Drawable interface.

func (*Table) GetMargins ¶

func (_eeegg *Table) GetMargins() (float64, float64, float64, float64)

GetMargins returns the left, right, top, bottom Margins.

func (*Table) GetRowHeight ¶

func (_afee *Table) GetRowHeight(row int) (float64, error)

GetRowHeight returns the height of the specified row.

func (*Table) Height ¶

func (_beecd *Table) Height() float64

Height returns the total height of all rows.

func (*Table) MultiCell ¶

func (_edbd *Table) MultiCell(rowspan, colspan int) *TableCell

MultiCell makes a new cell with the specified row span and col span and inserts it into the table at the current position.

func (*Table) MultiColCell ¶

func (_abgad *Table) MultiColCell(colspan int) *TableCell

MultiColCell makes a new cell with the specified column span and inserts it into the table at the current position.

func (*Table) MultiRowCell ¶

func (_aeccg *Table) MultiRowCell(rowspan int) *TableCell

MultiRowCell makes a new cell with the specified row span and inserts it into the table at the current position.

func (*Table) NewCell ¶

func (_cfbacb *Table) NewCell() *TableCell

NewCell makes a new cell and inserts it into the table at the current position.

func (*Table) Rows ¶

func (_dgeeb *Table) Rows() int

Rows returns the total number of rows the table has.

func (*Table) SetColumnWidths ¶

func (_bgbc *Table) SetColumnWidths(widths ...float64) error

SetColumnWidths sets the fractional column widths. Each width should be in the range 0-1 and is a fraction of the table width. The number of width inputs must match number of columns, otherwise an error is returned.

func (*Table) SetHeaderRows ¶

func (_dbfa *Table) SetHeaderRows(startRow, endRow int) error

SetHeaderRows turns the selected table rows into headers that are repeated for every page the table spans. startRow and endRow are inclusive.

func (*Table) SetMargins ¶

func (_gafg *Table) SetMargins(left, right, top, bottom float64)

SetMargins sets the Table's left, right, top, bottom margins.

func (*Table) SetPos ¶

func (_bfca *Table) SetPos(x, y float64)

SetPos sets the Table's positioning to absolute mode and specifies the upper-left corner coordinates as (x,y). Note that this is only sensible to use when the table does not wrap over multiple pages. TODO: Should be able to set width too (not just based on context/relative positioning mode).

func (*Table) SetRowHeight ¶

func (_ccef *Table) SetRowHeight(row int, h float64) error

SetRowHeight sets the height for a specified row.

func (*Table) SkipCells ¶

func (_ddgd *Table) SkipCells(num int)

SkipCells skips over a specified number of cells in the table.

func (*Table) SkipOver ¶

func (_acfg *Table) SkipOver(rows, cols int)

SkipOver skips over a specified number of rows and cols.

func (*Table) SkipRows ¶

func (_abccg *Table) SkipRows(num int)

SkipRows skips over a specified number of rows in the table.

func (*Table) Width ¶

func (_gagaa *Table) Width() float64

Width is not used. Not used as a Table element is designed to fill into available width depending on the context. Returns 0.

func (*TableCell) GetIndent ¶

func (_dafbd *TableCell) GetIndent() float64

GetIndent get the cell's left indent.

func (*TableCell) SetBackgroundColor ¶

func (_ebaea *TableCell) SetBackgroundColor(col Color)

SetBackgroundColor sets the cell's background color.

func (*TableCell) SetBorder ¶

func (_gabgc *TableCell) SetBorder(side CellBorderSide, style CellBorderStyle, width float64)

SetBorder sets the cell's border style.

func (*TableCell) SetBorderColor ¶

func (_ccbg *TableCell) SetBorderColor(col Color)

SetBorderColor sets the cell's border color.

func (*TableCell) SetBorderLineStyle ¶

func (_aacgbc *TableCell) SetBorderLineStyle(style _bg.LineStyle)

SetBorderLineStyle sets border style (currently dashed or plain).

func (*TableCell) SetContent ¶

func (_dgfb *TableCell) SetContent(vd VectorDrawable) error

SetContent sets the cell's content. The content is a VectorDrawable, i.e. a Drawable with a known height and width. Currently supported VectorDrawables: - *Paragraph - *StyledParagraph - *Image - *Chart - *Table - *Division - *List - *Rectangle - *Ellipse - *Line

func (*TableCell) SetHorizontalAlignment ¶

func (_cbgdf *TableCell) SetHorizontalAlignment(halign CellHorizontalAlignment)

SetHorizontalAlignment sets the cell's horizontal alignment of content. Can be one of: - CellHorizontalAlignmentLeft - CellHorizontalAlignmentCenter - CellHorizontalAlignmentRight

func (*TableCell) SetIndent ¶

func (_ffbe *TableCell) SetIndent(indent float64)

SetIndent sets the cell's left indent.

func (*TableCell) SetSideBorderColor ¶

func (_cfgdc *TableCell) SetSideBorderColor(side CellBorderSide, col Color)

SetSideBorderColor sets the cell's side border color.

func (*TableCell) SetSideBorderStyle ¶

func (_eccba *TableCell) SetSideBorderStyle(side CellBorderSide, style CellBorderStyle)

SetSideBorderStyle sets the cell's side border style.

func (*TableCell) SetSideBorderWidth ¶

func (_dfbdf *TableCell) SetSideBorderWidth(side CellBorderSide, width float64)

SetSideBorderWidth sets the cell's side border width.

func (*TableCell) SetVerticalAlignment ¶

func (_aegfd *TableCell) SetVerticalAlignment(valign CellVerticalAlignment)

SetVerticalAlignment set the cell's vertical alignment of content. Can be one of: - CellHorizontalAlignmentTop - CellHorizontalAlignmentMiddle - CellHorizontalAlignmentBottom

func (*TableCell) Width ¶

func (_fdbdc *TableCell) Width(ctx DrawContext) float64

Width returns the cell's width based on the input draw context.

func (*TextChunk) Fit ¶

func (_edada *TextChunk) Fit(width, height float64) (*TextChunk, error)

Fit fits the chunk into the specified bounding box, cropping off the remainder in a new chunk, if it exceeds the specified dimensions. NOTE: The method assumes a line height of 1.0. In order to account for other line height values, the passed in height must be divided by the line height: height = height / lineHeight

func (*TextChunk) SetAnnotation ¶

func (_bacba *TextChunk) SetAnnotation(annotation *_fee.PdfAnnotation)

SetAnnotation sets a annotation on a TextChunk.

func (*TextChunk) Width ¶

func (_aged *TextChunk) Width() float64

Width returns the width of the specified text chunk.

func (*TextChunk) Wrap ¶

func (_edbac *TextChunk) Wrap(width float64) ([]string, error)

Wrap wraps the text of the chunk into lines based on its style and the specified width.

func (UnsupportedRuneError) Error ¶

func (_fdba UnsupportedRuneError) Error() string

String implements error interface.