svg
0.31.0
API
Generated with
svg/doodle.svg/doodle.svg.algebra/JsAlgebraModule/JsAlgebra

JsAlgebra

doodle.svg.algebra.JsAlgebraModule.JsAlgebra
final class JsAlgebra(val canvas: Canvas, val applyF: Apply[SvgResult], val functorF: Functor[SvgResult]) extends BaseAlgebra, Filter, HasTextBoundingBox[Rect], Image, JsTagged, Text

Attributes

Source
Algebra.scala
Graph
Supertypes
trait Text
trait JsTagged
trait Tagged[Tag]
trait HasTextBoundingBox[Rect]
trait BaseAlgebra
trait Basic
trait Transform
trait Style
trait Debug
trait Image
trait Filter
trait Filter
trait Text
trait Path
trait Path
trait Shape
trait Shape
trait Size
trait Layout
trait Algebra
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

object PathApi extends PathApi

Attributes

Inherited from:
Path
Source
Path.scala
Supertypes
trait PathApi
class Object
trait Matchable
class Any
trait PathApi

Attributes

Inherited from:
GenericPath
Source
GenericPath.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PathApi
object ShapeApi extends ShapeApi

Attributes

Inherited from:
Shape
Source
Shape.scala
Supertypes
trait ShapeApi
class Object
trait Matchable
class Any
trait ShapeApi

Attributes

Inherited from:
GenericShape
Source
GenericShape.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object ShapeApi
trait TextApi

Attributes

Inherited from:
GenericText
Source
GenericText.scala
Supertypes
class Object
trait Matchable
class Any

Inherited types

type Drawing[A] = Finalized[AlgebraModule.this.SvgResult, A]

The effect type that methods on this algebra produce. Represents an effect that, when run, will draw something and produce a value.

The effect type that methods on this algebra produce. Represents an effect that, when run, will draw something and produce a value.

Attributes

Inherited from:
BaseAlgebra
Source
BaseAlgebra.scala

Value members

Concrete methods

def textBoundingBox(text: String, font: Font): (BoundingBox, Rect)

Attributes

Source
Algebra.scala

Inherited methods

def above[A](top: Finalized[SvgResult, A], bottom: Finalized[SvgResult, A])(implicit s: Semigroup[A]): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def at[A](img: Drawing[A], offset: Point): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def at[A](img: Drawing[A], offset: Vec): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def at[A](img: Drawing[A], r: Double, a: Angle): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def at[A](img: Drawing[A], x: Double, y: Double): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def at[A](img: Finalized[SvgResult, A], landmark: Landmark): Finalized[SvgResult, A]

Displace img by the given landmark relative to the origin, expanding the bounding box if necessary to include the relocated image.

Displace img by the given landmark relative to the origin, expanding the bounding box if necessary to include the relocated image.

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def below[A](bottom: Drawing[A], top: Drawing[A])(implicit s: Semigroup[A]): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def beside[A](left: Finalized[SvgResult, A], right: Finalized[SvgResult, A])(implicit s: Semigroup[A]): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def boundingBox[A](picture: Finalized[SvgResult, A]): Finalized[SvgResult, BoundingBox]

Get the bounding box enclosing the picture

Get the bounding box enclosing the picture

Attributes

Inherited from:
GenericSize
Source
GenericSize.scala
def boundingBox(elements: List[PathElement]): BoundingBox

Attributes

Inherited from:
GenericPath
Source
GenericPath.scala
def boxBlur[A](picture: Drawing[A], radius: Int): Drawing[A]

Attributes

Inherited from:
Filter
Source
Filter.scala
def catmulRom(points: Seq[Point], tension: Double): Drawing[Unit]

Attributes

Inherited from:
Path
Source
Path.scala
def circle(diameter: Double): Finalized[SvgResult, Unit]

A circle with the given diameter. We use diamter rather than radius so circle(100) has the same size as square(100)

A circle with the given diameter. We use diamter rather than radius so circle(100) has the same size as square(100)

Attributes

Inherited from:
GenericShape
Source
GenericShape.scala
def convolveMatrix[A](picture: Drawing[A], kernel: Kernel, divisor: Option[Double], bias: Double): Drawing[A]

Apply a custom convolution kernel

Apply a custom convolution kernel

Value parameters

bias

Optional bias to add to each pixel

divisor

Optional divisor for the result (defaults to sum of kernel)

kernel

The convolution kernel

Attributes

Inherited from:
Filter
Source
Filter.scala
def debug[A](picture: Finalized[SvgResult, A], color: Color): Finalized[SvgResult, A]

Draws the bounding box and origin of the given picture on top of the picture. The given color is used for the bounding box and origin.

Draws the bounding box and origin of the given picture on top of the picture. The given color is used for the bounding box and origin.

