# Layout Figures out the CSS values to apply for a layout **Kind**: global class * [Layout](#Layout) * [new Layout([options])](#new_Layout_new) * _instance_ * [.set(options)](#Layout+set) * [.calculate([width], [height], [gap])](#Layout+calculate) * [.count(totalLength, [pageLength])](#Layout+count) ⇒ Object * [.destroy()](#Layout+destroy) * _static_ * [.axis](#Layout.axis) : string * [.name](#Layout.name) : string * [.flow](#Layout.flow) : string * [.spread](#Layout.spread) : boolean * [.direction](#Layout.direction) : string * [.orientation](#Layout.orientation) : string * [.viewport](#Layout.viewport) : string * [.minSpreadWidth](#Layout.minSpreadWidth) : number * [.width](#Layout.width) : number * [.height](#Layout.height) : number * [.pageWidth](#Layout.pageWidth) : number * [.pageHeight](#Layout.pageHeight) : number * [.spreadWidth](#Layout.spreadWidth) : number * [.delta](#Layout.delta) : number * [.columnWidth](#Layout.columnWidth) : number * [.gap](#Layout.gap) : number * [.divisor](#Layout.divisor) : number ## new Layout([options]) Constructor | Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | object | | | | [options.axis] | string | "'horizontal'" | values: `"horizontal"` OR `"vertical"` | | [options.flow] | string | "'paginated'" | values: `"paginated"` OR `"scrolled"` OR `"scrolled-doc"` | | [options.spread] | string | "'auto'" | values: `"auto"` OR `"none"` | | [options.direction] | string | "'ltr'" | values: `"ltr"` OR `"rtl"` | | [options.orientation] | string | "'auto'" | values: `"auto"` OR `"landscape"` OR `"portrait"` | | [options.minSpreadWidth] | number | 800 | | | [options.pageWidth] | number | | page width | | [options.pageHeight] | number | | page height | ## layout.set(options) Set options **Kind**: instance method of [Layout](#Layout) | Param | Type | | --- | --- | | options | object | ## layout.calculate([width], [height], [gap]) Calculate the dimensions of the pagination **Kind**: instance method of [Layout](#Layout) | Param | Type | Description | | --- | --- | --- | | [width] | number | width of the rendering | | [height] | number | height of the rendering | | [gap] | number | width of the gap between columns | ## layout.count(totalLength, [pageLength]) ⇒ Object Count number of pages **Kind**: instance method of [Layout](#Layout) | Param | Type | | --- | --- | | totalLength | number | | [pageLength] | number | ## layout.destroy() destroty **Kind**: instance method of [Layout](#Layout) ## Layout.axis : string **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.name : string Layout name **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.flow : string **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.spread : boolean **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.direction : string **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.orientation : string no implementation **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.viewport : string no implementation **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.minSpreadWidth : number **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.width : number Layout width **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.height : number Layout height **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.pageWidth : number **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.pageHeight : number **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.spreadWidth : number Spread width **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.delta : number **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.columnWidth : number Column width **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.gap : number **Kind**: static property of [Layout](#Layout) **Read only**: true ## Layout.divisor : number **Kind**: static property of [Layout](#Layout) **Read only**: true