Module org.tquadrat.foundation.svg

Package org.tquadrat.foundation.svg

Interface SVGMarker

All Superinterfaces:

AllowsPresentationAttributes, Element, SVGElement, SVGElementWithChildren

All Known Subinterfaces:

SVGPositionedMarker

All Known Implementing Classes:

SVGElementAdapter, SVGGenericElement, SVGMarkerImpl, SVGPositionedMarkerImpl

@ClassVersion(sourceVersion="$Id: SVGMarker.java 1074 2023-10-02 12:05:06Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public sealed interface SVGMarker
extends SVGElementWithChildren, AllowsPresentationAttributes
permits SVGPositionedMarker, SVGMarkerImpl

The definition for the SVG <marker> element.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: SVGMarker.java 1074 2023-10-02 12:05:06Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.svg.SVGMarker"

⁠

Field Summary

Fields inherited from interface org.tquadrat.foundation.svg.AllowsPresentationAttributes

PRESENTATION_ATTRIBUTES

Fields inherited from interface org.tquadrat.foundation.svg.SVGElement

CORE_ATTRIBUTES

Method Summary

Modifier and Type	Method	Description
void	setExternalResourcesRequired(boolean flag)	Sets the attribute that indicates whether external resources are required to render this <marker> element.
default void	setMarkerDimensions(SVGNumber width, SVGNumber height)	Sets the width and the height of the viewport into which the <marker> is to be fitted when it is rendered.
void	setMarkerHeight(SVGNumber value)	Sets the height of the viewport into which the <marker> is to be fitted when it is rendered.
void	setMarkerUnits(boolean flag)	Sets the marker units attribute that defines the coordinate system for the attributes "markerWidth" and "markerHeight".
void	setMarkerWidth(SVGNumber value)	Sets the width of the viewport into which the <marker> is to be fitted when it is rendered.
void	setOrientation(SVGMarkerOrientation value)	Sets the orientation of the marker.
void	setOrientation(SVGNumber.SVGDegree value)	Sets the orientation of the marker.
void	setPreserveAspectRatio(SVGPreserveAspectRatio value)	Sets the mode for the aspect ratio preservation for this <marker> element.
default void	setReferencePoint(SVGNumber x, SVGNumber y)	Sets the reference point for the marker. This is the location on the marker where it will be joined to its markable element.
void	setReferenceX(SVGNumber value)	Sets the x coordinate of the marker reference point.
void	setReferenceY(SVGNumber value)	Sets the y coordinate of the marker reference point.
void	setTransform(SVGTransform... values)	Sets the transformations for this <marker> element.
void	setViewBox(SVGNumber x, SVGNumber y, SVGNumber width, SVGNumber height)	Defines the visible area for this <marker> element.

Methods inherited from interface org.tquadrat.foundation.svg.AllowsPresentationAttributes

setAlignmentBaseline, setBaselineShift, setClip, setClipPath, setClipRule, setColor, setColorInterpolation, setColorInterpolationFilters, setColorProfile, setColorRendering, setCursor, setDirection, setDisplay, setDominantBaseline, setEnableBackground, setFill, setFillOpacity, setFillRule, setFilter, setFloodColor, setFloodOpacity, setFontFamily, setFontSize, setFontSizeAdjust, setFontStretch, setFontStyle, setFontVariant, setFontWeight, setGlyphOrientationHorizontal, setGlyphOrientationVertical, setImageRendering, setKerning, setLetterSpacing, setLightingColor, setMarkerEnd, setMarkerMid, setMarkerStart, setMask, setOpacity, setOverflow, setPointerEvents, setShapeRendering, setStopColor, setStopOpacity, setStroke, setStrokeDashArray, setStrokeDashOffset, setStrokeLineCap, setStrokeLineJoin, setStrokeMiterLimit, setStrokeOpacity, setStrokeWidth, setTextAnchor, setTextDecoration, setTextRendering, setUnicodeBidi, setVectorEffect, setVisibility, setWordSpacing, setWritingMode

Methods inherited from interface org.tquadrat.foundation.xml.builder.spi.Element

getAttribute, getAttributes, getChildren, getElementName, getNamespaces, getParent, hasChildren, isBlock, setParent, toString

Methods inherited from interface org.tquadrat.foundation.svg.SVGElement

addComment, getSVGElementCategory, setId, setLang, setPreserveSpace, setTabIndex, setTitle, setXMLBase, setXMLId, setXMLLang

Methods inherited from interface org.tquadrat.foundation.svg.SVGElementWithChildren

addChild, setDescription

Method Details

setExternalResourcesRequired

void setExternalResourcesRequired(boolean flag)

Sets the attribute that indicates whether external resources are required to render this <marker> element.

Parameters:

flag - true if external resources are needed, false if all required resources are local to the current context.

setMarkerDimensions

default void setMarkerDimensions(SVGNumber width,
 SVGNumber height)

Sets the width and the height of the viewport into which the <marker> is to be fitted when it is rendered.

Parameters:

width - The width.

height - The height.

See Also:

• SVGUtils.SVGATTRIBUTE_MarkerHeight
• SVGUtils.SVGATTRIBUTE_MarkerWidth

setMarkerHeight

void setMarkerHeight(SVGNumber value)

Sets the height of the viewport into which the <marker> is to be fitted when it is rendered.

Parameters:

value - The height.

See Also:

• SVGUtils.SVGATTRIBUTE_MarkerHeight

setMarkerUnits

void setMarkerUnits(boolean flag)

Sets the marker units attribute that defines the coordinate system for the attributes "markerWidth" and "markerHeight".

Parameters:

flag - true if the user space should be used, false for the stroke width.

setMarkerWidth

void setMarkerWidth(SVGNumber value)

Sets the width of the viewport into which the <marker> is to be fitted when it is rendered.

Parameters:

value - The width.

See Also:

• SVGUtils.SVGATTRIBUTE_MarkerWidth

setOrientation

void setOrientation(SVGMarkerOrientation value)

Sets the orientation of the marker. Basically, this means how it is rotated when it is placed at its position on the markable element.

Parameters:

value - The orientation.

setOrientation

void setOrientation(SVGNumber.SVGDegree value)

Sets the orientation of the marker. Basically, this means how it is rotated when it is placed at its position on the markable element.

Parameters:

value - The orientation.

setPreserveAspectRatio

void setPreserveAspectRatio(SVGPreserveAspectRatio value)

Sets the mode for the aspect ratio preservation for this <marker> element.

Parameters:

value - The type; if null the attribute will be removed.

setReferencePoint

default void setReferencePoint(SVGNumber x,
 SVGNumber y)

Sets the reference point for the marker.

This is the location on the marker where it will be joined to its markable element. Coordinates are relative to the marker's coordinate system, and not the markable element it is placed on.

Parameters:

x - The x coordinate for the point.

y - The y coordinate for the point.

See Also:

• setMarkerUnits(boolean)

setReferenceX

void setReferenceX(SVGNumber value)

Sets the x coordinate of the marker reference point.

Parameters:

value - The coordinate type.

See Also:

• setReferencePoint(SVGNumber, SVGNumber)

setReferenceY

void setReferenceY(SVGNumber value)

Sets the y coordinate of the marker reference point.

Parameters:

value - The coordinate type.

See Also:

• setReferencePoint(SVGNumber, SVGNumber)

setTransform

void setTransform(SVGTransform... values)

Sets the transformations for this <marker> element.

Specified by:

setTransform in interface AllowsPresentationAttributes

Parameters:

values - The transformations; if null or empty, the attribute will be removed.

See Also:

• SVGUtils.SVGATTRIBUTE_Transform

setViewBox

void setViewBox(SVGNumber x,
 SVGNumber y,
 SVGNumber width,
 SVGNumber height)

Defines the visible area for this <marker> element.

Parameters:

x - The x coordinate of top left corner of the area.

y - The y coordinate of top left corner of the area.

width - The width of the area.

height - The height of the area.