The cl-svg Reference Manual

Table of Contents

The cl-svg Reference Manual

This is the cl-svg Reference Manual, version 0.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:37:24 2020 GMT+0.

1 Introduction

cl-svg

Produce Scalable Vector Graphics files with Common Lisp

This is a basic library for producing SVG files. It makes simple things easy (well, easier), but makes no attempt to offer the full freedom of SVG, for which you'd be better off using an XML library.

You can download this library with Quicklisp.

See docs/API.md for how to use this library.

The file testing.lisp has a collection of not very well documented examples.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-svg

Maintainer

William S. Annis <wm.annis@gmail.com>

Author

William S. Annis <wm.annis@gmail.com>

License

MIT License

Description

Produce Scalable Vector Graphics (SVG) files

Version

0.3

Source

cl-svg.asd (file)

Components

• package.lisp (file)
• format-xml.lisp (file)
• path.lisp (file)
• svg.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-svg.asd

Location

cl-svg.asd

Systems

cl-svg (system)

3.1.2 cl-svg/package.lisp

Parent

cl-svg (system)

Location

package.lisp

Packages

cl-svg

3.1.3 cl-svg/format-xml.lisp

Dependency

package.lisp (file)

Parent

cl-svg (system)

Location

format-xml.lisp

Exported Definitions

• *float-format-precision* (special variable)
• *indent-spacing* (special variable)
• set-float-precision (function)

Internal Definitions

• *indent-level* (special variable)
• *precision-epsilon* (special variable)
• begin-group->xml (function)
• element->xml (function)
• end-group->xml (function)
• points (function)
• pp-xml-attr (generic function)
• pp-xml-attr (method)
• pp-xml-attr (method)
• pp-xml-value (generic function)
• pp-xml-value (method)
• pp-xml-value (method)
• pp-xml-value (method)
• string->xml (function)
• with-indentation (macro)
• with-xml-group-element (macro)
• xmlify-keyword (function)

3.1.4 cl-svg/path.lisp

Dependency

format-xml.lisp (file)

Parent

cl-svg (system)

Location

path.lisp

Exported Definitions

• arc-to (function)
• arc-to-r (function)
• close-path (function)
• curve-to (function)
• curve-to-r (function)
• horizontal-to (function)
• horizontal-to-r (function)
• line-to (function)
• line-to-r (function)
• make-path (function)
• move-to (function)
• move-to-r (function)
• path (macro)
• quadratic-curve-to (function)
• quadratic-curve-to-r (function)
• smooth-curve-to (function)
• smooth-curve-to-r (function)
• smooth-quadratic-curve-to (function)
• smooth-quadratic-curve-to-r (function)
• vertical-to (function)
• vertical-to-r (function)
• with-path (macro)

Internal Definitions

• define-path-instruction-pair (macro)
• error-unless-string (function)
• format-instruction (function)

3.1.5 cl-svg/svg.lisp

Dependency

path.lisp (file)

Parent

cl-svg (system)

Location

svg.lisp

Exported Definitions

• add-class (generic function)
• add-class (method)
• add-element (generic function)
• add-element (method)
• add-element (method)
• add-namespace (generic function)
• add-namespace (method)
• add-stylesheet (generic function)
• add-stylesheet (method)
• comment (function)
• desc (function)
• draw (macro)
• draw* (function)
• gradient-stop (function)
• link (macro)
• make-foreign-object (macro)
• make-group (macro)
• make-linear-gradient (macro)
• make-marker (macro)
• make-mask (macro)
• make-pattern (macro)
• make-radial-gradient (macro)
• make-svg-symbol (macro)
• make-svg-toplevel (function)
• matrix (function)
• missing-attributes (condition)
• rotate (function)
• scale (function)
• script (function)
• script-link (function)
• skew-x (function)
• skew-y (function)
• stream-out (generic function)
• stream-out (method)
• stream-out (method)
• stream-out (method)
• style (function)
• svg-1.1-toplevel (class)
• svg-1.2-toplevel (class)
• svg-toplevel (class)
• text (macro)
• textarea (macro)
• title (function)
• transform (macro)
• translate (function)
• tspan (macro)
• with-svg-to-file (macro)
• without-attribute-check (macro)
• xlink-href (generic function)
• xlink-href (method)

