Vectored.Elements.Svg (Vectored v0.4.0)

The <svg> element is a container that defines a new coordinate system and viewport.

It is typically used as the outermost element of SVG documents, but can also be nested to create local coordinate systems.

Viewport and ViewBox: Why they matter

One of the most powerful features of SVG is the ability to separate the drawing coordinates from the display size.

Viewport (width / height): This defines how much space the SVG occupies in the browser or parent element. Think of this as the "frame" of the window.
view_box: This defines the internal "world" of your drawing. By setting a view_box, you can define a stable coordinate system (e.g., 0 to 100) and your drawing will automatically scale to fit whatever width and height you later choose for the viewport.

If you don't set a view_box, the coordinates you use in your shapes will be interpreted as "user units", which usually map 1-to-1 to pixels.

Attributes

x, y - Position of the SVG container. Use these when nesting an SVG inside another to shift the entire sub-drawing.
width, height - Display size. Use these to control the physical size on the screen. Values can be numbers (pixels) or percentages.
view_box - The internal coordinate system. Essential for making your graphics responsive and independent of their display size.
preserve_aspect_ratio - Controls what happens when the view_box and viewport have different shapes (e.g., a square drawing in a wide frame).

Examples

# This creates a responsive circle that always stays centered, 
# no matter what size the SVG is scaled to.
Vectored.Elements.Svg.new("100%", "100%")
|> Vectored.Elements.Svg.with_view_box(0, 0, 100, 100)
|> Vectored.Elements.Svg.append(Vectored.Elements.Circle.new(50, 50, 40))

Summary

Functions

append(svg, elements)

Append children to the SVG element.

append_defs(svg, elements)

Append elements to the <defs> section of the SVG.

at_location(rectangle, x, y)

Set the x and y coordinates of the SVG container.

attributes(element)

attrs()

delete_dataset(elem, key)

Remove a dataset attribute

delete_private(svg, key)

Remove private metadata.

new()

Create a new SVG document container.

new(width, height, children \\ [])

Create a new SVG document with specified dimensions.

put_dataset(elem, key, value)

Set a dataset attribute. Mimics the DOM Element.dataset API. The key will be converted from camelCase to kebab-case for the data-* attribute.

put_private(svg, key, value)

Store private metadata in the SVG struct. This data is not rendered to SVG.

rendered_key(key)

with_alignment_baseline(elem, value)

Simple setter to put the value alignment-baseline onto the element

with_baseline_shift(elem, value)

Simple setter to put the value baseline-shift onto the element

with_children(elem, value)

Simple setter to put the value children onto the element

with_class(elem, value)

Simple setter to put the value class onto the element

with_clip_path(elem, value)

Simple setter to put the value clip-path onto the element

with_clip_rule(elem, value)

Simple setter to put the value clip-rule onto the element

with_color(elem, value)

Simple setter to put the value color onto the element

with_color_interpolation(elem, value)

Simple setter to put the value color-interpolation onto the element

with_color_interpolation_filters(elem, value)

Simple setter to put the value color-interpolation-filters onto the element

with_cursor(elem, value)

Simple setter to put the value cursor onto the element

with_dataset(elem, dataset)

Simple setter to put the value dataset onto the element

with_defs(elem, value)

Simple setter to put the value defs onto the element

with_description(elem, content)

with_direction(elem, value)

Simple setter to put the value direction onto the element

with_display(elem, value)

Simple setter to put the value display onto the element

with_dominant_baseline(elem, value)

Simple setter to put the value dominant-baseline onto the element

with_fill(elem, value)

Simple setter to put the value fill onto the element

with_fill_opacity(elem, value)

Simple setter to put the value fill-opacity onto the element

with_fill_rule(elem, value)

Simple setter to put the value fill-rule onto the element

with_filter(elem, value)

Simple setter to put the value filter onto the element

with_flood_color(elem, value)

Simple setter to put the value flood-color onto the element

with_flood_opacity(elem, value)

Simple setter to put the value flood-opacity onto the element

with_font_family(elem, value)

Simple setter to put the value font-family onto the element

with_font_size(elem, value)

Simple setter to put the value font-size onto the element

with_font_size_adjust(elem, value)

Simple setter to put the value font-size-adjust onto the element

with_font_stretch(elem, value)

Simple setter to put the value font-stretch onto the element

with_font_style(elem, value)

Simple setter to put the value font-style onto the element

with_font_variant(elem, value)

Simple setter to put the value font-variant onto the element

with_font_weight(elem, value)

Simple setter to put the value font-weight onto the element

with_glyph_orientation_horizontal(elem, value)

Simple setter to put the value glyph-orientation-horizontal onto the element

with_glyph_orientation_vertical(elem, value)

Simple setter to put the value glyph-orientation-vertical onto the element

with_height(elem, value)

Simple setter to put the value height onto the element

with_href(elem, value)

Simple setter to put the value href onto the element

with_id(elem, value)

Simple setter to put the value id onto the element

with_image_rendering(elem, value)

Simple setter to put the value image-rendering onto the element

with_letter_spacing(elem, value)

Simple setter to put the value letter-spacing onto the element

with_lighting_color(elem, value)

Simple setter to put the value lighting-color onto the element

with_marker_end(elem, value)

Simple setter to put the value marker-end onto the element

with_marker_mid(elem, value)

Simple setter to put the value marker-mid onto the element

with_marker_start(elem, value)

