ISvgModule

​

Interface ISvgModule

interface ISvgModule

Extends com.amazon.apmf.IStandard UI svgs module This interface acts as an entry point factory for svgs rendering.

​

Methods

​

makeSvgCircle()

ISvgCircle* makeSvgCircle(SvgLength radius)

This function creates the Circle element defines a circle based on a center point and a radius.

​

Parameters

radius

SvgLength — Required SvgLength the radius of the circle. A value lower or equal to zero disables rendering of the circle.

​

Returns

ISvgCircle* the new created ISvgCircle object. More details: https://www.w3.org/TR/SVG2/shapes.html#CircleElement

---

​

makeSvgClipPath()

ISvgNode* makeSvgClipPath(string path)

This function creates a new ClipPath object.

​

Parameters

path

string — Required string value for clipPath.

​

Returns

ISvgNode* the new created ISvgNode object. More details: https://drafts.fxtf.org/css-masking-1/#ClipPathElement

---

​

makeSvgDefs()

ISvgNode* makeSvgDefs()

This function creates the Defs element is a container element for referenced elements.

​

Returns

ISvgNode* the new created ISvgNode object. More details: https://www.w3.org/TR/SVG2/struct.html#DefsElement

---

​

makeSvgEllipse()

ISvgEllipse* makeSvgEllipse(SvgLength rx, SvgLength ry)

This function creates the Ellipse element defines an ellipse which is axis-aligned with the current user coordinate system based on a center point and two radii.

​

Parameters

rx

SvgLength — Required SvgLength the radius of the ellipse on the x axis.

ry

SvgLength — Required SvgLength the radius of the ellipse on the y axis.

​

Returns

ISvgEllipse* the new created ISvgEllipse object. More details: https://www.w3.org/TR/SVG2/shapes.html#EllipseElement

---

​

makeSvgG()

ISvgG* makeSvgG()

This function creates the SvgG element which can have graphics elements and other container elements as child elements.

​

Returns

ISvgG* the new created ISvgG object. More details: https://www.w3.org/TR/SVG2/struct.html#Groups

---

​

makeSvgImage()

ISvgImage* makeSvgImage(SvgLength width, SvgLength height)

This function creates the Image element indicates that the contents of a complete file are to be rendered into a given rectangle within the current user coordinate system.

​

Parameters

width

SvgLength — Required SvgLength the width the image renders at.

height

SvgLength — Required SvgLength the height the image renders at.

​

Returns

ISvgImage* the new created ISvgImage object. More details: https://www.w3.org/TR/SVG2/embedded.html#ImageElement

---

​

makeSvgLine()

ISvgLine* makeSvgLine(SvgLength x1, SvgLength x2, SvgLength y1, SvgLength y2)

This function creates the Line element defines a line segment that starts at one point and ends at another.

​

Parameters

x1

SvgLength — Required SvgLength defines the x-axis coordinate of the line starting point.

x2

SvgLength — Required SvgLength defines the x-axis coordinate of the line ending point.

y1

SvgLength — Required SvgLength defines the y-axis coordinate of the line starting point.

y2

SvgLength — Required SvgLength defines the y-axis coordinate of the line ending point.

​

Returns

ISvgLine* the new created ISvgLine object. More details: https://www.w3.org/TR/SVG2/shapes.html#LineElement

---

​

makeSvgLinearGradient()

ISvgLinearGradient* makeSvgLinearGradient(SvgLength x1, SvgLength x2, SvgLength y1, SvgLength y2)

This function creates a new LinearGradient object.

​

Parameters

x1

SvgLength — Required SvgLength the x1 coordinate of the starting point of the vector gradient along which the linear gradient is drawn.

x2

SvgLength — Required SvgLength the x2 coordinate of the ending point of the vector gradient along which the linear gradient is drawn.

y1

SvgLength — Required SvgLength the y1 coordinate of the starting point of the vector gradient along which the linear gradient is drawn.

y2

SvgLength — Required SvgLength the y2 coordinate of the ending point of the vector gradient along which the linear gradient is drawn.

​

Returns

ISvgLinearGradient* the new created ISvgLinearGradient object. More details: https://www.w3.org/TR/SVG2/pservers.html#LinearGradientElement

---

​

makeSvgMask()

ISvgMask* makeSvgMask(SvgLength width, SvgLength height)

This function creates a new Mask object.

​

Parameters

width

SvgLength — Required SvgLength the width of the masking area.

height

SvgLength — Required SvgLength the height of the masking area.

​

Returns

ISvgMask* the new created ISvgMask object. More details: https://drafts.fxtf.org/css-masking-1/#MaskElement

---

​

makeSvgPathNode()

ISvgPathNode* makeSvgPathNode(string svgPath)

This function creates the Path element is specified using the d property.

​

Parameters

svgPath

string — Required the string value is used to specify the shape of a ‘Path element.

​

Returns

ISvgPathNode* the new created ISvgPathNode object. More details: https://www.w3.org/TR/SVG2/paths.html#PathElement

---

​

makeSvgRadialGradient()

ISvgRadialGradient* makeSvgRadialGradient(SvgLength fr, SvgLength radius)

This function creates a new RadialGradient object.

​

Parameters

fr

SvgLength — Required SvgLength the radius of the start circle of the radial gradient.

radius

SvgLength — Required SvgLength the radius of the end circle of the radial gradient.

​

Returns

ISvgRadialGradient* the new created ISvgRadialGradient object. More details: https://www.w3.org/TR/SVG2/pservers.html#RadialGradientElement

---

​

makeSvgRect()

ISvgRect* makeSvgRect(SvgLength width, SvgLength height)

This function creates the Rect element defines a rectangle which is axis-aligned with the current user coordinate system.

​

Parameters

width

SvgLength — Required SvgLength the width of the rect.

height

SvgLength — Required SvgLength the height of the rect.

​

Returns

ISvgRect* the new created ISvgRect object. More details: https://www.w3.org/TR/SVG2/shapes.html#RectElement

---

​

makeSvgStop()

ISvgStop* makeSvgStop(SvgLength offset)

This function creates the Stop element which defines a color stop in a gradient. That element should be which are child elements of linearGradient or radialGradient. They define the colors and positions along the gradient vector.

​

Parameters

offset

SvgLength — Required SvgLength the gradient stop is placed along the gradient vector.

​

Returns

ISvgStop* the new created ISvgStop object. More details: https://www.w3.org/TR/SVG2/pservers.html#StopElement

---

​

makeSvg()

ISvgView* makeSvg(SvgLength width, SvgLength height)

This function creates a new Svg object.

​

Parameters

width

SvgLength — Required SvgLength the displayed width of the rectangular viewport.

height

SvgLength — Required SvgLength the displayed height of the rectangular viewport.

​

Returns

ISvgView* the new created ISvgView object. More details: https://www.w3.org/TR/SVG2/struct.html#SVGElement

---

​

makeSvgText()

ISvgTextContainer* makeSvgText(bool isTSpan)

This function creates the Text or TSpan element defines a graphics element consisting of text.

​

Parameters

isTSpan

bool — Required specifies whether to create a TSpan (true) or a Text (false) element.

​

Returns

ISvgTextContainer* the new created ISvgTextContainer object. More details: https://www.w3.org/TR/SVG2/text.html#TextElement

---

​

makeSvgUse()

ISvgUse* makeSvgUse()

This function creates a new Use object.

​

Returns

ISvgUse* the new created UsISvgUse object. More details: https://www.w3.org/TR/SVG2/struct.html#UseElement

---