Internal Definitions

• *check-required-attributes* (special variable)
• add-defs-element (generic function)
• add-defs-element (method)
• add-transform (generic function)
• add-transform (method)
• assert-required-attributes (generic function)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• compose-tspan (function)
• define-defs-group-maker (macro)
• define-element-maker (macro)
• define-gradient-maker (macro)
• define-toplevel-group-maker (macro)
• element-attributes (method)
• (setf element-attributes) (method)
• element-contents (method)
• (setf element-contents) (method)
• element-id (generic function)
• element-id (method)
• (setf element-id) (method)
• (setf element-id) (generic function)
• element-name (method)
• (setf element-name) (method)
• get-attribute (generic function)
• get-attribute (method)
• has-attribute-p (generic function)
• has-attribute-p (method)
• has-contents-p (generic function)
• has-contents-p (method)
• make-svg-element (generic function)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• missing-attribute-message (method)
• (setf missing-attribute-message) (method)
• push-attribute (generic function)
• push-attribute (method)
• svg-defs (method)
• (setf svg-defs) (method)
• svg-element (class)

4 Packages

Packages are listed by definition order.

4.1 cl-svg

Source

package.lisp (file)

Nickname

svg

Use List

common-lisp

Exported Definitions

• *float-format-precision* (special variable)
• *indent-spacing* (special variable)
• add-class (generic function)
• add-class (method)
• add-element (generic function)
• add-element (method)
• add-element (method)
• add-namespace (generic function)
• add-namespace (method)
• add-stylesheet (generic function)
• add-stylesheet (method)
• arc-to (function)
• arc-to-r (function)
• close-path (function)
• comment (function)
• curve-to (function)
• curve-to-r (function)
• desc (function)
• draw (macro)
• draw* (function)
• gradient-stop (function)
• horizontal-to (function)
• horizontal-to-r (function)
• line-to (function)
• line-to-r (function)
• link (macro)
• make-foreign-object (macro)
• make-group (macro)
• make-linear-gradient (macro)
• make-marker (macro)
• make-mask (macro)
• make-path (function)
• make-pattern (macro)
• make-radial-gradient (macro)
• make-svg-symbol (macro)
• make-svg-toplevel (function)
• matrix (function)
• missing-attributes (condition)
• move-to (function)
• move-to-r (function)
• path (macro)
• quadratic-curve-to (function)
• quadratic-curve-to-r (function)
• rotate (function)
• scale (function)
• script (function)
• script-link (function)
• set-float-precision (function)
• skew-x (function)
• skew-y (function)
• smooth-curve-to (function)
• smooth-curve-to-r (function)
• smooth-quadratic-curve-to (function)
• smooth-quadratic-curve-to-r (function)
• stream-out (generic function)
• stream-out (method)
• stream-out (method)
• stream-out (method)
• style (function)
• svg-1.1-toplevel (class)
• svg-1.2-toplevel (class)
• svg-toplevel (class)
• text (macro)
• textarea (macro)
• title (function)
• transform (macro)
• translate (function)
• tspan (macro)
• vertical-to (function)
• vertical-to-r (function)
• with-path (macro)
• with-svg-to-file (macro)
• without-attribute-check (macro)
• xlink-href (generic function)
• xlink-href (method)

Internal Definitions