Simple setter to put the value marker-start onto the element

with_mask(elem, value)

Simple setter to put the value mask onto the element

with_mask_type(elem, value)

Simple setter to put the value mask-type onto the element

with_opacity(elem, value)

Simple setter to put the value opacity onto the element

with_overflow(elem, value)

Simple setter to put the value overflow onto the element

with_paint_order(elem, value)

Simple setter to put the value paint-order onto the element

with_pointer_events(elem, value)

Simple setter to put the value pointer-events onto the element

with_preserve_aspect_ratio(elem, value)

Simple setter to put the value preserveAspectRatio onto the element

with_private(elem, value)

Simple setter to put the value private onto the element

with_shape_rendering(elem, value)

Simple setter to put the value shape-rendering onto the element

with_size(rectangle, width, height)

Set the width and height of the SVG viewport.

with_stop_color(elem, value)

Simple setter to put the value stop-color onto the element

with_stop_opacity(elem, value)

Simple setter to put the value stop-opacity onto the element

with_stroke(elem, value)

Simple setter to put the value stroke onto the element

with_stroke_dasharray(elem, value)

Simple setter to put the value stroke-dasharray onto the element

with_stroke_dashoffset(elem, value)

Simple setter to put the value stroke-dashoffset onto the element

with_stroke_linecap(elem, value)

Simple setter to put the value stroke-linecap onto the element

with_stroke_linejoin(elem, value)

Simple setter to put the value stroke-linejoin onto the element

with_stroke_miterlimit(elem, value)

Simple setter to put the value stroke-miterlimit onto the element

with_stroke_opacity(elem, value)

Simple setter to put the value stroke-opacity onto the element

with_stroke_width(elem, value)

Simple setter to put the value stroke-width onto the element

with_style(elem, styles)

Simple setter to put the value style onto the element

with_text_anchor(elem, value)

Simple setter to put the value text-anchor onto the element

with_text_decoration(elem, value)

Simple setter to put the value text-decoration onto the element

with_text_overflow(elem, value)

Simple setter to put the value text-overflow onto the element

with_text_rendering(elem, value)

Simple setter to put the value text-rendering onto the element

with_title(elem, content)

with_transform(elem, value)

Simple setter to put the value transform onto the element

with_transform_origin(elem, value)

Simple setter to put the value transform-origin onto the element

with_unicode_bidi(elem, value)

Simple setter to put the value unicode-bidi onto the element

with_vector_effect(elem, value)

Simple setter to put the value vector-effect onto the element

with_view_box(elem, value)

Simple setter to put the value viewBox onto the element

with_view_box(elem, width, height)

with_view_box(elem, minx, miny, width, height)

with_visibility(elem, value)

Simple setter to put the value visibility onto the element

with_white_space(elem, value)

Simple setter to put the value white-space onto the element

with_width(elem, value)

Simple setter to put the value width onto the element

with_word_spacing(elem, value)

Simple setter to put the value word-spacing onto the element

with_writing_mode(elem, value)

Simple setter to put the value writing-mode onto the element

with_x(elem, value)

Simple setter to put the value x onto the element

with_y(elem, value)

Simple setter to put the value y onto the element

Types

children()

@type children() :: [Vectored.Renderable.t()]

t()

@type t() :: %Vectored.Elements.Svg{
  alignment_baseline: term(),
  baseline_shift: term(),
  children: children(),
  class: term(),
  clip_path: term(),
  clip_rule: term(),
  color: term(),
  color_interpolation: term(),
  color_interpolation_filters: term(),
  cursor: term(),
  dataset: term(),
  defs: Vectored.Elements.Defs.t() | nil,
  desc: term(),
  direction: term(),
  display: term(),
  dominant_baseline: term(),
  fill: term(),
  fill_opacity: term(),
  fill_rule: term(),
  filter: term(),
  flood_color: term(),
  flood_opacity: term(),
  font_family: term(),
  font_size: term(),
  font_size_adjust: term(),
  font_stretch: term(),
  font_style: term(),
  font_variant: term(),
  font_weight: term(),
  glyph_orientation_horizontal: term(),
  glyph_orientation_vertical: term(),
  height: String.t() | number() | nil,
  href: term(),
  id: term(),
  image_rendering: term(),
  letter_spacing: term(),
  lighting_color: term(),
  marker_end: term(),
  marker_mid: term(),
  marker_start: term(),
  mask: term(),
  mask_type: term(),
  opacity: term(),
  overflow: term(),
  paint_order: term(),
  pointer_events: term(),
  preserve_aspect_ratio: String.t() | nil,
  private: map(),
  shape_rendering: term(),
  stop_color: term(),
  stop_opacity: term(),
  stroke: term(),
  stroke_dasharray: term(),
  stroke_dashoffset: term(),
  stroke_linecap: term(),
  stroke_linejoin: term(),
  stroke_miterlimit: term(),
  stroke_opacity: term(),
  stroke_width: term(),
  style: term(),
  text_anchor: term(),
  text_decoration: term(),
  text_overflow: term(),
  text_rendering: term(),
  title: term(),
  transform: term(),
  transform_origin: term(),
  unicode_bidi: term(),
  vector_effect: term(),
  view_box: String.t() | nil,
  visibility: term(),
  white_space: term(),
  width: String.t() | number() | nil,
  word_spacing: term(),
  writing_mode: term(),
  x: String.t() | number() | nil,
  y: String.t() | number() | nil
}