Chart.Arrow

Charts that depict gradients and similar data, using arrows in positions

Documentation

data Arrow

An arrow structure contains position, direction and size information

Constructors

Arrow

Fields

• arrowPos :: Pair Double
• arrowDir :: Pair Double

Instances

Eq Arrow

Methods

(==) :: Arrow -> Arrow -> Bool

(/=) :: Arrow -> Arrow -> Bool

Show Arrow

Methods

showsPrec :: Int -> Arrow -> ShowS

show :: Arrow -> String

showList :: [Arrow] -> ShowS

data ArrowHTStyle a

ArrowStyles based on diagrams

Constructors

Tri

Dart

HalfDart

Spike

Thorn

LineHead

NoHead

Tri2 a

Dart2 a

HalfDart2 a

Spike2 a

Thorn2 a

Tri'

Dart'

HalfDart'

Spike'

Thorn'

LineTail

NoTail

Quill

Block

Quill2 a

Block2 a

Instances

Show a => Show (ArrowHTStyle a)

Methods

showsPrec :: Int -> ArrowHTStyle a -> ShowS

show :: ArrowHTStyle a -> String

showList :: [ArrowHTStyle a] -> ShowS

data ArrowOptions

todo: quite a clunky specification of what an arrow is (or could be)

Constructors

ArrowOptions

Fields

• minLength :: Double
• maxLength :: Double
• minHeadLength :: Double
• maxHeadLength :: Double
• minStaffWidth :: Double
• maxStaffWidth :: Double
• color :: AlphaColour Double
• hStyle :: ArrowHTStyle Double

Instances

Show ArrowOptions

Methods

showsPrec :: Int -> ArrowOptions -> ShowS

show :: ArrowOptions -> String

showList :: [ArrowOptions] -> ShowS

Generic ArrowOptions

Associated Types

type Rep ArrowOptions :: * -> *

Methods

from :: ArrowOptions -> Rep ArrowOptions x

to :: Rep ArrowOptions x -> ArrowOptions

Default ArrowOptions

Methods

def :: ArrowOptions

type Rep ArrowOptions

type Rep ArrowOptions = D1 * (MetaData "ArrowOptions" "Chart.Arrow" "chart-unit-0.6.3.0-JcgWI3NOyX2Z7zYwyCLbD" False) (C1 * (MetaCons "ArrowOptions" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "minLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Double)) (S1 * (MetaSel (Just Symbol "maxLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Double))) ((:*:) * (S1 * (MetaSel (Just Symbol "minHeadLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Double)) (S1 * (MetaSel (Just Symbol "maxHeadLength") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Double)))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "minStaffWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Double)) (S1 * (MetaSel (Just Symbol "maxStaffWidth") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Double))) ((:*:) * (S1 * (MetaSel (Just Symbol "color") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (AlphaColour Double))) (S1 * (MetaSel (Just Symbol "hStyle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (ArrowHTStyle Double)))))))

normArrows :: [Arrow] -> [Arrow]

Equalize the arrow space width with the data space one. this creates the right arrow sizing in physical chart space

arrows :: Traversable f => ArrowOptions -> f Arrow -> Chart b

Rescale data across position, and between position and arrow direction.

note that, due to this auto-scaling, there is no such thing as a single arrow_ chart

arrowsExample :: Chart b
arrowsExample =
  arrows
    ( #maxLength .~ 0.5 $
      #maxHeadLength .~ 0.2 $
      #maxStaffWidth .~ 0.01 $ def)
    [ Arrow (Pair x (sin (5 * x))) (Pair x (cos x))
    | x <- grid MidPos (one :: Range Double) 100
    ]

arrowChart :: Traversable f => [ArrowOptions] -> Rect Double -> Rect Double -> [f Arrow] -> Chart b

A chart of arrows

arrowChart_ :: Traversable f => [ArrowOptions] -> Rect Double -> [f Arrow] -> Chart b

An arrow chart scaled to its own range

arrowChart_Example :: Chart b
arrowChart_Example = arrowChart_ [def] asquare [as]
  where
    as =
      normArrows
        [ Arrow (Pair x y) (Pair (sin 1 / x + 0.0001) (cos 1 / y + 0.0001))
        | x <- grid MidPos (one :: Range Double) 20
        , y <- grid MidPos (one :: Range Double) 20
        ]