• *check-required-attributes* (special variable)
• *indent-level* (special variable)
• *precision-epsilon* (special variable)
• add-defs-element (generic function)
• add-defs-element (method)
• add-transform (generic function)
• add-transform (method)
• assert-required-attributes (generic function)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• assert-required-attributes (method)
• begin-group->xml (function)
• compose-tspan (function)
• define-defs-group-maker (macro)
• define-element-maker (macro)
• define-gradient-maker (macro)
• define-path-instruction-pair (macro)
• define-toplevel-group-maker (macro)
• element->xml (function)
• element-attributes (generic function)
• element-attributes (method)
• (setf element-attributes) (method)
• (setf element-attributes) (generic function)
• element-contents (generic function)
• element-contents (method)
• (setf element-contents) (method)
• (setf element-contents) (generic function)
• element-id (generic function)
• element-id (method)
• (setf element-id) (method)
• (setf element-id) (generic function)
• element-name (generic function)
• element-name (method)
• (setf element-name) (method)
• (setf element-name) (generic function)
• end-group->xml (function)
• error-unless-string (function)
• format-instruction (function)
• get-attribute (generic function)
• get-attribute (method)
• has-attribute-p (generic function)
• has-attribute-p (method)
• has-contents-p (generic function)
• has-contents-p (method)
• make-svg-element (generic function)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• make-svg-element (method)
• missing-attribute-message (generic function)
• missing-attribute-message (method)
• (setf missing-attribute-message) (method)
• (setf missing-attribute-message) (generic function)
• points (function)
• pp-xml-attr (generic function)
• pp-xml-attr (method)
• pp-xml-attr (method)
• pp-xml-value (generic function)
• pp-xml-value (method)
• pp-xml-value (method)
• pp-xml-value (method)
• push-attribute (generic function)
• push-attribute (method)
• string->xml (function)
• svg-defs (generic function)
• svg-defs (method)
• (setf svg-defs) (method)
• (setf svg-defs) (generic function)
• svg-element (class)
• with-indentation (macro)
• with-xml-group-element (macro)
• xmlify-keyword (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *float-format-precision*

Constrains how many digits are printed after the decimal point in XML attribute values.

Package

cl-svg

Source

format-xml.lisp (file)

Special Variable: *indent-spacing*

Package

cl-svg

Source

format-xml.lisp (file)

5.1.2 Macros

Macro: draw SCENE (SHAPE &rest PARAMS) &rest OPTS

Package

cl-svg

Source

svg.lisp (file)

Macro: link SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: make-foreign-object SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: make-group SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: make-linear-gradient SCENE (&rest OPTS) &body STOPS

Package

cl-svg

Source

svg.lisp (file)

Macro: make-marker SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: make-mask SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: make-pattern SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: make-radial-gradient SCENE (&rest OPTS) &body STOPS

Package

cl-svg

Source

svg.lisp (file)

Macro: make-svg-symbol SCENE (&rest OPTS) &body SHAPES

Package

cl-svg

Source

svg.lisp (file)

Macro: path &body CMDS

Package

cl-svg

Source

path.lisp (file)

Macro: text SCENE (&rest OPTS) &body ELEMENTS

Package

cl-svg

Source

svg.lisp (file)

Macro: textarea SCENE (&rest OPTS) &body ELEMENTS

Package

cl-svg

Source

svg.lisp (file)

Macro: transform (&rest TRANSFORMATIONS) &body ELEMENT

Package

cl-svg

Source

svg.lisp (file)

Macro: tspan (&rest OPTS) TEXT

Package

cl-svg

Source

svg.lisp (file)

Macro: with-path PATH &body CMDS

Package

cl-svg

Source

path.lisp (file)

Macro: with-svg-to-file (SVG &rest SVG-ATTRIBUTES) (FILENAME &rest OPEN-OPTIONS) &body BODY

Package

cl-svg

Source

svg.lisp (file)

Macro: without-attribute-check &body BODY

Package

cl-svg

Source

svg.lisp (file)

5.1.3 Functions

Function: arc-to RX RY X-ROTATION LARGE-ARC-FLAG SWEEP-FLAG X Y

Package

cl-svg

Source

path.lisp (file)

Function: arc-to-r RX RY X-ROTATION LARGE-ARC-FLAG SWEEP-FLAG X Y

Package

cl-svg

Source

path.lisp (file)

Function: close-path ()

Package

cl-svg

Source

path.lisp (file)

Function: comment SCENE TEXT

Package

cl-svg

Source

svg.lisp (file)

Function: curve-to CONTROL-X1 CONTROL-Y1 CONTROL-X2 CONTROL-Y2 X Y

Package

cl-svg

Source

path.lisp (file)

Function: curve-to-r CONTROL-X1 CONTROL-Y1 CONTROL-X2 CONTROL-Y2 X Y

Package

cl-svg

Source

path.lisp (file)

Function: desc SCENE TEXT

add a description to any SVG element

Package

cl-svg

Source

svg.lisp (file)

Function: draw* &rest X

Package

cl-svg

Source

svg.lisp (file)

Function: gradient-stop &key COLOR OFFSET OPACITY

Package

cl-svg

Source

svg.lisp (file)

Function: horizontal-to X

Package

cl-svg

Source

path.lisp (file)

Function: horizontal-to-r X

Package

cl-svg

Source

path.lisp (file)

Function: line-to X Y

Package

cl-svg

Source

path.lisp (file)

Function: line-to-r X Y

Package

cl-svg

Source

path.lisp (file)

Function: make-path ()

Package

cl-svg

Source

path.lisp (file)

Function: make-svg-toplevel CLASS &rest ATTRIBUTES

Package

cl-svg

Source

svg.lisp (file)

Function: matrix A B C D E F

Package

cl-svg

Source

svg.lisp (file)

Function: move-to X Y

Package

cl-svg

Source

path.lisp (file)

Function: move-to-r X Y

Package

cl-svg

Source

path.lisp (file)

Function: quadratic-curve-to CONTROL-X1 CONTROL-Y1 X Y

Package

cl-svg

Source

path.lisp (file)

Function: quadratic-curve-to-r CONTROL-X1 CONTROL-Y1 X Y

Package

cl-svg

Source

path.lisp (file)

Function: rotate ANGLE &optional CX CY

Package

cl-svg

Source

svg.lisp (file)

Function: scale SX &optional SY

Package

cl-svg

Source

svg.lisp (file)

Function: script SCENE SCRIPT

add inline javascript to a scene

Package

cl-svg

Source

svg.lisp (file)

Function: script-link SCENE LINK

Package

cl-svg

Source

svg.lisp (file)

Function: set-float-precision P

Package

cl-svg

Source

format-xml.lisp (file)

Function: skew-x ANGLE

Package

cl-svg

Source

svg.lisp (file)

Function: skew-y ANGLE

Package

cl-svg

Source

svg.lisp (file)

Function: smooth-curve-to CONTROL-X2 CONTROL-Y2 X Y

Package

cl-svg

Source

path.lisp (file)

Function: smooth-curve-to-r CONTROL-X2 CONTROL-Y2 X Y

Package

cl-svg

Source

path.lisp (file)

Function: smooth-quadratic-curve-to X Y

Package

cl-svg

Source

path.lisp (file)

Function: smooth-quadratic-curve-to-r X Y

Package

cl-svg

Source

path.lisp (file)

Function: style SCENE CSS

add inline CSS to a scene

Package

cl-svg

Source

svg.lisp (file)

Function: title SCENE TEXT

add a title to any SVG element

Package

cl-svg

Source

svg.lisp (file)

Function: translate TX &optional TY

Package

cl-svg

Source

svg.lisp (file)

Function: vertical-to Y

Package

cl-svg

Source

path.lisp (file)

Function: vertical-to-r Y

Package

cl-svg

Source

path.lisp (file)

5.1.4 Generic functions

Generic Function: add-class ELEMENT CLASS

Push an XML class into an element. If the property already has contents the new transform is simply appended.

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: add-class (ELEMENT svg-element) (CLASS string)

Generic Function: add-element CONTAINER ELEMENT

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: add-element (CONTAINER svg-element) (ELEMENT string)

Method: add-element (CONTAINER svg-element) (ELEMENT svg-element)

Generic Function: add-namespace ELEMENT NAME URL

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: add-namespace (E svg-element) NAME URL

Generic Function: add-stylesheet SVG-TOPLEVEL URL

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: add-stylesheet (SVG svg-toplevel) URL

Generic Function: stream-out STREAM ELEMENT

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: stream-out S (E svg-toplevel)

Method: stream-out S (E string)

Method: stream-out S (E svg-element)

Generic Function: xlink-href ELEMENT

create a local URL reference to this element

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: xlink-href (E svg-element)

5.1.5 Conditions

Condition: missing-attributes ()

Package

cl-svg

Source

svg.lisp (file)

Direct superclasses

condition (condition)

Direct methods

• missing-attribute-message (method)
• missing-attribute-message (method)

Direct slots

Slot: message

Initargs

:message

Readers

missing-attribute-message (generic function)

Writers

(setf missing-attribute-message) (generic function)

5.1.6 Classes

Class: svg-1.1-toplevel ()

Package

cl-svg

Source

svg.lisp (file)

Direct superclasses

svg-toplevel (class)

Direct Default Initargs

Initarg	Value
:name	"svg"
:xml-header	"<?xml version=\"1.0\" standalone=\"no\"?>"
:doctype	"<!doctype svg public \"-//w3c//dtd svg 1.1//en\" \"http://www.w3.org/graphics/svg/1.1/dtd/svg11.dtd\">"
:attributes	(list :version "1.1" :id "toplevel" "xmlns" "http://www.w3.org/2000/svg" "xmlns:xlink" "http://www.w3.org/1999/xlink")

Class: svg-1.2-toplevel ()

Package

cl-svg

Source

svg.lisp (file)

Direct superclasses

svg-toplevel (class)

Direct Default Initargs

Initarg	Value
:name	"svg"
:xml-header	"<?xml version=\"1.0\" standalone=\"no\"?>"
:attributes	(list :version "1.2" :id "toplevel" "xmlns" "http://www.w3.org/2000/svg" "xmlns:xlink" "http://www.w3.org/1999/xlink")

Class: svg-toplevel ()

Package

cl-svg

Source

svg.lisp (file)

Direct superclasses

svg-element (class)

Direct subclasses

• svg-1.1-toplevel (class)
• svg-1.2-toplevel (class)

Direct methods

• stream-out (method)
• add-stylesheet (method)
• add-defs-element (method)
• svg-defs (method)
• svg-defs (method)

Direct slots

Slot: xml-header

Initargs

:xml-header

Slot: doctype

Initargs

:doctype

Slot: defs

Initform

(make-instance (quote cl-svg::svg-element) :name "defs")

Readers

svg-defs (generic function)

Writers

(setf svg-defs) (generic function)

Slot: stylesheets

Type

list

Initargs

:stylesheets

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *check-required-attributes*

Determines if the shape element attribute list is checked for completeness.

Package

cl-svg

Source

svg.lisp (file)

Special Variable: *indent-level*

Package

cl-svg

Source

format-xml.lisp (file)

Special Variable: *precision-epsilon*

Package

cl-svg

Source

format-xml.lisp (file)

5.2.2 Macros

Macro: define-defs-group-maker MACRO-NAME ELEMENT-NAME

Package

cl-svg

Source

svg.lisp (file)

Macro: define-element-maker ELEMENT NAME REQUIRED-ATTRIBUTES

Package

cl-svg

Source

svg.lisp (file)

Macro: define-gradient-maker MACRO-NAME ELEMENT-NAME

Package

cl-svg

Source

svg.lisp (file)

Macro: define-path-instruction-pair NAME INSTRUCTION (&rest ARGS)

Package

cl-svg

Source

path.lisp (file)

Macro: define-toplevel-group-maker MACRO-NAME ELEMENT-NAME

Package

cl-svg

Source

svg.lisp (file)

Macro: with-indentation &body BODY

Package

cl-svg

Source

format-xml.lisp (file)

Macro: with-xml-group-element (STREAM ELEMENT PROPERTIES) &body BODY

Package

cl-svg

Source

format-xml.lisp (file)

5.2.3 Functions

Function: begin-group->xml STREAM ELEMENT PROPERTIES

Package

cl-svg

Source

format-xml.lisp (file)

Function: compose-tspan OPTS TEXT

Package

cl-svg

Source

svg.lisp (file)

Function: element->xml STREAM ELEMENT PROPERTIES

Package

cl-svg

Source

format-xml.lisp (file)

Function: end-group->xml STREAM ELEMENT

Package

cl-svg

Source

format-xml.lisp (file)

Function: error-unless-string S

Package

cl-svg

Source

path.lisp (file)

Function: format-instruction INSTRUCTION &rest ARGS

Package

cl-svg

Source

path.lisp (file)

Function: points POINTS

Package

cl-svg

Source

format-xml.lisp (file)

Function: string->xml STREAM STRING

Package

cl-svg

Source

format-xml.lisp (file)

Function: xmlify-keyword KW

Convert a ’:view-box’ lisp-style name into XMLish ’viewBox’.

Package

cl-svg

Source

format-xml.lisp (file)

5.2.4 Generic functions

Generic Function: add-defs-element SVG-TOPLEVEL ELEMENT

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: add-defs-element (SVG svg-toplevel) E

Generic Function: add-transform ELEMENT TRANSFORM

Push a transformation into an element. If the property already has contents the new transform is simply appended.

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: add-transform (ELEMENT svg-element) (TRANSFORM string)

Generic Function: assert-required-attributes ELEMENT ATTRIBUTE-LIST

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: assert-required-attributes (ELEMENT (eql radial-gradient)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql linear-gradient)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql textarea)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql text)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql foreign-object)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql link)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql group)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql mask)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql pattern)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql marker)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql symbol)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql use)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql image)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql path)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql circle)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql ellipse)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql polygon)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql polyline)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql rect)) ATTRIBUTES