The bounding box and origin are not included in layout calculations and hence will not affect the picture's layout.

Attributes

Inherited from:
GenericDebug
Source
GenericDebug.scala
def detectEdges[A](picture: Drawing[A]): Drawing[A]

Attributes

Inherited from:
Filter
Source
Filter.scala
def dropShadow[A](picture: Drawing[A], offsetX: Double, offsetY: Double, blur: Double, color: Color): Drawing[A]

Attributes

Inherited from:
Filter
Source
Filter.scala
def emboss[A](picture: Drawing[A]): Drawing[A]

Attributes

Inherited from:
Filter
Source
Filter.scala
def empty: Finalized[SvgResult, Unit]

The empty shape, which is no shape at all.

The empty shape, which is no shape at all.

Attributes

Inherited from:
GenericShape
Source
GenericShape.scala
def equilateralTriangle(width: Double): Drawing[Unit]

Create an equilateral triangle with the given side length.

Create an equilateral triangle with the given side length.

Attributes

Inherited from:
Path
Source
Path.scala
def font[A](image: Finalized[SvgResult, A], font: Font): Finalized[SvgResult, A]

Specifies the font to use when rendering text

Specifies the font to use when rendering text

Attributes

Inherited from:
GenericText
Source
GenericText.scala
def gaussianBlur[A](picture: Drawing[A], stdDeviation: Double): Drawing[A]

Attributes

Inherited from:
Filter
Source
Filter.scala
def height[A](picture: Finalized[SvgResult, A]): Finalized[SvgResult, Double]

Get the height of the bounding box enclosing the picture

Get the height of the bounding box enclosing the picture

Attributes

Inherited from:
GenericSize
Source
GenericSize.scala
def horizontalReflection[A](img: Drawing[A]): Drawing[A]

Attributes

Inherited from:
Transform
Source
Transform.scala
def image(ref: SvgImageRef): Drawing[Unit]

Create an SVG image element from a reference

Create an SVG image element from a reference

Attributes

Inherited from:
Image
Source
Image.scala
def interpolatingSpline(points: Seq[Point]): Drawing[Unit]

Attributes

Inherited from:
Path
Source
Path.scala
def margin[A](img: Drawing[A], width: Double): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def margin[A](img: Drawing[A], width: Double, height: Double): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def margin[A](img: Finalized[SvgResult, A], top: Double, right: Double, bottom: Double, left: Double): Finalized[SvgResult, A]

Expand the bounding box of img by the given amounts.

Expand the bounding box of img by the given amounts.

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def noDash[A](image: Finalized[SvgResult, A]): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericStyle
Source
GenericStyle.scala
def noFill[A](image: Finalized[SvgResult, A]): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericStyle
Source
GenericStyle.scala
def noStroke[A](image: Finalized[SvgResult, A]): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericStyle
Source
GenericStyle.scala
def on[A](top: Finalized[SvgResult, A], bottom: Finalized[SvgResult, A])(implicit s: Semigroup[A]): Finalized[SvgResult, A]

Place the origin of top on the origin of bottom

Place the origin of top on the origin of bottom

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def originAt[A](img: Drawing[A], offset: Point): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def originAt[A](img: Drawing[A], offset: Vec): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def originAt[A](img: Drawing[A], r: Double, a: Angle): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def originAt[A](img: Drawing[A], x: Double, y: Double): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def originAt[A](img: Finalized[SvgResult, A], landmark: Landmark): Finalized[SvgResult, A]

Place the origin of img at the given landmark, expanding the bounding box if necessary to include the relocated origin.

Place the origin of img at the given landmark, expanding the bounding box if necessary to include the relocated origin.

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def path(path: OpenPath): Finalized[SvgResult, Unit]

Attributes

Inherited from:
GenericPath
Source
GenericPath.scala
def path(path: ClosedPath): Finalized[SvgResult, Unit]

Attributes

Inherited from:
GenericPath
Source
GenericPath.scala
def rectangle(width: Double, height: Double): Finalized[SvgResult, Unit]

A rectangle with the given width and height.

A rectangle with the given width and height.

Attributes

Inherited from:
GenericShape
Source
GenericShape.scala
def regularPolygon(sides: Int, radius: Double): Drawing[Unit]

Attributes

Inherited from:
Path
Source
Path.scala
def rotate[A](img: Drawing[A], angle: Angle): Drawing[A]

Attributes

Inherited from:
Transform
Source
Transform.scala
def roundedRectangle(width: Double, height: Double, radius: Double): Drawing[Unit]

Attributes

Inherited from:
Path
Source
Path.scala
def scale[A](img: Drawing[A], x: Double, y: Double): Drawing[A]

