Scenic.Primitive.Rectangle (Scenic v0.11.0-beta.0) View Source

Draw a rectangle on the screen.

Data

{width, height}

The data for a line is a tuple containing two numbers.

width - width of the rectangle
height - height of the rectangle

Styles

This primitive recognizes the following styles

hidden - show or hide the primitive
fill - fill in the area of the primitive
stroke - stroke the outline of the primitive. In this case, only the curvy part.
join - control how segments are joined.
miter_limit - control how segments are joined.

Usage

You should add/modify primitives via the helper functions in Scenic.Primitives

graph
  |> rect( {100, 50}, stroke: {1, :yellow} )
  |> rectangle( {100, 50}, stroke: {1, :yellow} )

Note: rect is a shortcut for rectangle and they can be used interchangeably.

Link to this section Summary

Types

styles_t()

t()

Functions

centroid(data)

Returns the centroid of the rectangle. This is used as the default pin when applying rotate or scale transforms.

compile(primitive, styles)

Compile the data for this primitive into a mini script. This can be combined with others to generate a larger script and is called when a graph is compiled.

valid_styles()

Returns a list of styles recognized by this primitive.

Link to this section Types

styles_t()

Specs

styles_t() :: [
  :hidden
  | :scissor
  | :fill
  | :stroke_width
  | :stroke_fill
  | :join
  | :miter_limit
]

t()

Specs

t() :: {width :: number(), height :: number()}

Link to this section Functions

centroid(data)

Returns the centroid of the rectangle. This is used as the default pin when applying rotate or scale transforms.

compile(primitive, styles)

Specs

compile(primitive :: Scenic.Primitive.t(), styles :: Scenic.Primitive.Style.t()) ::
  Scenic.Script.t()

Compile the data for this primitive into a mini script. This can be combined with others to generate a larger script and is called when a graph is compiled.

valid_styles()

Specs

valid_styles() :: styles_t()

Returns a list of styles recognized by this primitive.