Method: assert-required-attributes (ELEMENT (eql line)) ATTRIBUTES

Generic Function: element-attributes OBJECT

Generic Function: (setf element-attributes) NEW-VALUE OBJECT

Package

cl-svg

Methods

Method: element-attributes (SVG-ELEMENT svg-element)

automatically generated reader method

Source

svg.lisp (file)

Method: (setf element-attributes) NEW-VALUE (SVG-ELEMENT svg-element)

automatically generated writer method

Source

svg.lisp (file)

Generic Function: element-contents OBJECT

Generic Function: (setf element-contents) NEW-VALUE OBJECT

Package

cl-svg

Methods

Method: element-contents (SVG-ELEMENT svg-element)

automatically generated reader method

Source

svg.lisp (file)

Method: (setf element-contents) NEW-VALUE (SVG-ELEMENT svg-element)

automatically generated writer method

Source

svg.lisp (file)

Generic Function: element-id ELEMENT

Generic Function: (setf element-id) ID ELEMENT

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: element-id (E svg-element)

Method: (setf element-id) ID (E svg-element)

Generic Function: element-name OBJECT

Generic Function: (setf element-name) NEW-VALUE OBJECT

Package

cl-svg

Methods

Method: element-name (SVG-ELEMENT svg-element)

automatically generated reader method