Attributes

Inherited from:
Transform
Source
Transform.scala
def sharpen[A](picture: Drawing[A], amount: Double): Drawing[A]

Attributes

Inherited from:
Filter
Source
Filter.scala
def size[A](picture: Finalized[SvgResult, A]): Finalized[SvgResult, (Double, Double)]

Get the width and height of the bounding box enclosing the picture

Get the width and height of the bounding box enclosing the picture

Attributes

Inherited from:
GenericSize
Source
GenericSize.scala
def size[A](img: Drawing[A], extent: Double): Drawing[A]

Utility to set the width and height to the same value.

Utility to set the width and height to the same value.

Attributes

Inherited from:
Layout
Source
Layout.scala
def size[A](img: Finalized[SvgResult, A], width: Double, height: Double): Finalized[SvgResult, A]

Set the width and height of the given Drawing's bounding box to the given values. The new bounding box has the same origin as the original bounding box, and extends symmetrically above and below, and left and right of the origin.

Set the width and height of the given Drawing's bounding box to the given values. The new bounding box has the same origin as the original bounding box, and extends symmetrically above and below, and left and right of the origin.

Attributes

Inherited from:
GenericLayout
Source
GenericLayout.scala
def square(width: Double): Finalized[SvgResult, Unit]

A square with the given side length.

A square with the given side length.

Attributes

Inherited from:
GenericShape
Source
GenericShape.scala
def star(points: Int, outerRadius: Double, innerRadius: Double): Drawing[Unit]

Attributes

Inherited from:
Path
Source
Path.scala
def strokeCap[A](image: Finalized[SvgResult, A], cap: Cap): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericStyle
Source
GenericStyle.scala
def strokeDash[A](image: Finalized[SvgResult, A], pattern: Iterable[Double]): Finalized[SvgResult, A]

Specify the stroke dash pattern. The pattern gives the length, in local coordinates, of opaque and transparent sections. The first element is the length of an opaque section, the second of a transparent section, and so on.

Specify the stroke dash pattern. The pattern gives the length, in local coordinates, of opaque and transparent sections. The first element is the length of an opaque section, the second of a transparent section, and so on.

Attributes

Inherited from:
GenericStyle
Source
GenericStyle.scala
def strokeJoin[A](image: Finalized[SvgResult, A], join: Join): Finalized[SvgResult, A]

Attributes

Inherited from:
GenericStyle
Source
GenericStyle.scala
def tagged[A](drawing: Drawing[A], tag: Tag): Drawing[A]

Wrap the given Tag around the given Drawing.

Wrap the given Tag around the given Drawing.

Attributes

Inherited from:
JsTagged
Source
JsTagged.scala
def text(text: String): Finalized[SvgResult, Unit]

Render the given String

Render the given String

Attributes

Inherited from:
GenericText
Source
GenericText.scala
def translate[A](img: Drawing[A], vec: Vec): Drawing[A]

Attributes

Inherited from:
Transform
Source
Transform.scala
def translate[A](img: Drawing[A], x: Double, y: Double): Drawing[A]

Attributes

Inherited from:
Transform
Source
Transform.scala
def triangle(width: Double, height: Double): Finalized[SvgResult, Unit]

An isoceles triangle with the given width and height.

An isoceles triangle with the given width and height.

Attributes

Inherited from:
GenericShape
Source
GenericShape.scala
def under[A](bottom: Drawing[A], top: Drawing[A])(implicit s: Semigroup[A]): Drawing[A]

Attributes

Inherited from:
Layout
Source
Layout.scala
def verticalReflection[A](img: Drawing[A]): Drawing[A]

Attributes

Inherited from:
Transform
Source
Transform.scala
def width[A](picture: Finalized[SvgResult, A]): Finalized[SvgResult, Double]

Get the width of the bounding box enclosing the picture

Get the width of the bounding box enclosing the picture

Attributes

Inherited from:
GenericSize
Source
GenericSize.scala

Concrete fields

val applyF: Apply[SvgResult]

Attributes

Source
Algebra.scala
val canvas: Canvas

Attributes

Source
Algebra.scala
val functorF: Functor[SvgResult]

Attributes

Source
Algebra.scala

Inherited fields

val TextApi: TextApi

Attributes

Inherited from:
Text
Source
Text.scala
val svgA: TypedTag[Nothing]

Attributes

Inherited from:
JsTagged
Source
JsTagged.scala

Implicits

Implicits

implicit val applyDrawing: Apply[SvgResult]

Attributes

Source
Algebra.scala
implicit val drawingInstance: Monad[Drawing]

Attributes

Source
Algebra.scala
implicit val functorDrawing: Functor[SvgResult]

Attributes

Source
Algebra.scala
Generated with