class Celestine::Svg

Overview

Group class which can group multiple drawables together.

Included Modules

Defined in:

celestine.cr
drawables/svg.cr

Constant Summary

TAG = "svg"

Constructors

Instance Method Summary

Instance methods inherited from module Celestine::Meta::Context::Methods

<<(drawable : Celestine::Drawable) <<, use(id : String)
use(drawable : Celestine::Drawable)
use(drawable : Celestine::Drawable, &block : Celestine::Use -> Celestine::Use)
use(id : String, &block : Celestine::Use -> Celestine::Use)
use(&block : Celestine::Use -> Celestine::Use)
use

Instance methods inherited from module Celestine::Modules::Animate::Transform

animate_transform_rotate(&block : Proc(Celestine::Animate::Transform::Rotate, Nil)) animate_transform_rotate, animate_transform_scale(&block : Proc(Celestine::Animate::Transform::Scale, Nil)) animate_transform_scale, animate_transform_skew_x(&block : Proc(Celestine::Animate::Transform::SkewX, Nil)) animate_transform_skew_x, animate_transform_skew_y(&block : Proc(Celestine::Animate::Transform::SkewY, Nil)) animate_transform_skew_y, animate_transform_translate(&block : Proc(Celestine::Animate::Transform::Translate, Nil)) animate_transform_translate

Instance methods inherited from module Celestine::Modules::Animate::Motion

animate_motion(&block : Celestine::Animate::Motion -> Celestine::Animate::Motion) animate_motion

Instance methods inherited from module Celestine::Modules::Animate

animate(&block : Proc(Celestine::Animate, Nil)) animate

Instance methods inherited from module Celestine::Modules::Filter

filter_attribute(io : IO) filter_attribute, set_filter(id : String)
set_filter(filter : Celestine::Filter)
set_filter

Instance methods inherited from module Celestine::Modules::Mask

mask_attribute(io : IO) mask_attribute, set_mask(id : String)
set_mask(mask : Celestine::Mask)
set_mask

Instance methods inherited from module Celestine::Modules::Transform

transform(&block : Celestine::Drawable::Transform -> Celestine::Drawable::Transform) transform, transform_attribute(io : IO) transform_attribute

Instance methods inherited from module Celestine::Modules::StrokeFill

color : String | Nil color, color=(color : String | Nil) color=, color_interpolation : String | Nil color_interpolation, color_interpolation=(color_interpolation : String | Nil) color_interpolation=, color_interpolation_filters : String | Nil color_interpolation_filters, color_interpolation_filters=(color_interpolation_filters : String | Nil) color_interpolation_filters=, dash_array : Array(Float64) dash_array, dash_array=(dash_array : Array(Float64)) dash_array=, dash_offset : IFNumber | Nil dash_offset, dash_offset=(dash_offset : IFNumber | Nil) dash_offset=, dash_offset_units : String | Nil dash_offset_units, dash_offset_units=(dash_offset_units : String | Nil) dash_offset_units=, fill : String | Nil fill, fill=(fill : String | Nil) fill=, fill_opacity : IFNumber | Nil fill_opacity, fill_opacity=(fill_opacity : IFNumber | Nil) fill_opacity=, fill_rule : Bool fill_rule, fill_rule=(fill_rule : Bool) fill_rule=, line_cap : String | Nil line_cap, line_cap=(line_cap : String | Nil) line_cap=, line_join : String | Nil line_join, line_join=(line_join : String | Nil) line_join=, miter_limit : IFNumber | Nil miter_limit, miter_limit=(miter_limit : IFNumber | Nil) miter_limit=, miter_limit_units : String | Nil miter_limit_units, miter_limit_units=(miter_limit_units : String | Nil) miter_limit_units=, opacity : IFNumber | Nil opacity, opacity=(opacity : IFNumber | Nil) opacity=, set_fill(pattern : Celestine::Pattern)
set_fill(gradient : Celestine::Gradient)
set_fill
, set_stroke(pattern : Celestine::Pattern)
set_stroke(gradient : Celestine::Gradient)
set_stroke
, shape_rendering : String | Nil shape_rendering, shape_rendering=(shape_rendering : String | Nil) shape_rendering=, stroke : String | Nil stroke, stroke=(stroke : String | Nil) stroke=, stroke_fill_attribute(io : IO) stroke_fill_attribute, stroke_opacity : IFNumber | Nil stroke_opacity, stroke_opacity=(stroke_opacity : IFNumber | Nil) stroke_opacity=, stroke_width : IFNumber | Nil stroke_width, stroke_width=(stroke_width : IFNumber | Nil) stroke_width=, stroke_width_units : String | Nil stroke_width_units, stroke_width_units=(stroke_width_units : String | Nil) stroke_width_units=, vector_effect : String | Nil vector_effect, vector_effect=(vector_effect : String | Nil) vector_effect=

Instance methods inherited from module Celestine::Modules::Body