Source

svg.lisp (file)

Method: (setf element-name) NEW-VALUE (SVG-ELEMENT svg-element)

automatically generated writer method

Source

svg.lisp (file)

Generic Function: get-attribute ELEMENT ATTRIBUTE

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: get-attribute (ELEMENT svg-element) ATTRIBUTE

Generic Function: has-attribute-p ELEMENT ATTRIBUTE

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: has-attribute-p (E svg-element) ATTRIBUTE

Generic Function: has-contents-p ELEMENT

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: has-contents-p (ELEMENT svg-element)

Generic Function: make-svg-element ELEMENT-NAME ATTRIBUTES

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: make-svg-element (ELEMENT (eql radial-gradient)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql linear-gradient)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql textarea)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql text)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql foreign-object)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql link)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql group)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql mask)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql pattern)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql marker)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql symbol)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql use)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql image)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql path)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql circle)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql ellipse)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql polygon)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql polyline)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql rect)) ATTRIBUTES

Method: make-svg-element (ELEMENT (eql line)) ATTRIBUTES

Generic Function: missing-attribute-message CONDITION

Generic Function: (setf missing-attribute-message) NEW-VALUE CONDITION

Package

cl-svg

Methods

Method: missing-attribute-message (CONDITION missing-attributes)

