package tyxml
TyXML is a library for building correct HTML and SVG documents
Install
dune-project
Dependency
Authors
Maintainers
Sources
tyxml-4.4.0.tbz
sha256=516394dd4a5c31726997c51d66aa31cacb91e3c46d4e16c7699130e204042530
sha512=d5f2187f8410524cec7a14b28e8950837070eb0b6571b015dd06076c2841eb7ccaffa86d5d2307eaf1950ee62f9fb926477dac01c870d9c1a2f525853cb44d0c
doc/tyxml.functor/Svg_f/Make_with_wrapped_functions/index.html
Module Svg_f.Make_with_wrapped_functionsSource
Similar to Make but with a custom set of wrapped functions.
Parameters
module Xml : Xml_sigs.Tmodule C : Svg_sigs.Wrapped_functions with module Xml = XmlSignature
SVG elements.
Element constructors are in section Elements. Most elements constructors are either nullary, unary or star, depending on the number of children they accept. Children are usually given as a list of elements. txt is used for text.
The type variable 'a is used to track the element's type. This allows the OCaml typechecker to check SVG validity.
Note that the concrete implementation of this type can vary. See Xml for details.
SVG attributes
Attribute constructors are in section Attributes and their name starts with a_. Attributes are given to elements with the ~a optional argument.
Similarly to elt, attributes use the OCaml type system to enforce Html validity.
In some cases, attributes have to be disambiguated. The max attribute has two version, a_fill and a_animation_fill, depending on the element. Such disambiguated attribute will contain the name of the associated element.
module Xml :
Xml_sigs.T
with type 'a W.t = 'a Xml.W.t
with type 'a W.tlist = 'a Xml.W.tlist
with type ('a, 'b) W.ft = ('a, 'b) Xml.W.ft
with type uri = Xml.uri
with type event_handler = Xml.event_handler
with type mouse_event_handler = Xml.mouse_event_handler
with type keyboard_event_handler = Xml.keyboard_event_handler
with type touch_event_handler = Xml.touch_event_handler
with type attrib = Xml.attrib
with type elt = Xml.eltUnderlying XML data-structure
wrap is a container for elements and values.
In most cases, 'a wrap = 'a. For R modules (in eliom or js_of_ocaml), It will be React.S.t.
list_wrap is a containre for list of elements.
In most cases, 'a list_wrap = 'a list. For R modules (in eliom or js_of_ocaml), It will be ReactiveData.RList.t.
A nullary element is an element that doesn't have any children.
A unary element is an element that have exactly one children.
A star element is an element that has any number of children, including zero.
Various information about SVG, such as the doctype, ...
Uri
Attributes
Source
val a_offset :
[< `Number of Svg_types.number | `Percentage of Svg_types.percentage ] wrap ->
[> `Offset ] attribSource
val a_kernelUnitLength :
Svg_types.number_optional_number wrap ->
[> `KernelUnitLength ] attribSource
val a_xlink_actuate :
[< `OnRequest | `OnLoad | `Other | `None ] wrap ->
[> `Xlink_actuate ] attribEvents
Javascript events
Javascript mouse events
Javascript touch events
Elements
Source
val title :
([< Svg_types.title_attr ],
[< Svg_types.title_content ],
[> Svg_types.title ])
unarySource
val symbol :
([< Svg_types.symbol_attr ],
[< Svg_types.symbol_content ],
[> Svg_types.symbol ])
starSource
val image :
([< Svg_types.image_attr ],
[< Svg_types.image_content ],
[> Svg_types.image ])
starSource
val switch :
([< Svg_types.switch_attr ],
[< Svg_types.switch_content ],
[> Svg_types.switch ])
starSource
val style :
([< Svg_types.style_attr ],
[< Svg_types.style_content ],
[> Svg_types.style ])
unarySource
val circle :
([< Svg_types.circle_attr ],
[< Svg_types.circle_content ],
[> Svg_types.circle ])
starSource
val ellipse :
([< Svg_types.ellipse_attr ],
[< Svg_types.ellipse_content ],
[> Svg_types.ellipse ])
starSource
val polyline :
([< Svg_types.polyline_attr ],
[< Svg_types.polyline_content ],
[> Svg_types.polyline ])
starSource
val polygon :
([< Svg_types.polygon_attr ],
[< Svg_types.polygon_content ],
[> Svg_types.polygon ])
starSource
val tspan :
([< Svg_types.tspan_attr ],
[< Svg_types.tspan_content ],
[> Svg_types.tspan ])
starSource
val textPath :
([< Svg_types.textpath_attr ],
[< Svg_types.textpath_content ],
[> Svg_types.textpath ])
starSource
val altGlyph :
([< Svg_types.altglyph_attr ],
[< Svg_types.altglyph_content ],
[> Svg_types.altglyph ])
unarySource
type altglyphdef_content = [ | `Ref of Svg_types.glyphref elt list| `Item of Svg_types.altglyphitem elt list
]Source
val altGlyphDef :
([< Svg_types.altglyphdef_attr ],
[< altglyphdef_content ],
[> Svg_types.altglyphdef ])
unarySource
val altGlyphItem :
([< Svg_types.altglyphitem_attr ],
[< Svg_types.altglyphitem_content ],
[> Svg_types.altglyphitem ])
starSource
val marker :
([< Svg_types.marker_attr ],
[< Svg_types.marker_content ],
[> Svg_types.marker ])
starSource
val color_profile :
([< Svg_types.colorprofile_attr ],
[< Svg_types.colorprofile_content ],
[> Svg_types.colorprofile ])
starSource
val linearGradient :
([< Svg_types.lineargradient_attr ],
[< Svg_types.lineargradient_content ],
[> Svg_types.lineargradient ])
starSource
val radialGradient :
([< Svg_types.radialgradient_attr ],
[< Svg_types.radialgradient_content ],
[> Svg_types.radialgradient ])
starSource
val pattern :
([< Svg_types.pattern_attr ],
[< Svg_types.pattern_content ],
[> Svg_types.pattern ])
starSource
val clipPath :
([< Svg_types.clippath_attr ],
[< Svg_types.clippath_content ],
[> Svg_types.clippath ])
starSource
val filter :
([< Svg_types.filter_attr ],
[< Svg_types.filter_content ],
[> Svg_types.filter ])
starSource
val feDistantLight :
([< Svg_types.fedistantlight_attr ],
[< Svg_types.fedistantlight_content ],
[> Svg_types.fedistantlight ])
starSource
val fePointLight :
([< Svg_types.fepointlight_attr ],
[< Svg_types.fepointlight_content ],
[> Svg_types.fepointlight ])
starSource
val feSpotLight :
([< Svg_types.fespotlight_attr ],
[< Svg_types.fespotlight_content ],
[> Svg_types.fespotlight ])
starSource
val feBlend :
([< Svg_types.feblend_attr ],
[< Svg_types.feblend_content ],
[> Svg_types.feblend ])
starSource
val feColorMatrix :
([< Svg_types.fecolormatrix_attr ],
[< Svg_types.fecolormatrix_content ],
[> Svg_types.fecolormatrix ])
starSource
val feComponentTransfer :
([< Svg_types.fecomponenttransfer_attr ],
[< Svg_types.fecomponenttransfer_content ],
[> Svg_types.fecomponenttransfer ])
starSource
val feFuncA :
([< Svg_types.fefunca_attr ],
[< Svg_types.fefunca_content ],
[> Svg_types.fefunca ])
starSource
val feFuncG :
([< Svg_types.fefuncg_attr ],
[< Svg_types.fefuncg_content ],
[> Svg_types.fefuncg ])
starSource
val feFuncB :
([< Svg_types.fefuncb_attr ],
[< Svg_types.fefuncb_content ],
[> Svg_types.fefuncb ])
starSource
val feFuncR :
([< Svg_types.fefuncr_attr ],
[< Svg_types.fefuncr_content ],
[> Svg_types.fefuncr ])
starSource
val feComposite :
([< Svg_types.fecomposite_attr ],
[< Svg_types.fecomposite_content ],
[> Svg_types.fecomposite ])
starSource
val feConvolveMatrix :
([< Svg_types.feconvolvematrix_attr ],
[< Svg_types.feconvolvematrix_content ],
[> Svg_types.feconvolvematrix ])
starSource
val feDiffuseLighting :
([< Svg_types.fediffuselighting_attr ],
[< Svg_types.fediffuselighting_content ],
[> Svg_types.fediffuselighting ])
starSource
val feDisplacementMap :
([< Svg_types.fedisplacementmap_attr ],
[< Svg_types.fedisplacementmap_content ],
[> Svg_types.fedisplacementmap ])
starSource
val feFlood :
([< Svg_types.feflood_attr ],
[< Svg_types.feflood_content ],
[> Svg_types.feflood ])
starSource
val feGaussianBlur :
([< Svg_types.fegaussianblur_attr ],
[< Svg_types.fegaussianblur_content ],
[> Svg_types.fegaussianblur ])
starSource
val feImage :
([< Svg_types.feimage_attr ],
[< Svg_types.feimage_content ],
[> Svg_types.feimage ])
starSource
val feMerge :
([< Svg_types.femerge_attr ],
[< Svg_types.femerge_content ],
[> Svg_types.femerge ])
starSource
val feMorphology :
([< Svg_types.femorphology_attr ],
[< Svg_types.femorphology_content ],
[> Svg_types.femorphology ])
starSource
val feOffset :
([< Svg_types.feoffset_attr ],
[< Svg_types.feoffset_content ],
[> Svg_types.feoffset ])
starSource
val feSpecularLighting :
([< Svg_types.fespecularlighting_attr ],
[< Svg_types.fespecularlighting_content ],
[> Svg_types.fespecularlighting ])
starSource
val feTile :
([< Svg_types.fetile_attr ],
[< Svg_types.fetile_content ],
[> Svg_types.fetile ])
starSource
val feTurbulence :
([< Svg_types.feturbulence_attr ],
[< Svg_types.feturbulence_content ],
[> Svg_types.feturbulence ])
starSource
val cursor :
([< Svg_types.cursor_attr ],
[< Svg_types.cursor_content ],
[> Svg_types.cursor ])
starSource
val script :
([< Svg_types.script_attr ],
[< Svg_types.script_content ],
[> Svg_types.script ])
unarySource
val animation :
([< Svg_types.animation_attr ],
[< Svg_types.animation_content ],
[> Svg_types.animation ])
starSource
val animateMotion :
([< Svg_types.animatemotion_attr ],
[< Svg_types.animatemotion_content ],
[> Svg_types.animatemotion ])
starSource
val mpath :
([< Svg_types.mpath_attr ],
[< Svg_types.mpath_content ],
[> Svg_types.mpath ])
starSource
val animateColor :
([< Svg_types.animatecolor_attr ],
[< Svg_types.animatecolor_content ],
[> Svg_types.animatecolor ])
starSource
val animateTransform :
([< Svg_types.animatetransform_attr ],
[< Svg_types.animatetransform_content ],
[> Svg_types.animatetransform ])
starSource
val glyph :
([< Svg_types.glyph_attr ],
[< Svg_types.glyph_content ],
[> Svg_types.glyph ])
starSource
val missing_glyph :
([< Svg_types.missingglyph_attr ],
[< Svg_types.missingglyph_content ],
[> Svg_types.missingglyph ])
starSource
val font_face_src :
([< Svg_types.font_face_src_attr ],
[< Svg_types.font_face_src_content ],
[> Svg_types.font_face_src ])
starSource
val font_face_uri :
([< Svg_types.font_face_uri_attr ],
[< Svg_types.font_face_uri_content ],
[> Svg_types.font_face_uri ])
starSource
val font_face_format :
([< Svg_types.font_face_format_attr ], [> Svg_types.font_face_format ])
nullarySource
val font_face_name :
([< Svg_types.font_face_name_attr ], [> Svg_types.font_face_name ]) nullarySource
val metadata :
?a:Svg_types.metadata_attr attrib list ->
Xml.elt list_wrap ->
[> Svg_types.metadata ] eltSource
val foreignObject :
?a:Svg_types.foreignobject_attr attrib list ->
Xml.elt list_wrap ->
[> Svg_types.foreignobject ] eltDeprecated
Conversion with untyped representation
WARNING: These functions do not ensure HTML or SVG validity! You should always explicitly given an appropriate type to the output.
import signal converts the given XML signal into Tyxml elements. It can be used with HTML and SVG parsing libraries, such as Markup.