C

PatternFill

Show Usages
Fills an area with a SVG pattern.
ImplementsInheritance Hierarchy

Members

Show:

Constructors

PatternFill

()
Initializes a new instance of the PatternFill class.

Parameters

Properties

content

: SvgVisual
Gets or sets the content.
final

Property Value

The content.

origin

: Point
Gets or sets the origin of this pattern brush.
conversionfinal

Property Value

The origin of this pattern brush.

size

: Size
Gets or sets the size of this pattern brush.
conversionfinal

Property Value

The size of this pattern brush.

viewBox

: Rect
Gets or sets the SVG view box of this pattern brush.
conversionfinal

Property Value

The SVG view box of this pattern brush.

Methods

accept

(
context: ICanvasContext
node: Node
id: string
): boolean
Callback method that checks if the specified node references the element represented by this instance.
SvgDefsManager iterates elements during cleanUpDefs in the SVG DOM and calls this method to check if the element references the defs element createDefsElement created by this instance. If no element is accepted by this method, the created element will become eligible for removal from the defs section.
final

Parameters

context: ICanvasContext
The current canvas context.
node: Node
One SVG node from the SVG DOM.
id: string
The defs id that has been stored for this instance by the provided context.

Return Value

boolean
true if node references the element represented by this instance.

applyTo

(element: SVGElement, context: ICanvasContext)
Assigns the fill defined by this instance to the given SVG element.

If this Fill is a gradient and implements the ISvgDefsCreator interface, it will be added to the defs section of the SVG document per the context. The fill of the given element will be set to a reference to the gradient element.

This method is very similar in functionality to its static method counterpart setFill. However since this method is an instance method, it cannot be called on empty/null fills. If you are unsure whether the reference actually points to an instance, use the static helper method instead.

final

Parameters

element: SVGElement
The element whose fill should be set.
context: ICanvasContext
The context.

See Also

API
setFill

Defined in

Fill.applyTo

clone

(): Object
Clones this instance by returning a memberwise clone, or by returning this if this instance is frozen.

Return Value

Object
An instance of the same type as this instance.

Defined in

Fill.clone

createDefsElement

(context: ICanvasContext): SVGElement
Creates the element put into the defs section of the SVG element.
Note that this method should not add an id to the element. The caller performs this.
final

Parameters

context: ICanvasContext
The canvas context for which this element is created..

Return Value

SVGElement
An SVGElement that can be put into the defs section of the SVG element. Without an id attribute.

freeze

(): Fill
Freezes and returns this instance.
Freezing an object makes it immutable, which can result in performance enhancements.

Return Value

Fill
This instance, made immutable.

Defined in

Fill.freeze

hasSameValue

(fill: Fill): boolean
Determines whether this PatternFill is equal to the specified object.
final

Parameters

fill: Fill
The other Fill instance to compare.

Return Value

boolean
true, if this Color is equal to the other object; false, otherwise.

isFrozen

(): boolean
Determines if this instance is frozen.
final

Return Value

boolean
true if this instance is frozen; otherwise, false.

Defined in

Fill.isFrozen

updateDefsElement

(context: ICanvasContext, oldElement: SVGElement)
Updates the defs element with the current values, optionally.
This method is called for each instance once per updateVisual call.
final

Parameters

context: ICanvasContext
The context within the elements are updated.
oldElement: SVGElement
The element to possibly update.