Method: (setf missing-attribute-message) NEW-VALUE (CONDITION missing-attributes)

Source

svg.lisp (file)

Generic Function: pp-xml-attr STREAM KEYWORD &optional COLON-P AT-P

This turns a keyword slot of a p-list into something XML
will recognize, in particular making the case correct. It is intended for ~/pp-xml-attr/ use in a FORMAT string.

Package

cl-svg

Source

format-xml.lisp (file)

Methods

Method: pp-xml-attr (S stream) (KW string) &optional COLON-P AT-P

Method: pp-xml-attr (S stream) (KW symbol) &optional COLON-P AT-P

Generic Function: pp-xml-value STREAM VALUE &optional COLON-P AT-P

This function exists entirely to restrain the floating
point representation in the SVG, which is bloated by pointless precision. *FLOAT-FORMAT-PRECISION* (2, by default) determines how many digits are printed after the decimal point.

Package

cl-svg

Source

format-xml.lisp (file)

Methods

Method: pp-xml-value (S stream) (VALUE float) &optional COLON-P AT-P

Method: pp-xml-value (S stream) (VALUE ratio) &optional COLON-P AT-P

Method: pp-xml-value (S stream) VALUE &optional COLON-P AT-P

Generic Function: push-attribute ELEMENT ATTRIBUTE VALUE

