package tyxml
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=bfeb673c6b4e120a4eca4c48448add47dc3f8d02c2b40f63ffdccc4e91c902dd
sha512=69750eeaf467014282087bf9628f3278f3e5f00f4c7400358750d208664cfc3f79a5cba16767d2935e53477d1a6862fe08c5b801b69052ec12e09d1a93a5e9b4
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
val a_offset :
[< `Number of Svg_types.number | `Percentage of Svg_types.percentage ] wrap ->
[> `Offset ] attribval a_kernelUnitLength :
Svg_types.number_optional_number wrap ->
[> `KernelUnitLength ] attribval a_xlink_actuate :
[< `OnRequest | `OnLoad | `Other | `None ] wrap ->
[> `Xlink_actuate ] attribEvents
Javascript events
Javascript mouse events
Javascript touch events
Elements
val title :
([< Svg_types.title_attr ],
[< Svg_types.title_content ],
[> Svg_types.title ])
unaryval symbol :
([< Svg_types.symbol_attr ],
[< Svg_types.symbol_content ],
[> Svg_types.symbol ])
starval image :
([< Svg_types.image_attr ],
[< Svg_types.image_content ],
[> Svg_types.image ])
starval switch :
([< Svg_types.switch_attr ],
[< Svg_types.switch_content ],
[> Svg_types.switch ])
starval style :
([< Svg_types.style_attr ],
[< Svg_types.style_content ],
[> Svg_types.style ])
unaryval circle :
([< Svg_types.circle_attr ],
[< Svg_types.circle_content ],
[> Svg_types.circle ])
starval ellipse :
([< Svg_types.ellipse_attr ],
[< Svg_types.ellipse_content ],
[> Svg_types.ellipse ])
starval polyline :
([< Svg_types.polyline_attr ],
[< Svg_types.polyline_content ],
[> Svg_types.polyline ])
starval polygon :
([< Svg_types.polygon_attr ],
[< Svg_types.polygon_content ],
[> Svg_types.polygon ])
starval tspan :
([< Svg_types.tspan_attr ],
[< Svg_types.tspan_content ],
[> Svg_types.tspan ])
starval textPath :
([< Svg_types.textpath_attr ],
[< Svg_types.textpath_content ],
[> Svg_types.textpath ])
starval altGlyph :
([< Svg_types.altglyph_attr ],
[< Svg_types.altglyph_content ],
[> Svg_types.altglyph ])
unarytype altglyphdef_content = [ | `Ref of Svg_types.glyphref elt list| `Item of Svg_types.altglyphitem elt list
]val altGlyphDef :
([< Svg_types.altglyphdef_attr ],
[< altglyphdef_content ],
[> Svg_types.altglyphdef ])
unaryval altGlyphItem :
([< Svg_types.altglyphitem_attr ],
[< Svg_types.altglyphitem_content ],
[> Svg_types.altglyphitem ])
starval marker :
([< Svg_types.marker_attr ],
[< Svg_types.marker_content ],
[> Svg_types.marker ])
starval color_profile :
([< Svg_types.colorprofile_attr ],
[< Svg_types.colorprofile_content ],
[> Svg_types.colorprofile ])
starval linearGradient :
([< Svg_types.lineargradient_attr ],
[< Svg_types.lineargradient_content ],
[> Svg_types.lineargradient ])
starval radialGradient :
([< Svg_types.radialgradient_attr ],
[< Svg_types.radialgradient_content ],
[> Svg_types.radialgradient ])
starval pattern :
([< Svg_types.pattern_attr ],
[< Svg_types.pattern_content ],
[> Svg_types.pattern ])
starval clipPath :
([< Svg_types.clippath_attr ],
[< Svg_types.clippath_content ],
[> Svg_types.clippath ])
starval filter :
([< Svg_types.filter_attr ],
[< Svg_types.filter_content ],
[> Svg_types.filter ])
starval feDistantLight :
([< Svg_types.fedistantlight_attr ],
[< Svg_types.fedistantlight_content ],
[> Svg_types.fedistantlight ])
starval fePointLight :
([< Svg_types.fepointlight_attr ],
[< Svg_types.fepointlight_content ],
[> Svg_types.fepointlight ])
starval feSpotLight :
([< Svg_types.fespotlight_attr ],
[< Svg_types.fespotlight_content ],
[> Svg_types.fespotlight ])
starval feBlend :
([< Svg_types.feblend_attr ],
[< Svg_types.feblend_content ],
[> Svg_types.feblend ])
starval feColorMatrix :
([< Svg_types.fecolormatrix_attr ],
[< Svg_types.fecolormatrix_content ],
[> Svg_types.fecolormatrix ])
starval feComponentTransfer :
([< Svg_types.fecomponenttransfer_attr ],
[< Svg_types.fecomponenttransfer_content ],
[> Svg_types.fecomponenttransfer ])
starval feFuncA :
([< Svg_types.fefunca_attr ],
[< Svg_types.fefunca_content ],
[> Svg_types.fefunca ])
starval feFuncG :
([< Svg_types.fefuncg_attr ],
[< Svg_types.fefuncg_content ],
[> Svg_types.fefuncg ])
starval feFuncB :
([< Svg_types.fefuncb_attr ],
[< Svg_types.fefuncb_content ],
[> Svg_types.fefuncb ])
starval feFuncR :
([< Svg_types.fefuncr_attr ],
[< Svg_types.fefuncr_content ],
[> Svg_types.fefuncr ])
starval feComposite :
([< Svg_types.fecomposite_attr ],
[< Svg_types.fecomposite_content ],
[> Svg_types.fecomposite ])
starval feConvolveMatrix :
([< Svg_types.feconvolvematrix_attr ],
[< Svg_types.feconvolvematrix_content ],
[> Svg_types.feconvolvematrix ])
starval feDiffuseLighting :
([< Svg_types.fediffuselighting_attr ],
[< Svg_types.fediffuselighting_content ],
[> Svg_types.fediffuselighting ])
starval feDisplacementMap :
([< Svg_types.fedisplacementmap_attr ],
[< Svg_types.fedisplacementmap_content ],
[> Svg_types.fedisplacementmap ])
starval feFlood :
([< Svg_types.feflood_attr ],
[< Svg_types.feflood_content ],
[> Svg_types.feflood ])
starval feGaussianBlur :
([< Svg_types.fegaussianblur_attr ],
[< Svg_types.fegaussianblur_content ],
[> Svg_types.fegaussianblur ])
starval feImage :
([< Svg_types.feimage_attr ],
[< Svg_types.feimage_content ],
[> Svg_types.feimage ])
starval feMerge :
([< Svg_types.femerge_attr ],
[< Svg_types.femerge_content ],
[> Svg_types.femerge ])
starval feMorphology :
([< Svg_types.femorphology_attr ],
[< Svg_types.femorphology_content ],
[> Svg_types.femorphology ])
starval feOffset :
([< Svg_types.feoffset_attr ],
[< Svg_types.feoffset_content ],
[> Svg_types.feoffset ])
starval feSpecularLighting :
([< Svg_types.fespecularlighting_attr ],
[< Svg_types.fespecularlighting_content ],
[> Svg_types.fespecularlighting ])
starval feTile :
([< Svg_types.fetile_attr ],
[< Svg_types.fetile_content ],
[> Svg_types.fetile ])
starval feTurbulence :
([< Svg_types.feturbulence_attr ],
[< Svg_types.feturbulence_content ],
[> Svg_types.feturbulence ])
starval cursor :
([< Svg_types.cursor_attr ],
[< Svg_types.cursor_content ],
[> Svg_types.cursor ])
starval script :
([< Svg_types.script_attr ],
[< Svg_types.script_content ],
[> Svg_types.script ])
unaryval animate :
([< Svg_types.animate_attr ],
[< Svg_types.animate_content ],
[> Svg_types.animate ])
starval animateMotion :
([< Svg_types.animatemotion_attr ],
[< Svg_types.animatemotion_content ],
[> Svg_types.animatemotion ])
starval mpath :
([< Svg_types.mpath_attr ],
[< Svg_types.mpath_content ],
[> Svg_types.mpath ])
starval animateColor :
([< Svg_types.animatecolor_attr ],
[< Svg_types.animatecolor_content ],
[> Svg_types.animatecolor ])
starval animateTransform :
([< Svg_types.animatetransform_attr ],
[< Svg_types.animatetransform_content ],
[> Svg_types.animatetransform ])
starval glyph :
([< Svg_types.glyph_attr ],
[< Svg_types.glyph_content ],
[> Svg_types.glyph ])
starval missing_glyph :
([< Svg_types.missingglyph_attr ],
[< Svg_types.missingglyph_content ],
[> Svg_types.missingglyph ])
starval font_face_src :
([< Svg_types.font_face_src_attr ],
[< Svg_types.font_face_src_content ],
[> Svg_types.font_face_src ])
starval font_face_uri :
([< Svg_types.font_face_uri_attr ],
[< Svg_types.font_face_uri_content ],
[> Svg_types.font_face_uri ])
starval font_face_format :
([< Svg_types.font_face_format_attr ], [> Svg_types.font_face_format ])
nullaryval font_face_name :
([< Svg_types.font_face_name_attr ], [> Svg_types.font_face_name ]) nullaryval metadata :
?a:Svg_types.metadata_attr attrib list ->
Xml.elt list_wrap ->
[> Svg_types.metadata ] eltval foreignObject :
?a:Svg_types.foreignobject_attr attrib list ->
Xml.elt list_wrap ->
[> Svg_types.foreignobject ] eltDeprecated
val animation :
([< Svg_types.animate_attr ],
[< Svg_types.animate_content ],
[> Svg_types.animate ])
starConversion 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.