package tyxml

  1. Overview
  2. Docs

Like the Svg_f.Make functor, but allows to wrap elements inside a monad described by Xml_wrap.T. See the functorial interface documentation for more details.

Parameters

module W : Xml_wrap.T
module Xml : Xml_sigs.Wrapped with type 'a wrap = 'a W.t and type 'a list_wrap = 'a W.tlist

Signature

module Xml : Xml_sigs.Wrapped 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 attrib = Xml.attrib with type elt = Xml.elt with type 'a wrap = 'a W.t with type 'a list_wrap = 'a W.tlist
type uri = Xml.uri
val string_of_uri : uri -> string
val uri_of_string : string -> uri

Abstraction over XML's types

type +'a attrib = Xml.attrib
type 'a wrap = 'a W.t
type 'a list_wrap = 'a W.tlist
type +'a elt = Xml.elt
type ('a, 'b) nullary = ?a:'a attrib list -> unit -> 'b elt
type ('a, 'b, 'c) unary = ?a:'a attrib list -> 'b elt wrap -> 'c elt
type ('a, 'b, 'c) star = ?a:'a attrib list -> 'b elt list_wrap -> 'c elt
type altglyphdef_content = [
  1. | `Ref of Svg_types.glyphref elt list
  2. | `Item of Svg_types.altglyphitem elt list
]
val pcdata : string wrap -> [> `PCDATA ] elt

attributes

val a_version : string wrap -> [> `Version ] attrib
val a_baseprofile : string wrap -> [> `BaseProfile ] attrib
val a_x : Svg_types.coord wrap -> [> `X ] attrib
val a_y : Svg_types.coord wrap -> [> `Y ] attrib
val a_width : Svg_types.Unit.length wrap -> [> `Width ] attrib
val a_height : Svg_types.Unit.length wrap -> [> `Height ] attrib
val a_preserveaspectratio : string wrap -> [> `PreserveAspectRatio ] attrib
val a_contentscripttype : string wrap -> [> `ContentScriptType ] attrib
val a_contentstyletype : string wrap -> [> `ContentStyleType ] attrib
val a_zoomAndPan : [< `Disable | `Magnify ] wrap -> [> `ZoomAndSpan ] attrib
val a_requiredfeatures : Svg_types.spacestrings wrap -> [> `RequiredFeatures ] attrib
val a_requiredextensions : Svg_types.spacestrings wrap -> [> `RequiredExtension ] attrib
val a_systemlanguage : Svg_types.commastrings wrap -> [> `SystemLanguage ] attrib
val a_externalressourcesrequired : bool wrap -> [> `ExternalRessourcesRequired ] attrib
val a_id : string wrap -> [> `Id ] attrib
val a_xml_base : Svg_types.iri wrap -> [> `Xml_Base ] attrib
val a_xml_lang : Svg_types.iri wrap -> [> `Xml_Lang ] attrib
val a_xml_space : [< `Default | `Preserve ] wrap -> [> `Xml_Space ] attrib
val a_type : string wrap -> [> `Type ] attrib
val a_media : Svg_types.commastrings wrap -> [> `Media ] attrib
val a_title : string wrap -> [> `Title ] attrib
val a_class : Svg_types.spacestrings wrap -> [> `Class ] attrib
val a_style : string wrap -> [> `Style ] attrib
val a_transform : Svg_types.transform wrap -> [> `Transform ] attrib
val a_viewbox : Svg_types.fourfloats wrap -> [> `ViewBox ] attrib
val a_d : string wrap -> [> `D ] attrib
val a_pathlength : float wrap -> [> `PathLength ] attrib
val a_rx : Svg_types.Unit.length wrap -> [> `Rx ] attrib
val a_ry : Svg_types.Unit.length wrap -> [> `Ry ] attrib
val a_cx : Svg_types.Unit.length wrap -> [> `Cx ] attrib
val a_cy : Svg_types.Unit.length wrap -> [> `Cy ] attrib
val a_r : Svg_types.Unit.length wrap -> [> `R ] attrib
val a_x1 : Svg_types.coord wrap -> [> `X1 ] attrib
val a_y1 : Svg_types.coord wrap -> [> `Y1 ] attrib
val a_x2 : Svg_types.coord wrap -> [> `X2 ] attrib
val a_y2 : Svg_types.coord wrap -> [> `Y2 ] attrib
val a_points : Svg_types.coords wrap -> [> `Points ] attrib
val a_x_list : Svg_types.lengths wrap -> [> `X_list ] attrib
val a_y_list : Svg_types.lengths wrap -> [> `Y_list ] attrib
val a_dx : Svg_types.number wrap -> [> `Dx ] attrib
val a_dy : Svg_types.number wrap -> [> `Dy ] attrib
val a_dx_list : Svg_types.lengths wrap -> [> `Dx_list ] attrib
val a_dy_list : Svg_types.lengths wrap -> [> `Dy_list ] attrib
val a_lengthadjust : [< `Spacing | `SpacingAndGlyphs ] wrap -> [> `LengthAdjust ] attrib
val a_textlength : Svg_types.Unit.length wrap -> [> `TextLength ] attrib
val a_rotate : Svg_types.numbers wrap -> [> `Rotate ] attrib
val a_startoffset : Svg_types.Unit.length wrap -> [> `StartOffset ] attrib
val a_method : [< `Align | `Stretch ] wrap -> [> `Method ] attrib
val a_spacing : [< `Auto | `Exact ] wrap -> [> `Spacing ] attrib
val a_glyphref : string wrap -> [> `GlyphRef ] attrib
val a_format : string wrap -> [> `Format ] attrib
val a_markerunits : [< `StrokeWidth | `UserSpaceOnUse ] wrap -> [> `MarkerUnits ] attrib
val a_refx : Svg_types.coord wrap -> [> `RefX ] attrib
val a_refy : Svg_types.coord wrap -> [> `RefY ] attrib
val a_markerwidth : Svg_types.Unit.length wrap -> [> `MarkerWidth ] attrib
val a_markerheight : Svg_types.Unit.length wrap -> [> `MarkerHeight ] attrib
val a_orient : [< `Auto | `Angle of Svg_types.Unit.angle ] wrap -> [> `Orient ] attrib
val a_local : string wrap -> [> `Local ] attrib
val a_renderingindent : [< `Auto | `Perceptual | `Relative_colorimetric | `Saturation | `Absolute_colorimetric ] wrap -> [> `Rendering_Indent ] attrib
val a_gradientunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [ `GradientUnits ] attrib
val a_gradienttransform : Svg_types.transforms wrap -> [> `Gradient_Transform ] attrib
val a_spreadmethod : [< `Pad | `Reflect | `Repeat ] wrap -> [> `SpreadMethod ] attrib
val a_fx : Svg_types.coord wrap -> [> `Fx ] attrib
val a_fy : Svg_types.coord wrap -> [> `Fy ] attrib
val a_offset : [< `Number of Svg_types.number | `Percentage of Svg_types.percentage ] wrap -> [> `Offset ] attrib
val a_patternunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [> `PatternUnits ] attrib
val a_patterncontentunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [> `PatternContentUnits ] attrib
val a_patterntransform : Svg_types.transforms wrap -> [> `PatternTransform ] attrib
val a_clippathunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [> `ClipPathUnits ] attrib
val a_maskunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [> `MaskUnits ] attrib
val a_maskcontentunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [> `MaskContentUnits ] attrib
val a_primitiveunits : [< `UserSpaceOnUse | `ObjectBoundingBox ] wrap -> [> `PrimitiveUnits ] attrib
val a_filterres : Svg_types.number_optional_number wrap -> [> `FilterResUnits ] attrib
val a_result : string wrap -> [> `Result ] attrib
val a_in : [< `SourceGraphic | `SourceAlpha | `BackgroundImage | `BackgroundAlpha | `FillPaint | `StrokePaint | `Ref of string ] wrap -> [> `In ] attrib
val a_in2 : [< `SourceGraphic | `SourceAlpha | `BackgroundImage | `BackgroundAlpha | `FillPaint | `StrokePaint | `Ref of string ] wrap -> [> `In2 ] attrib
val a_aizmuth : float wrap -> [> `Azimuth ] attrib
val a_elevation : float wrap -> [> `Elevation ] attrib
val a_pointatx : float wrap -> [> `PointsAtX ] attrib
val a_pointaty : float wrap -> [> `PointsAtY ] attrib
val a_pointatz : float wrap -> [> `PointsAtZ ] attrib
val a_specularexponent : float wrap -> [> `SpecularExponent ] attrib
val a_specularconstant : float wrap -> [> `SpecularConstant ] attrib
val a_limitingconeangle : float wrap -> [> `LimitingConeAngle ] attrib
val a_mode : [< `Normal | `Multiply | `Screen | `Darken | `Lighten ] wrap -> [> `Mode ] attrib
val a_typefecolor : [< `Matrix | `Saturate | `HueRotate | `LuminanceToAlpha ] wrap -> [> `Typefecolor ] attrib
val a_values : Svg_types.numbers wrap -> [> `Values ] attrib
val a_transferttype : [< `Identity | `Table | `Discrete | `Linear | `Gamma ] wrap -> [> `Typetransfert ] attrib
val a_tablevalues : Svg_types.numbers wrap -> [> `TableValues ] attrib
val a_intercept : Svg_types.number wrap -> [> `Intercept ] attrib
val a_amplitude : Svg_types.number wrap -> [> `Amplitude ] attrib
val a_exponent : Svg_types.number wrap -> [> `Exponent ] attrib
val a_offsettransfer : Svg_types.number wrap -> [> `Offsettransfer ] attrib
val a_operator : [< `Over | `In | `Out | `Atop | `Xor | `Arithmetic ] wrap -> [> `Operator ] attrib
val a_k1 : Svg_types.number wrap -> [> `K1 ] attrib
val a_k2 : Svg_types.number wrap -> [> `K2 ] attrib
val a_k3 : Svg_types.number wrap -> [> `K3 ] attrib
val a_k4 : Svg_types.number wrap -> [> `K4 ] attrib
val a_order : Svg_types.number_optional_number wrap -> [> `Order ] attrib
val a_kernelmatrix : Svg_types.numbers wrap -> [> `KernelMatrix ] attrib
val a_divisor : Svg_types.number wrap -> [> `Divisor ] attrib
val a_bias : Svg_types.number wrap -> [> `Bias ] attrib
val a_kernelunitlength : Svg_types.number_optional_number wrap -> [> `KernelUnitLength ] attrib
val a_targetX : int wrap -> [> `TargetX ] attrib
val a_targetY : int wrap -> [> `TargetY ] attrib
val a_edgemode : [< `Duplicate | `Wrap | `None ] wrap -> [> `TargetY ] attrib
val a_preservealpha : bool wrap -> [> `TargetY ] attrib
val a_surfacescale : Svg_types.number wrap -> [> `SurfaceScale ] attrib
val a_diffuseconstant : Svg_types.number wrap -> [> `DiffuseConstant ] attrib
val a_scale : Svg_types.number wrap -> [> `Scale ] attrib
val a_xchannelselector : [< `R | `G | `B | `A ] wrap -> [> `XChannelSelector ] attrib
val a_ychannelselector : [< `R | `G | `B | `A ] wrap -> [> `YChannelSelector ] attrib
val a_stddeviation : Svg_types.number_optional_number wrap -> [> `StdDeviation ] attrib
val a_operatormorphology : [< `Erode | `Dilate ] wrap -> [> `OperatorMorphology ] attrib
val a_radius : Svg_types.number_optional_number wrap -> [> `Radius ] attrib
val a_basefrenquency : Svg_types.number_optional_number wrap -> [> `BaseFrequency ] attrib
val a_numoctaves : int wrap -> [> `NumOctaves ] attrib
val a_seed : Svg_types.number wrap -> [> `Seed ] attrib
val a_stitchtiles : [< `Stitch | `NoStitch ] wrap -> [> `StitchTiles ] attrib
val a_stitchtype : [< `FractalNoise | `Turbulence ] wrap -> [> `TypeStitch ] attrib
val a_xlinkshow : [< `New | `Replace ] wrap -> [> `Xlink_show ] attrib
val a_xlinkactuate : [< `OnRequest | `OnLoad | `Other | `None ] wrap -> [> `Xlink_actuate ] attrib
val a_target : string wrap -> [> `Xlink_target ] attrib
val a_viewtarget : string wrap -> [> `ViewTarget ] attrib
val a_attributename : string wrap -> [> `AttributeName ] attrib
val a_attributetype : [< `CSS | `XML | `Auto ] wrap -> [> `AttributeType ] attrib
val a_begin : string wrap -> [> `Begin ] attrib
val a_dur : string wrap -> [> `Dur ] attrib
val a_min : string wrap -> [> `Min ] attrib
val a_max : string wrap -> [> `Max ] attrib
val a_restart : [< `Always | `WhenNotActive | `Never ] wrap -> [> `Restart ] attrib
val a_repeatcount : string wrap -> [> `RepeatCount ] attrib
val a_repeatdur : string wrap -> [> `RepeatDur ] attrib
val a_fill : Svg_types.paint wrap -> [> `Fill ] attrib
val a_fill_animation : [< `Freeze | `Remove ] wrap -> [> `Fill_Animation ] attrib
val a_calcmode : [< `Discrete | `Linear | `Paced | `Spline ] wrap -> [> `CalcMode ] attrib
val a_values_anim : Svg_types.strings wrap -> [> `Valuesanim ] attrib
val a_keytimes : Svg_types.strings wrap -> [> `KeyTimes ] attrib
val a_keysplines : Svg_types.strings wrap -> [> `KeySplines ] attrib
val a_from : string wrap -> [> `From ] attrib
val a_to : string wrap -> [> `To ] attrib
val a_by : string wrap -> [> `By ] attrib
val a_additive : [< `Replace | `Sum ] wrap -> [> `Additive ] attrib
val a_accumulate : [< `None | `Sum ] wrap -> [> `Accumulate ] attrib
val a_keypoints : Svg_types.numbers_semicolon wrap -> [> `KeyPoints ] attrib
val a_path : string wrap -> [> `Path ] attrib
val a_typeanimatecolor : [ `Translate | `Scale | `Rotate | `SkewX | `SkewY ] wrap -> [ `Typeanimatecolor ] attrib
val a_horiz_origin_x : Svg_types.number wrap -> [> `Horizoriginx ] attrib
val a_horiz_origin_y : Svg_types.number wrap -> [> `Horizoriginy ] attrib
val a_horiz_adv_x : Svg_types.number wrap -> [> `Horizadvx ] attrib
val a_vert_origin_x : Svg_types.number wrap -> [> `Vertoriginx ] attrib
val a_vert_origin_y : Svg_types.number wrap -> [> `Vertoriginy ] attrib
val a_vert_adv_y : Svg_types.number wrap -> [> `Vertadvy ] attrib
val a_unicode : string wrap -> [> `Unicode ] attrib
val a_glyphname : string wrap -> [> `glyphname ] attrib
val a_orientation : [< `H | `V ] wrap -> [> `Orientation ] attrib
val a_arabicform : [< `Initial | `Medial | `Terminal | `Isolated ] wrap -> [> `Arabicform ] attrib
val a_lang : string wrap -> [> `Lang ] attrib
val a_u1 : string wrap -> [> `U1 ] attrib
val a_u2 : string wrap -> [> `U2 ] attrib
val a_g1 : string wrap -> [> `G1 ] attrib
val a_g2 : string wrap -> [> `G2 ] attrib
val a_k : string wrap -> [> `K ] attrib
val a_fontfamily : string wrap -> [> `Font_Family ] attrib
val a_fontstyle : string wrap -> [> `Font_Style ] attrib
val a_fontvariant : string wrap -> [> `Font_Variant ] attrib
val a_fontweight : string wrap -> [> `Font_Weight ] attrib
val a_fontstretch : string wrap -> [> `Font_Stretch ] attrib
val a_fontsize : string wrap -> [> `Font_Size ] attrib
val a_unicoderange : string wrap -> [> `UnicodeRange ] attrib
val a_unitsperem : string wrap -> [> `UnitsPerEm ] attrib
val a_stemv : Svg_types.number wrap -> [> `Stemv ] attrib
val a_stemh : Svg_types.number wrap -> [> `Stemh ] attrib
val a_slope : Svg_types.number wrap -> [> `Slope ] attrib
val a_capheight : Svg_types.number wrap -> [> `CapHeight ] attrib
val a_xheight : Svg_types.number wrap -> [> `XHeight ] attrib
val a_accentheight : Svg_types.number wrap -> [> `AccentHeight ] attrib
val a_ascent : Svg_types.number wrap -> [> `Ascent ] attrib
val a_widths : string wrap -> [> `Widths ] attrib
val a_bbox : string wrap -> [> `Bbox ] attrib
val a_ideographic : Svg_types.number wrap -> [> `Ideographic ] attrib
val a_alphabetic : Svg_types.number wrap -> [> `Alphabetic ] attrib
val a_mathematical : Svg_types.number wrap -> [> `Mathematical ] attrib
val a_hanging : Svg_types.number wrap -> [> `Hanging ] attrib
val a_videographic : Svg_types.number wrap -> [> `VIdeographic ] attrib
val a_valphabetic : Svg_types.number wrap -> [> `VAlphabetic ] attrib
val a_vmathematical : Svg_types.number wrap -> [> `VMathematical ] attrib
val a_vhanging : Svg_types.number wrap -> [> `VHanging ] attrib
val a_underlineposition : Svg_types.number wrap -> [> `UnderlinePosition ] attrib
val a_underlinethickness : Svg_types.number wrap -> [> `UnderlineThickness ] attrib
val a_strikethroughposition : Svg_types.number wrap -> [> `StrikethroughPosition ] attrib
val a_strikethroughthickness : Svg_types.number wrap -> [> `StrikethroughThickness ] attrib
val a_overlineposition : Svg_types.number wrap -> [> `OverlinePosition ] attrib
val a_overlinethickness : Svg_types.number wrap -> [> `OverlineThickness ] attrib
val a_string : string wrap -> [> `String ] attrib
val a_name : string wrap -> [> `Name ] attrib

Javascript events

val a_onabort : Xml.event_handler -> [> `OnAbort ] attrib
val a_onactivate : Xml.event_handler -> [> `OnActivate ] attrib
val a_onbegin : Xml.event_handler -> [> `OnBegin ] attrib
val a_onend : Xml.event_handler -> [> `OnEnd ] attrib
val a_onerror : Xml.event_handler -> [> `OnError ] attrib
val a_onfocusin : Xml.event_handler -> [> `OnFocusIn ] attrib
val a_onfocusout : Xml.event_handler -> [> `OnFocusOut ] attrib
val a_onload : Xml.event_handler -> [> `OnLoad ] attrib
val a_onrepeat : Xml.event_handler -> [> `OnRepeat ] attrib
val a_onresize : Xml.event_handler -> [> `OnResize ] attrib
val a_onscroll : Xml.event_handler -> [> `OnScroll ] attrib
val a_onunload : Xml.event_handler -> [> `OnUnload ] attrib
val a_onzoom : Xml.event_handler -> [> `OnZoom ] attrib

Javascript mouse events

val a_onclick : Xml.mouse_event_handler -> [> `OnClick ] attrib
val a_onmousedown : Xml.mouse_event_handler -> [> `OnMouseDown ] attrib
val a_onmouseup : Xml.mouse_event_handler -> [> `OnMouseUp ] attrib
val a_onmouseover : Xml.mouse_event_handler -> [> `OnMouseOver ] attrib
val a_onmouseout : Xml.mouse_event_handler -> [> `OnMouseOut ] attrib
val a_onmousemove : Xml.mouse_event_handler -> [> `OnMouseMove ] attrib
val a_stopcolor : Svg_types.color wrap -> [> `Stop_Color ] attrib
val a_stopopacity : Svg_types.number wrap -> [> `Stop_Opacity ] attrib
val a_stroke : Svg_types.paint wrap -> [> `Stroke ] attrib
val a_strokewidth : Svg_types.Unit.length wrap -> [> `Stroke_Width ] attrib
val a_strokelinecap : [< `Butt | `Round | `Square ] wrap -> [> `Stroke_Linecap ] attrib
val a_strokelinejoin : [< `Miter | `Round | `Bever ] wrap -> [> `Stroke_Linejoin ] attrib
val a_strokemiterlimit : float wrap -> [> `Stroke_Miterlimit ] attrib
val a_strokedasharray : Svg_types.Unit.length list wrap -> [> `Stroke_Dasharray ] attrib
val a_strokedashoffset : Svg_types.Unit.length wrap -> [> `Stroke_Dashoffset ] attrib
val a_strokeopacity : float wrap -> [> `Stroke_Opacity ] attrib

Elements

val tot : Xml.elt -> 'a elt
val totl : Xml.elt list -> 'a elt list
val toelt : 'a elt -> Xml.elt
val toeltl : 'a elt list -> Xml.elt list
val to_xmlattribs : 'a attrib list -> Xml.attrib list
val to_attrib : Xml.attrib -> 'a attrib
module Unsafe : sig ... end

Unsafe features. Warning using this module can break validity and may introduce security problems like code injection. Use it with care.

...

type doc = [ `Svg ] elt
val doc_toelt : doc -> Xml.elt
OCaml

Innovation. Community. Security.