RiverSoftAVG Products Help

TSVGPenHack

Represents type TSVGPenHack.

MAX_SVGIMAGE_SIZE

Defines the maximum SVG bitmap to create. This variable is used by the ScaleSize function to constrain the maximum size of a bitmap.

CleanArray(TStringDynArray)

Returns the input string array "cleaned" up, where all array elements that are empty when trimmed are deleted

CleanText(String)

Returns the input string "cleaned" up, with all extra spaces over one removed (e.g., CleanText(' Hello How are you ') = 'Hello How are you'

DrawBitmapWrapped(TSVGCanvas,TSVGBitmap,TSVGRect,TSVGImageWrapMode,Single)

Draws the specified Bitmap on to the Canvas at the specified rectangle using the wrap mode and opacity

GetSVGAlign(String)

Returns the align that matches the string

GetSVGAlignmentBaseline(String)

Returns the alignment baseline that matches the string

GetSVGBaselineShift(String)

Returns the baseline shift that matches the string

GetSVGColorInterpolation(String)

Returns the color interpolation that matches the string

GetSVGColorRendering(String)

Returns the color rendering that matches the string

GetSVGCursor(String)

Overloaded. Returns the cursor type that matches the string

GetSVGCursor(TCursor)

Overloaded. Returns the SVG cursor type that is equivalent to the TCursor input type

GetSVGDirection(String)

Returns the direction that matches the string

GetSVGDominantBaseline(String)

Returns the dominant baseline that matches the string

GetSVGElementType(String)

Returns the SVG element type that matches the string

GetSVGFeatureSupport(String)

Returns the SVG feature that matches the string

GetSVGFillRule(String)

Returns the fill rule that matches the string

GetSVGFontAbsSize(Single)

Overloaded. Returns the absolute font size type that matches the value

GetSVGFontAbsSize(String)

Overloaded. Returns the absolute font size type that matches the string

GetSVGFontFamily(String)

Returns the generic font family that matches the string

GetSVGFontStyle(String)

Returns the font style type that matches the string

GetSVGFontVariant(String)

Returns the font variant type that matches the string

GetSVGFontWeight(String)

Returns the font weight type that matches the string

GetSVGGenericFontFamily(String)

Returns the generic font family type that matches the string

GetSVGGlyphOrientationHorizontal(String)

Returns the horizontal glyph orientation that matches the string. The value should equal 0deg, 90deg, 180deg, or 270deg (with or without the 'deg'). The value of the angle is restricted to 0, 90, 180, and 270 degrees. The value is rounded to the closest of the permitted values. A value of 0deg indicates that all glyphs are set with the top of the glyphs oriented towards the reference orientation (usually up with left to right text)

GetSVGGlyphOrientationVertical(String)

Returns the vertrical glyph orientation that matches the string. The value should equal 0deg, 90deg, 180deg, 270deg, or auto (with or without the 'deg'). The value of the angle is restricted to 0, 90, 180, and 270 degrees. The value is rounded to the closest of the permitted values. A value of 0deg indicates that all glyphs are set with the top of the glyphs oriented towards the reference orientation (usually up with left to right text). This property is applied only to text written in a vertical ‘writing-mode’.

GetSVGGradientSpread(String)

Returns the gradient spread type that matches the string

GetSVGGradientUnit(String)

Returns the gradient unit type that matches the string

GetSVGMarkerUnit(String)

Returns the marker unit type that matches the string

GetSVGSelectorTokenType(String)

Returns the selector token type (used in style matching) that matches the string

GetSVGShapeRendering(String)

Returns the shape rendering that matches the string

GetSVGStyleProperty(String)

Returns the style property that matches the string

GetSVGTextAnchor(String)

Overloaded. Returns the text anchor type that matches the string

GetSVGTextAnchor(TSVGTextAlign)

Overloaded. Returns the SVG text anchor type that is equivalent to the text alignment type

GetSVGTextDecoration(String)

Returns the text decoration type that matches the string

GetSVGTextPathMethod(String)

Returns the text path method that matches the string

GetSVGTextPathSpacing(String)

Returns the text path spacing that matches the string

GetSVGTextRendering(String)

Returns the text rendering that matches the string

GetSVGUnit(String)

Returns the unit type that matches the string

GetSVGVectorEffect(String)

Returns the vector effect that matches the string

GetSVGWritingMode(String)

Returns the writing mode that matches the string

GetTextAlign(TSVGTextAlign)

Returns the graphics library text alignment type that is equivalent to the SVG text alignment

IsValidSVGHexColor(String)

Represents method IsValidSVGHexColor(String).

LoadBitmapFromDataURI(String,TSVGBitmap)

Loads a bitmap from a data URI string. This method creates or loads a TBitmap from embedded data.

If the Bitmap parameter is nil, the bitmap is created and must be freed by the caller.

ParseAlignmentBaseline(String,TSVGAlignmentBaseline,Boolean)

Parses the input string for alignment baseline, which specifies how an object is aligned with respect to its parent. This property specifies which baseline of this element is to be aligned with the corresponding baseline of the parent. For example, this allows alphabetic baselines in Roman text to stay aligned across font size changes. It defaults to the baseline with the same name as the computed value of the alignment-baseline property.

ParseAngle(String,Single,Boolean)

Parses the string into an angle in radians. The value string is assumed to be in degrees. If the keyword 'grad' follows the value, the value string is converted from gradians. If the keyword 'rad' follows the value, the value string is converted from radians.

ParseAspectRatio(String,TSVGPreserveAspectRatio)

Parses the input string and sets the Aspect Ratio properties

ParseAttrString(IXMLNode,String)

Overloaded. Parses the XML attribute with the specified name into a string

ParseAttrString(IXMLNode,String,String,String)

Overloaded. Parses the XML attribute with the specified name into a string

ParseBaselineShift(String,TSVGBaselineShiftLength)

Parses the input string for baseline shift, which specifies the repositioning of the dominant-baseline relative to the dominant-baseline of the parent text content element. The shifted object might be a sub- or superscript. Within the shifted object, the whole baseline-table is offset; not just a single baseline. The amount of the shift is determined from information from the parent text content element, the sub- or superscript offset from the nominal font of the parent text content element, percent of the "line-height" of the parent text content element or an absolute value.
 

ParseClipRect(String,TRSRect,Boolean,TSVGUnitFactors)

Parses the input string into a clipping rectangle. The input string should be in the format 'rect( top right bottom left)' where top, right, bottom, and left specify offsets from the respective sides of the box.

top, right, bottom, and left may either have a value or 'auto'. Negative lengths are permitted. The value 'auto' means that a given edge of the clipping region will be the same as the edge of the element's generated box (i. e., 'auto' means the same as '0'.)

ParseColor(String,TSVGColor,Boolean,Boolean,TSVGColor)

Parses the input string for a color value.

The allowable values are color | inherit

ParseColorInterpolation(String,TSVGColorInterpolation,Boolean)

Parses the input string for a color interpolation, which specifies the color space for gradient interpolations and alpha compositing. The allowable values are auto | sRGB | linearRGB | inherit.

ParseColorRendering(String,TSVGColorRendering,Boolean)

Parses the input string for a color rendering, which provides a hint to the SVG library about how to optimize its color interpolation and compositing operations. The allowable values are auto | optimizeSpeed | optimizeQuality | inherit

ParseCoordinateSystemUnit(String,TSVGCoordinateSystemUnit)

Parses the input string for a coordinate system unit value, which defines the coordinate system for other attributes of gradients and patterns .

The allowable values are userSpaceOnUse | objectBoundingBox

ParseCursor(String,TCursor,Boolean)

Parses the input string for a cursor. The allowable values are [ [ funciri,]* [ auto | crosshair | default | pointer | move | e-resize | ne-resize | nw-resize | n-resize | se-resize | sw- resize | s-resize | w-resize| text | wait | help ] ] | inherit

ParseDashArray(String,String,TSVGPen,TSVGStylePropertiesSet,TSVGUnitFactors)

Parses the input string for a dash array value and sets the Pen properties

ParseDashes(String,TBooleanDynArray,TSVGUnits,TSVGUnitFactors,Single,Single)

Parses the input string into an array of percentage or length values. Used for dash array so the array is guaranteed to be even number

ParseDirection(String,TSVGDirection,Boolean)

Parses the input string for dominant baseline

ParseDisplay(String,Boolean,Boolean)

Parses the input string for a display value. The ‘display’ property only affects the direct rendering of a given element, whereas it does not prevent elements from being referenced by other elements.

The allowable values are none | inherit | other where other may be any keyword (always translated to visible=true)

ParseDominantBaseline(String,TSVGDominantBaseline,Boolean)

Parses the input string for dominant baseline

ParseFillRule(String,TSVGFillRule,Boolean)

Parses the input string for a fill rule value, which indicates the algorithm which is to be used to determine what parts of the canvas are included inside the shape. For a simple, non- intersecting path, it is intuitively clear what region lies " inside"; however, for a more complex path, such as a path that intersects itself or where one subpath encloses another, the interpretation of "inside" is not so obvious.

The allowable inputs are nonzero | evenodd | inherit
 

ParseFontFamily(String,TStrings,Boolean)

Parses the input string for a font family name value, which indicates which font family is to be used to render the text, specified as a prioritized list of font family names and/or generic family names

The allowable inputs are
[[ family-name | generic-family ],]* [ family-name | generic-family ] | inherit

ParseFontSize(String,Single,Single,Boolean,TSVGUnitFactors)

Parses the input string for a font size value, which refers to the size of the font from baseline to baseline when multiple lines of text are set solid in a multiline layout environment.

The allowable inputs are absolute-size | relative-size | length | percentage | inherit

ParseFontStyle(String,TFontStyles,Boolean)

Parses the input string for a font style value, which specifies whether the text is to be rendered using a normal, italic or oblique face.

The allowable inputs are normal | italic | oblique | inherit
 

ParseFontVariant(String,TSVGFontVariant,Boolean)

Parses the input string for a font variant value, which specifies whether the text is to be converted to small-caps.

The allowable inputs are normal | small-caps | uppercase | lowercase | titlecase. Only normal and small-caps are part of the svg specification
 

ParseFontWeight(String,TSVGFontWeight,Boolean)

Parses the input string for a font weight value, e.g., the boldness or lightness of the glyphs used to render the text, relative to other fonts in the same font family.

The allowable values are normal | bold | bolder | lighter | 100 | 200 | 300
| 400 | 500 | 600 | 700 | 800 | 900 | inherit

ParseGlyphOrientationHorizontal(String,TSVGGlyphOrientationHorizontal,Boolean)

Parses the input string for glyph orientation horizontal, which affects the amount that the current text position advances as each glyph is rendered

ParseGlyphOrientationVertical(String,TSVGGlyphOrientationVertical,Boolean)

Parses the input string for glyph orientation vertical, which affects the amount that the current text position advances as each glyph is rendered

ParseGradientSpread(String,TSVGGradientSpread)

Parses the input string for a gradient spread value, which indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.

The allowable values are pad | reflect | repeat

ParseKerning(String,TSVGStylePropertyAutoLength,TSVGUnitFactors)

Parses the input string for kerning, which specifies the distance to put between the glyphs (characters) of a text string

ParseLength(IXMLNode,String,Single,Boolean,TSVGUnit,TSVGUnitFactors)

Overloaded. Parses the XML attribute with the specified name into a length

ParseLength(IXMLNode,String,Single,TSVGUnit,TSVGUnitFactors)

Overloaded. Parses the XML attribute with the specified name into a length value.

ParseLength(String,Single,Boolean,TSVGUnit,TSVGUnitFactors)

Overloaded. Parses the input string into a length value.

ParseLength(String,Single,TSVGUnit,TSVGUnitFactors)

Overloaded. Parses the input string into a length value.

ParseLength(String,TSVGLength)

Overloaded. Parses the input string into a length value.

ParseLengths(IXMLNode,String,TSVGLengths,TSVGLengthCreateEvent,Single,Single)

Overloaded. Parses the specified IXMLNode attribute for a valid array of lengths

ParseLengths(String,TSVGLengths,TSVGLengthCreateEvent,Single,Single)

Overloaded. Parses the input string into an array of percentage or length values.

ParseLineCap(String,TSVGStrokeCap,Boolean)

Parses the input string into a line cap value, which specifies the shape to be used at the end of open subpaths when they are stroked.

The allowable values are butt | round | square | inherit

ParseLineJoin(String,TSVGStrokeJoin,Boolean)

Parses the input string into a line cap value, which specifies the shape to be used at the corners of paths or basic shapes when they are stroked.

The allowable values are miter | round | bevel | inherit

ParseLocalURI(String)

Overloaded. Parses the input string for a valid url/uri value ('uri(# ref)' or 'url(#ref)')

ParseLocalURI(String,String,Boolean)

Overloaded. Parses the input string for a valid url/uri value ('uri(# ref)' or 'url(#ref)')

ParseMarkerUnit(String,TSVGMarkerUnit)

Parses the input string for a marker unit value, which defines the coordinate system for attributes ‘markerWidth’, ‘ markerHeight’ and the contents of the ‘marker’.

The allowable values are strokeWidth | userSpaceOnUse

ParseMatrix(String)

Parses the input string for a matrix definition: 6 numbers. Note that numbers can be separated by commas, spaces, or +/- (e. g. , the string '100+99' is two numbers and is valid)
 

ParseMiterLimit(String,Single,Boolean)

Overloaded.  Parses the input string into a miter limit value, which imposes a limit on the ratio of the miter length to the stroke width. When the limit is exceeded, the join is converted from a miter to a bevel.

The allowable values are number >= 1

ParseNumber(String,Single,Boolean)

Parses the input S value into a floating point number

If the S string is empty or Inherited is true, the DefValue is returned.

ParseNumbers(IXMLNode,String,TSingleDynArray)

Overloaded. Parses the XML attribute with the specified name into a list of floating point numbers. The numbers may be separated by commas or whitespace

ParseNumbers(String,TSingleDynArray)

Overloaded. Parses the input S value into a list of floating point numbers. The numbers may be separated by commas or whitespace

ParseOverflow(String,Boolean,Boolean)

Parses the input string into a overflow value, which specifies whether the content of a block-level element is clipped when it overflows the element's box (which is acting as a containing block for the content).

The allowable values are visible | hidden | scroll | auto | inherit

ParsePercent(IXMLNode,String,Single,Boolean,TSVGUnit,TSVGUnitFactors,Single,Single)

Overloaded. Parses the XML attribute with the specified name into a percentage or length value.

ParsePercent(IXMLNode,String,Single,TSVGUnit,TSVGUnitFactors,Single,Single)

Overloaded. Parses the XML attribute with the specified name into a percentage or length value.

ParsePercent(IXMLNode,String,TSVGLength,Boolean,Single,Single)

Overloaded. Parses the XML attribute with the specified name into a percentage or length value.

ParsePercent(IXMLNode,String,TSVGLength,Single,Single)

Overloaded. Parses the XML attribute with the specified name into a percentage or length value.

ParsePercent(String,Single,Boolean,TSVGUnit,TSVGUnitFactors,Single,Single)

Overloaded. Parses the input string into a percentage or length value.

ParsePercent(String,Single,TSVGUnit,TSVGUnitFactors)

Overloaded. Parses the input string into a percentage or length value.

ParsePercent(String,Single,TSVGUnit,TSVGUnitFactors,Single,Single)

Overloaded. Parses the input string into a percentage or length value.

ParsePercent(String,TSVGLength,Boolean,Single,Single)

Overloaded. Parses the input string into a percentage or length value.

ParsePercent(String,TSVGLength,Single,Single)

Overloaded. Parses the input string into a percentage or length value.

ParsePoints(IXMLNode,String)

Overloaded. Parses the XML attribute with the specified name into an array of points.

ParsePoints(String)

Overloaded. Parses the string into an array of points

ParseRect(String,TSVGUnitFactors)

Overloaded. Parses the input string into a rectangle using a string of 4 concatenated lengths: left top width height. The lengths may be separated by commas or spaces.

ParseRect(String,TSVGViewBox)

Overloaded. Parses the input string into a viewbox rectangle using a string of 4 concatenated lengths: left top width height. The lengths may be separated by commas or spaces.

ParseRequiredStringList(IXMLNode,String,TStrings,String)

Overloaded. Parses an input string into a list of strings separated by the delimiters

ParseRotateMatrix(String)

Parses the input string for a rotation matrix definition ( rotate-angle [cx cy]), which specifies a rotation by degrees about a given point.

If optional parameters cx and cy are not supplied, the rotate is about the origin of the current user coordinate system. The operation corresponds to the matrix [cos(a) sin(a) -sin(a) cos( a) 0 0].

If optional parameters cx and cy are supplied, the rotate is about the point (cx, cy). The operation represents the equivalent of the following specification: translate(cx, cy)

ParseScaleMatrix(String)

Parses the input string for a scale matrix definition ( sx [sy]), which specifies a scale operation by sx and sy. If sy is not provided, it is assumed to be equal to sx

ParseShapeRendering(String,TSVGShapeRendering,Boolean)

Parses the input string for a shape rendering, which provides a hint to the SVG library about what tradeoffs to make as it renders vector graphics elements such as path elements and basic shapes such as circles and rectangles. The allowable values are auto | optimizeSpeed | crispEdges | geometricPrecision | inherit
 
 

ParseSingles(String,TSVGUnitFactors)

ParseSkewXMatrix(String)

Parses the input string for a skew x matrix definition ( skew-angle), which specifies a skew transformation along the x-axis.

ParseSkewYMatrix(String)

Parses the input string for a skew y matrix definition ( skew-angle), which specifies a skew transformation along the y-axis.

ParseSpacing(String,TSVGStylePropertyAutoLength,TSVGUnitFactors)

Parses the input string for letter/word spacing, which specifies the distance to put between the glyphs (characters) of a text string (in addition to kerning)

ParseString(IXMLNode,String,String)

Parses the XML node with the specified name into a string

ParseStringList(TStrings,String,String)

Overloaded. Parses an input string into a list of strings separated by the delimiters

ParseTextAnchor(String,TSVGTextAlign,Boolean)

Parses the input string for a text anchor value, which is used to align (start-, middle- or end-alignment) a string of text relative to a given point.

The allowable values are start | middle | end | inherit

ParseTextDecoration(String,TSVGFont,Boolean)

Parses the input string for a text decoration value, which describes decorations that are added to the text of an element. The RSCL does not support the blink value.

The allowable values are none | [ underline || overline || line- through || blink ] | inherit

ParseTextPathMethod(String,TSVGTextPathMethod)

Parses the input string for text path method, which specifies the method by which text should be rendered along the path
 

ParseTextPathSpacing(String,TSVGTextPathSpacing)

Parses the input string for text path spacing, which specifies how the user agent should determine the spacing between glyphs that are to be rendered along a path.

ParseTextRendering(String,TSVGTextRendering,Boolean)

Parses the input string for a text rendering, which provides a hint to the SVG library about what tradeoffs to make as it renders text. The allowable values are auto | optimizeSpeed | optimizeLegibility | geometricPrecision | inherit

ParseTransformation(String)

Parses the input string for a transformation matrix. The value of the ‘transform’ attribute is a transform-list , which is defined as a list of transform definitions, which are applied in the order provided. The individual transform definitions are separated by whitespace and/or a comma.

ParseTranslateMatrix(String)

Parses the input string for a translation matrix definition ( tx [ty]), which specifies a translation by tx and ty. If ty is not provided, it is assumed to be zero

ParseURI(IXMLNode,String,String,String)

Overloaded. Parses the specified IXMLNode attribute for a valid url/uri value ('uri(# ref)' or 'url(#ref)')

ParseURI(String)

Overloaded. Parses the input string for a valid url/uri value ('uri(# ref)' or 'url(#ref)')

ParseURI(String,String,Boolean)

Overloaded. Parses the input string for a valid url/uri value ('uri(# ref)' or 'url(#ref)')

ParseVectorEffect(String,TSVGVectorEffect,Boolean)

Parses the input string for a vector effect value, which indicates the vector effect that shall be applied

The allowable inputs are none | non-scaling-stroke | inherit
 

ParseVisible(String,Boolean,Boolean)

Parses the input string for a visible value.

The allowable values are visible | hidden | collapse | inherit

ParseWritingMode(String,TSVGWritingMode,Boolean)

Parses the input string for writing mode, which specifies whether the initial inline-progression-direction for a ‘text’ element shall be left-to-right, right-to-left, or top-to-bottom. The ‘writing-mode’ property applies only to ‘text’ elements; the property is ignored for ‘tspan’, ‘tref’, ‘altGlyph’ and ‘textPath’ sub-elements.

PixelsToSVGUnit(Single,TSVGUnit,TSVGUnitFactors)

Returns pixels converted into the specified unit

RemoveComments(String)

Removes comments (/* ... */) from a string

SaveAttrString(IXMLNode,String,String,Boolean,Boolean)

Overloaded.  Saves the specified Value to the XML node as an attribute (specified by the Name parameter)

If the inherits parameter is true and the compact parameter is true, then attribute will not be written out

SaveAttrString(IXMLNode,String,TStrings,Boolean,Boolean,Char)

Overloaded.  Saves the specified list of values to the XML node as an attribute (specified by the Name parameter). The list of values is one string separated by the Delimiter character.

If the inherits parameter is true and the compact parameter is true, then attribute will not be written out

SaveNodeString(IXMLNode,String,String,Boolean,Boolean)

Saves the Value parameter to the XML node as a child node (specified by the Name parameter).

If the inherits parameter is true and the compact parameter is true, then child element will not be created

SaveStyleProperty(IXMLNode,TSVGStyleProperty,String,String,Boolean,Boolean,Boolean)

Saves the specified Value to the XML node as an attribute. The Style parameter controls the name of the attribute.

If the inherits parameter is true or the Value equals DefaultValue, and the compact parameter is true, then attribute will not be written out

ScaleSize(Single,Single,Single,Single,TSVGImageWrapMode,Single)

Returns the size needed for a bitmap which can fit the SVG using its width and height, wrapmode, and scalefactor. The DefaultWidth and DefaultHeight parameters specify the minimum size.

SetColorOpacity(TAlphaColor,Single)

Helper function for setting the alpha component of a TAlphaColor to the specified opacity

SplitNumbers(string,string)

Splits an input string into a dynamic array of strings (which are assumed to be numbers but won't necessarily be). The SplitNumbers function uses the delimiters plus the special delimiters of '+' and '-' to split the string (e. g. , the string '100+99' is two numbers and is valid)

SVGColorToGrayscale(TSVGColor)

Returns the grayscale color of the color. The function works like the NTSC (National Televisision Standards Committee) system: Red*0.56, Green*0.33 and Blue*0.11

SVGColorToString(TSVGColor)

Returns the svg string representation of a color

SVGLengthsToString(TSVGLengths,String,Single,Single,String)

Returns an SVG compatible string for the all the lengths If the number is a percentage, the function uses the Min and Max parameters to scale the number within the range

SVGLengthToString(Single,Boolean,TSVGUnit,String,Single,Single)

Overloaded. Returns an SVG compatible string for the length in the specified unit. If the number is a percentage, the function uses the Min and Max parameters to scale the number within the range

SVGLengthToString(TSVGLength,String,Single,Single)

Overloaded. Returns an SVG compatible string for the length in the specified unit. If the number is a percentage, the function uses the Min and Max parameters to scale the number within the range

SVGNumbersToString(TSingleDynArray,String,String)

Returns an SVG compatible string of all numbers in array separated by Sep parameter

SVGNumberToString(Single,TSVGUnit,String)

Overloaded.  Returns an SVG compatible string for the number in the specified unit.

The number is assumed to already be in the specified unit. The unit parameter is for the string to append after the number, e.g., 'in' or 'cm'.

SVGPointsToString(TSVGPoint[],TSVGUnit,String)

Returns the svg string representation of an array of points

SVGPointToString(TSVGPoint,TSVGUnit,String)

Returns the svg string representation of a point

SVGRectToString(TSVGRect,TSVGUnit,String)

Returns the svg string representation of a rectangle as X, Y, Width and Height (not Right and Bottom)

SVGSplitLines(TStrings,Integer)

Splits the TStrings parameter into shorter lines. This function only splits path elements (e.g., <path d="M...">) as these are the only lines that can be split into multiple lines without changing the meaning of attributes and elements.

SVGStrokeCapToString(TSVGStrokeCap)

Returns the string representation of stroke line cap

SVGStrokeJoinToString(TSVGStrokeJoin)

Returns the string representation of stroke line join

SVGTransformationToString(TSVGMatrix)

Returns the svg string representation of the transformation matrix

TokenizeSelector(String)

Tokenizes the string into selector tokens used by CSS2 selectors