body_attribute(io) body_attribute, height : IFNumber | Nil height, height=(height : IFNumber | Nil) height=, height_units : String | Nil height_units, height_units=(height_units : String | Nil) height_units=, width : IFNumber | Nil width, width=(width : IFNumber | Nil) width=, width_units : String | Nil width_units, width_units=(width_units : String | Nil) width_units=

Instance methods inherited from module Celestine::Modules::Position

position_attribute(io : IO) position_attribute, x : IFNumber | Nil x, x=(x : IFNumber | Nil) x=, x_units : String | Nil x_units, x_units=(x_units : String | Nil) x_units=, y : IFNumber | Nil y, y=(y : IFNumber | Nil) y=, y_units : String | Nil y_units, y_units=(y_units : String | Nil) y_units=

Instance methods inherited from class Celestine::Drawable

class_attribute(io : IO) class_attribute, classes : Array(String) classes, classes=(classes : Array(String)) classes=, custom_attribute(io : IO) custom_attribute, custom_attrs : Hash(String, String) custom_attrs, custom_attrs=(custom_attrs : Hash(String, String)) custom_attrs=, draw(io : IO) : Nil draw, id : String | Nil id, id=(id : String | Nil) id=, id_attribute(io : IO) id_attribute, inner_elements : IO::Memory inner_elements, inner_elements=(inner_elements : IO::Memory) inner_elements=, style : Hash(String, String) style, style=(style : Hash(String, String)) style=, style_attribute(io : IO) style_attribute

Constructor Detail

def self.new #

[View source]

Instance Method Detail

def anchor(define = false, &block : Celestine::Anchor -> Celestine::Anchor) : Celestine::Anchor #

Allows a Celestine::Anchor to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def circle(define = false, &block : Celestine::Circle -> Celestine::Circle) : Celestine::Circle #

Allows a Celestine::Circle to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def define(drawable : Celestine::Drawable) #

Add drawable to this Celestine::Svg's definitions, allowing it to be used later.


[View source]
def draw(io : IO) : Nil #

Draws this rectangle to an IO


[View source]
def ellipse(define = false, &block : Celestine::Ellipse -> Celestine::Ellipse) : Celestine::Ellipse #

Allows a Celestine::Ellipse to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def filter(&block : Celestine::Filter -> Celestine::Filter) #

Create a filter object and add it to this Celestine::Svg's defs


[View source]
def group(define = false, &block : Celestine::Group -> Celestine::Group) : Celestine::Group #

Allows a Celestine::Group to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def image(define = false, &block : Celestine::Image -> Celestine::Image) : Celestine::Image #

Allows a Celestine::Image to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def linear_gradient(&block : Celestine::Gradient::Linear -> Celestine::Gradient::Linear) #

Create a linear gradient object and add it to this Celestine::Svg's defs


[View source]
def marker(&block : Celestine::Marker -> Celestine::Marker) #

Create a marker object and add it to this Celestine::Svg's defs


[View source]
def mask(&block : Celestine::Mask -> Celestine::Mask) #

Create a mask object and add it to this Celestine::Svg's defs


[View source]
def path(define = false, &block : Celestine::Path -> Celestine::Path) : Celestine::Path #

Allows a Celestine::Path to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def pattern(&block : Celestine::Pattern -> Celestine::Pattern) #

Create a pattern object and add it to this Celestine::Svg's defs


[View source]
def radial_gradient(&block : Celestine::Gradient::Radial -> Celestine::Gradient::Radial) #

Create a linear gradient object and add it to this Celestine::Svg's defs


[View source]
def rectangle(define = false, &block : Celestine::Rectangle -> Celestine::Rectangle) : Celestine::Rectangle #

Allows a Celestine::Rectangle to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def shape_rendering : String | Nil #
Description copied from module Celestine::Modules::StrokeFill

Provides hints to the renderer about what tradeoffs to make when rendering shapes like paths, circles, or rectangles.

  • Potential Values: auto | optimizeSpeed | crispEdges | geometricPrecision
  • Mozilla SVG Docs

[View source]
def shape_rendering=(shape_rendering : String | Nil) #
Description copied from module Celestine::Modules::StrokeFill

Provides hints to the renderer about what tradeoffs to make when rendering shapes like paths, circles, or rectangles.

  • Potential Values: auto | optimizeSpeed | crispEdges | geometricPrecision
  • Mozilla SVG Docs

[View source]
def svg(define = false, &block : Celestine::Svg -> Celestine::Svg) : Celestine::Svg #

Allows a Celestine::Svg to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def text(define = false, &block : Celestine::Text -> Celestine::Text) : Celestine::Text #

Allows a Celestine::Text to be made using a DSL call. Can be defined, which adds the drawable to the main context's definitions, and not to the main document itself.


def view_box : Celestine::ViewBox | Nil #

[View source]
def view_box=(view_box : Celestine::ViewBox | Nil) #

[View source]