Class HomePrint

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	HomePrint(paperOrientation, paperWidth, paperHeight, paperTopMargin, paperLeftMargin, paperBottomMargin, paperRightMargin, furniturePrinted, planPrinted, printedLevels, view3DPrinted, planScale, headerFormat, footerFormat) Create a print attributes for home from the given parameters.

Method Summary
Method Attributes	Method Name and Description
	getFooterFormat() Returns the string format used to print page footers.
	getHeaderFormat() Returns the string format used to print page headers.
	getPaperBottomMargin() Returns the margin at paper bottom in 1/72nds of an inch.
	getPaperHeight() Returns the paper height in 1/72nds of an inch.
	getPaperLeftMargin() Returns the margin at paper left in 1/72nds of an inch.
	getPaperOrientation() Returns the paper orientation.
	getPaperRightMargin() Returns the margin at paper right in 1/72nds of an inch.
	getPaperTopMargin() Returns the margin at paper top in 1/72nds of an inch.
	getPaperWidth() Returns the paper width in 1/72nds of an inch.
	getPlanScale() Returns the scale used to print home plan or `null` if no special scale is desired.
	getPrintedLevels() Returns the printed levels or `null` if all levels should be printed.
	isFurniturePrinted() Returns whether home furniture should be printed or not.
	isPlanPrinted() Returns whether home plan should be printed or not.
	isView3DPrinted() Returns whether home 3D view should be printed or not.

Class Detail

HomePrint(paperOrientation, paperWidth, paperHeight, paperTopMargin, paperLeftMargin, paperBottomMargin, paperRightMargin, furniturePrinted, planPrinted, printedLevels, view3DPrinted, planScale, headerFormat, footerFormat)

Create a print attributes for home from the given parameters.
Author: Emmanuel Puybaret.

Parameters:
{HomePrint.PaperOrientation} paperOrientation
{number} paperWidth
{number} paperHeight
{number} paperTopMargin
{number} paperLeftMargin
{number} paperBottomMargin
{number} paperRightMargin
{boolean} furniturePrinted
{boolean} planPrinted
{Level[]} printedLevels
{boolean} view3DPrinted
{number} planScale
{string} headerFormat
{string} footerFormat

Method Detail

{string} getFooterFormat()

Returns the string format used to print page footers.

Returns:: {string}

{string} getHeaderFormat()

Returns the string format used to print page headers.

Returns:: {string}

{number} getPaperBottomMargin()

Returns the margin at paper bottom in 1/72nds of an inch.

Returns:: {number}

{number} getPaperHeight()

Returns the paper height in 1/72nds of an inch.

Returns:: {number}

{number} getPaperLeftMargin()

Returns the margin at paper left in 1/72nds of an inch.

Returns:: {number}

{HomePrint.PaperOrientation} getPaperOrientation()

Returns the paper orientation.

Returns:: {HomePrint.PaperOrientation}

{number} getPaperRightMargin()

Returns the margin at paper right in 1/72nds of an inch.

Returns:: {number}

{number} getPaperTopMargin()

Returns the margin at paper top in 1/72nds of an inch.

Returns:: {number}

{number} getPaperWidth()

Returns the paper width in 1/72nds of an inch.

Returns:: {number}

{number} getPlanScale()

Returns the scale used to print home plan or null if no special scale is desired.

Returns:: {number}

{Level[]} getPrintedLevels()

Returns the printed levels or null if all levels should be printed.

Returns:: {Level[]}

{boolean} isFurniturePrinted()

Returns whether home furniture should be printed or not.

Returns:: {boolean}

{boolean} isPlanPrinted()

Returns whether home plan should be printed or not.

Returns:: {boolean}

{boolean} isView3DPrinted()

Returns whether home 3D view should be printed or not.

Returns:: {boolean}

	© Copyright 2024 Emmanuel PUYBARET / eTeks Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Thu Apr 04 2024 17:30:26 GMT+0200 (CEST)

Classes

Class HomePrint