Module

DataViz.Layout.Pattern.Types

Package
purescript-hylograph-layout
Repository
afcondon/purescript-hylograph-layout

Types for geometric layout patterns

#Point Source

type Point = { x :: Number, y :: Number }

A 2D point

#Viewport Source

type Viewport = { height :: Number, padding :: Padding, width :: Number }

Viewport specification - the bounding box for layout

#viewport Source

viewport :: Number -> Number -> Viewport

Create a viewport with no padding

#viewportWithPadding Source

viewportWithPadding :: Number -> Number -> Number -> Viewport

Create a viewport with uniform padding

#usableArea Source

usableArea :: Viewport -> { height :: Number, width :: Number, x :: Number, y :: Number }

Get the usable area after accounting for padding Returns { x, y, width, height } where x,y is the top-left of usable area

#Padding Source

type Padding = { bottom :: Number, left :: Number, right :: Number, top :: Number }

Padding specification (can be uniform or per-side)

#uniformPadding Source

uniformPadding :: Number -> Padding

Uniform padding on all sides

#padding Source

padding :: { bottom :: Number, left :: Number, right :: Number, top :: Number } -> Padding

Per-side padding

#noPadding Source

noPadding :: Padding

No padding