Package

cl-svg

Source

svg.lisp (file)

Methods

Method: push-attribute (E svg-element) ATTRIBUTE VALUE

Generic Function: svg-defs OBJECT

Generic Function: (setf svg-defs) NEW-VALUE OBJECT

Package

cl-svg

Methods

Method: svg-defs (SVG-TOPLEVEL svg-toplevel)

automatically generated reader method

Source

svg.lisp (file)

Method: (setf svg-defs) NEW-VALUE (SVG-TOPLEVEL svg-toplevel)

automatically generated writer method

Source

svg.lisp (file)

5.2.5 Classes

Class: svg-element ()

Package

cl-svg

Source

svg.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

svg-toplevel (class)

Direct methods

• initialize-instance (method)
• xlink-href (method)
• stream-out (method)
• add-class (method)
• add-transform (method)
• has-contents-p (method)
• add-namespace (method)
• get-attribute (method)
• has-attribute-p (method)
• push-attribute (method)
• add-element (method)
• add-element (method)
• element-id (method)
• element-id (method)
• element-attributes (method)
• element-attributes (method)
• element-contents (method)
• element-contents (method)
• element-name (method)
• element-name (method)

Direct slots

Slot: name

Type

string

Initargs

:name

Initform

(error "svg-element must have a name")

Readers

element-name (generic function)

Writers

(setf element-name) (generic function)

Slot: contents

Initform

(make-array 0 :adjustable t :fill-pointer 0)

Readers

element-contents (generic function)

Writers

(setf element-contents) (generic function)

Slot: attributes

Type

list

Initargs

:attributes

Readers

element-attributes (generic function)

Writers

(setf element-attributes) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions