doodle-docs
0.27.0
API
Generated with
doodle-docs/doodle/doodle.canvas/doodle.canvas.effect/Frame

Frame

doodle.canvas.effect.Frame
See theFrame companion object
final case class Frame(id: String, size: Size, background: Option[Color])

The Frame specifies how to create the area where the canvas output will be drawn. The idiomatic way to create a Frame is to start with Frame(anId), where anId is the id of the DOM element where the output should be drawn, and then call the builder methods starting with with.

For example, this Frame specifies a fixed size and a background color.

Frame("canvas").withSize(300, 300).withBackground(Color.midnightBlue)

Attributes

Companion
object
Source
Frame.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def withBackground(color: Color): Frame

Use the given color as the background.

Use the given color as the background.

Attributes

Source
Frame.scala
def withSize(width: Double, height: Double): Frame

Size the canvas with the given fixed dimensions.

Size the canvas with the given fixed dimensions.

Attributes

Source
Frame.scala
def withSizedToPicture(border: Int): Frame

Size the canvas to fit to the picture's bounding box, plus the given border around the bounding box.

Size the canvas to fit to the picture's bounding box, plus the given border around the bounding box.

Attributes

Source
Frame.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with