documentationfor yFiles for HTML 2.6

Fill

Represents any object which fills an area.

Inheritance Hierarchy

Fill

Implemented Interfaces

Remarks

The fill that is defined by instances of this type can be applied to an SVG element using either the static helper setFill or the instance method applyTo.

This is a convertible type that can be used with the following notation(s) in parameter lists, parameter objects or setters.

CSS color strings are converted to SolidColorFills. For example:

'blue'
'#369'
'#336699'
'rgb(51, 102, 153)'
'rgba(51, 102, 153, 0.5)'
'hsl(225, 98%, 60%)'
'hsla(225, 98%, 60%, 0.5)'

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.view.Fill

See Also

Fill.setFill, Colors, Fills, and Strokes, Node Styles, Support for Colors and Fills, Selection

Methods

applyTo

(element: SVGElement, context: ICanvasContext)

Assigns the fill defined by this instance to the given SVG element.

Remarks

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 counter part 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.

Parameters

options - Object
A map of options to pass to the method.

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

See Also

clone

Clones this instance by returning a memberwiseClone or this in case this instance is already frozen.

Returns

↪Object: An instance of the same type as this instance.

Implements

freeze

() : Fill

Freezes and returns this instance.

Remarks

Freezing an object makes it immutable, which can result in performance enhancements.

Returns

↪Fill: This instance, made immutable.

hasSameValue

(fill: Fill) : boolean

Determines whether this Fill is equal to the specified object.

Parameters

options - Object
A map of options to pass to the method.

fill - Fill: The other Fill instance to compare.

Returns

↪boolean: true, if this SolidColorFill is equal to the other object; false, otherwise.

isFrozen

() : boolean

Determines if this instance is frozen.

Constants

ALICE_BLUE

Gets a SolidColorFill for the color AliceBlue.

Remarks

This property will yield a frozen shared immutable value.

ANTIQUE_WHITE

Gets a SolidColorFill for the color AntiqueWhite.

Remarks

This property will yield a frozen shared immutable value.

AQUA

Gets a SolidColorFill for the color Aqua.

Remarks

This property will yield a frozen shared immutable value.

AQUAMARINE

Gets a SolidColorFill for the color Aquamarine.

Remarks

This property will yield a frozen shared immutable value.

AZURE

Gets a SolidColorFill for the color Azure.

Remarks

This property will yield a frozen shared immutable value.

BEIGE

Gets a SolidColorFill for the color Beige.

Remarks

This property will yield a frozen shared immutable value.

BISQUE

Gets a SolidColorFill for the color Bisque.

Remarks

This property will yield a frozen shared immutable value.

BLACK

Gets a SolidColorFill for the color Black.

Remarks

This property will yield a frozen shared immutable value.

BLANCHED_ALMOND

Gets a SolidColorFill for the color BlanchedAlmond.

Remarks

This property will yield a frozen shared immutable value.

BLUE

Gets a SolidColorFill for the color Blue.

Remarks

This property will yield a frozen shared immutable value.

BLUE_VIOLET

Gets a SolidColorFill for the color BlueViolet.

Remarks

This property will yield a frozen shared immutable value.

BROWN

Gets a SolidColorFill for the color Brown.

Remarks

This property will yield a frozen shared immutable value.

BURLY_WOOD

Gets a SolidColorFill for the color BurlyWood.

Remarks

This property will yield a frozen shared immutable value.

CADET_BLUE

Gets a SolidColorFill for the color CadetBlue.

Remarks

This property will yield a frozen shared immutable value.

CHARTREUSE

Gets a SolidColorFill for the color Chartreuse.

Remarks

This property will yield a frozen shared immutable value.

CHOCOLATE

Gets a SolidColorFill for the color Chocolate.

Remarks

This property will yield a frozen shared immutable value.

CORAL

Gets a SolidColorFill for the color Coral.

Remarks

This property will yield a frozen shared immutable value.

CORNFLOWER_BLUE

Gets a SolidColorFill for the color CornflowerBlue.

Remarks

This property will yield a frozen shared immutable value.

CORNSILK

Gets a SolidColorFill for the color Cornsilk.

Remarks

This property will yield a frozen shared immutable value.

CRIMSON

Gets a SolidColorFill for the color Crimson.

Remarks

This property will yield a frozen shared immutable value.

CURRENT_COLOR

Gets a Fill for the currentColor constant.

Remarks

This property will yield a frozen shared immutable value.

See Also

Synchronize fill and stroke with currentColor

CYAN

Gets a SolidColorFill for the color Cyan.

Remarks

This property will yield a frozen shared immutable value.

DARK_BLUE

Gets a SolidColorFill for the color DarkBlue.

Remarks

This property will yield a frozen shared immutable value.

DARK_CYAN

Gets a SolidColorFill for the color DarkCyan.

Remarks

This property will yield a frozen shared immutable value.

DARK_GOLDENROD

Gets a SolidColorFill for the color DarkGoldenrod.

Remarks

This property will yield a frozen shared immutable value.

DARK_GRAY

Gets a SolidColorFill for the color DarkGray.

Remarks

This property will yield a frozen shared immutable value.

DARK_GREEN

Gets a SolidColorFill for the color DarkGreen.

Remarks

This property will yield a frozen shared immutable value.

DARK_KHAKI

Gets a SolidColorFill for the color DarkKhaki.

Remarks

This property will yield a frozen shared immutable value.

DARK_MAGENTA

Gets a SolidColorFill for the color DarkMagenta.

Remarks

This property will yield a frozen shared immutable value.

DARK_OLIVE_GREEN

Gets a SolidColorFill for the color DarkOliveGreen.

Remarks

This property will yield a frozen shared immutable value.

DARK_ORANGE

Gets a SolidColorFill for the color DarkOrange.

Remarks

This property will yield a frozen shared immutable value.

DARK_ORCHID

Gets a SolidColorFill for the color DarkOrchid.

Remarks

This property will yield a frozen shared immutable value.

DARK_RED

Gets a SolidColorFill for the color DarkRed.

Remarks

This property will yield a frozen shared immutable value.

DARK_SALMON

Gets a SolidColorFill for the color DarkSalmon.

Remarks

This property will yield a frozen shared immutable value.

DARK_SEA_GREEN

Gets a SolidColorFill for the color DarkSeaGreen.

Remarks

This property will yield a frozen shared immutable value.

DARK_SLATE_BLUE

Gets a SolidColorFill for the color DarkSlateBlue.

Remarks

This property will yield a frozen shared immutable value.

DARK_SLATE_GRAY

Gets a SolidColorFill for the color DarkSlateGray.

Remarks

This property will yield a frozen shared immutable value.

DARK_TURQUOISE

Gets a SolidColorFill for the color DarkTurquoise.

Remarks

This property will yield a frozen shared immutable value.

DARK_VIOLET

Gets a SolidColorFill for the color DarkViolet.

Remarks

This property will yield a frozen shared immutable value.

DEEP_PINK

Gets a SolidColorFill for the color DeepPink.

Remarks

This property will yield a frozen shared immutable value.

DEEP_SKY_BLUE

Gets a SolidColorFill for the color DeepSkyBlue.

Remarks

This property will yield a frozen shared immutable value.

DIM_GRAY

Gets a SolidColorFill for the color DimGray.

Remarks

This property will yield a frozen shared immutable value.

DODGER_BLUE

Gets a SolidColorFill for the color DodgerBlue.

Remarks

This property will yield a frozen shared immutable value.

FIREBRICK

Gets a SolidColorFill for the color Firebrick.

Remarks

This property will yield a frozen shared immutable value.

FLORAL_WHITE

Gets a SolidColorFill for the color FloralWhite.

Remarks

This property will yield a frozen shared immutable value.

FOREST_GREEN

Gets a SolidColorFill for the color ForestGreen.

Remarks

This property will yield a frozen shared immutable value.

FUCHSIA

Gets a SolidColorFill for the color Fuchsia.

Remarks

This property will yield a frozen shared immutable value.

GAINSBORO

Gets a SolidColorFill for the color Gainsboro.

Remarks

This property will yield a frozen shared immutable value.

GHOST_WHITE

Gets a SolidColorFill for the color GhostWhite.

Remarks

This property will yield a frozen shared immutable value.

GOLD

Gets a SolidColorFill for the color Gold.

Remarks

This property will yield a frozen shared immutable value.

GOLDENROD

Gets a SolidColorFill for the color Goldenrod.

Remarks

This property will yield a frozen shared immutable value.

GRAY

Gets a SolidColorFill for the color Gray.

Remarks

This property will yield a frozen shared immutable value.

GREEN

Gets a SolidColorFill for the color Green.

Remarks

This property will yield a frozen shared immutable value.

GREEN_YELLOW

Gets a SolidColorFill for the color GreenYellow.

Remarks

This property will yield a frozen shared immutable value.

HONEYDEW

Gets a SolidColorFill for the color Honeydew.

Remarks

This property will yield a frozen shared immutable value.

HOT_PINK

Gets a SolidColorFill for the color HotPink.

Remarks

This property will yield a frozen shared immutable value.

INDIAN_RED

Gets a SolidColorFill for the color IndianRed.

Remarks

This property will yield a frozen shared immutable value.

INDIGO

Gets a SolidColorFill for the color Indigo.

Remarks

This property will yield a frozen shared immutable value.

IVORY

Gets a SolidColorFill for the color Ivory.

Remarks

This property will yield a frozen shared immutable value.

KHAKI

Gets a SolidColorFill for the color Khaki.

Remarks

This property will yield a frozen shared immutable value.

LAVENDER

Gets a SolidColorFill for the color Lavender.

Remarks

This property will yield a frozen shared immutable value.

LAVENDER_BLUSH

Gets a SolidColorFill for the color LavenderBlush.

Remarks

This property will yield a frozen shared immutable value.

LAWN_GREEN

Gets a SolidColorFill for the color LawnGreen.

Remarks

This property will yield a frozen shared immutable value.

LEMON_CHIFFON

Gets a SolidColorFill for the color LemonChiffon.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_BLUE

Gets a SolidColorFill for the color LightBlue.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_CORAL

Gets a SolidColorFill for the color LightCoral.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_CYAN

Gets a SolidColorFill for the color LightCyan.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_GOLDENROD_YELLOW

Gets a SolidColorFill for the color LightGoldenrodYellow.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_GRAY

Gets a SolidColorFill for the color LightGray.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_GREEN

Gets a SolidColorFill for the color LightGreen.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_PINK

Gets a SolidColorFill for the color LightPink.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_SALMON

Gets a SolidColorFill for the color LightSalmon.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_SEA_GREEN

Gets a SolidColorFill for the color LightSeaGreen.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_SKY_BLUE

Gets a SolidColorFill for the color LightSkyBlue.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_SLATE_GRAY

Gets a SolidColorFill for the color LightSlateGray.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_STEEL_BLUE

Gets a SolidColorFill for the color LightSteelBlue.

Remarks

This property will yield a frozen shared immutable value.

LIGHT_YELLOW

Gets a SolidColorFill for the color LightYellow.

Remarks

This property will yield a frozen shared immutable value.

LIME

Gets a SolidColorFill for the color Lime.

Remarks

This property will yield a frozen shared immutable value.

LIME_GREEN

Gets a SolidColorFill for the color LimeGreen.

Remarks

This property will yield a frozen shared immutable value.

LINEN

Gets a SolidColorFill for the color Linen.

Remarks

This property will yield a frozen shared immutable value.

MAGENTA

Gets a SolidColorFill for the color Magenta.

Remarks

This property will yield a frozen shared immutable value.

MAROON

Gets a SolidColorFill for the color Maroon.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_AQUAMARINE

Gets a SolidColorFill for the color MediumAquamarine.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_BLUE

Gets a SolidColorFill for the color MediumBlue.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_ORCHID

Gets a SolidColorFill for the color MediumOrchid.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_PURPLE

Gets a SolidColorFill for the color MediumPurple.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_SEA_GREEN

Gets a SolidColorFill for the color MediumSeaGreen.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_SLATE_BLUE

Gets a SolidColorFill for the color MediumSlateBlue.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_SPRING_GREEN

Gets a SolidColorFill for the color MediumSpringGreen.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_TURQUOISE

Gets a SolidColorFill for the color MediumTurquoise.

Remarks

This property will yield a frozen shared immutable value.

MEDIUM_VIOLET_RED

Gets a SolidColorFill for the color MediumVioletRed.

Remarks

This property will yield a frozen shared immutable value.

MIDNIGHT_BLUE

Gets a SolidColorFill for the color MidnightBlue.

Remarks

This property will yield a frozen shared immutable value.

MINT_CREAM

Gets a SolidColorFill for the color MintCream.

Remarks

This property will yield a frozen shared immutable value.

MISTY_ROSE

Gets a SolidColorFill for the color MistyRose.

Remarks

This property will yield a frozen shared immutable value.

MOCCASIN

Gets a SolidColorFill for the color Moccasin.

Remarks

This property will yield a frozen shared immutable value.

NAVAJO_WHITE

Gets a SolidColorFill for the color NavajoWhite.

Remarks

This property will yield a frozen shared immutable value.

NAVY

Gets a SolidColorFill for the color Navy.

Remarks

This property will yield a frozen shared immutable value.

OLD_LACE

Gets a SolidColorFill for the color OldLace.

Remarks

This property will yield a frozen shared immutable value.

OLIVE

Gets a SolidColorFill for the color Olive.

Remarks

This property will yield a frozen shared immutable value.

OLIVE_DRAB

Gets a SolidColorFill for the color OliveDrab.

Remarks

This property will yield a frozen shared immutable value.

ORANGE

Gets a SolidColorFill for the color Orange.

Remarks

This property will yield a frozen shared immutable value.

ORANGE_RED

Gets a SolidColorFill for the color OrangeRed.

Remarks

This property will yield a frozen shared immutable value.

ORCHID

Gets a SolidColorFill for the color Orchid.

Remarks

This property will yield a frozen shared immutable value.

PALE_GOLDENROD

Gets a SolidColorFill for the color PaleGoldenrod.

Remarks

This property will yield a frozen shared immutable value.

PALE_GREEN

Gets a SolidColorFill for the color PaleGreen.

Remarks

This property will yield a frozen shared immutable value.

PALE_TURQUOISE

Gets a SolidColorFill for the color PaleTurquoise.

Remarks

This property will yield a frozen shared immutable value.

PALE_VIOLET_RED

Gets a SolidColorFill for the color PaleVioletRed.

Remarks

This property will yield a frozen shared immutable value.

PAPAYA_WHIP

Gets a SolidColorFill for the color PapayaWhip.

Remarks

This property will yield a frozen shared immutable value.

PEACH_PUFF

Gets a SolidColorFill for the color PeachPuff.

Remarks

This property will yield a frozen shared immutable value.

PERU

Gets a SolidColorFill for the color Peru.

Remarks

This property will yield a frozen shared immutable value.

PINK

Gets a SolidColorFill for the color Pink.

Remarks

This property will yield a frozen shared immutable value.

PLUM

Gets a SolidColorFill for the color Plum.

Remarks

This property will yield a frozen shared immutable value.

POWDER_BLUE

Gets a SolidColorFill for the color PowderBlue.

Remarks

This property will yield a frozen shared immutable value.

PURPLE

Gets a SolidColorFill for the color Purple.

Remarks

This property will yield a frozen shared immutable value.

RED

Gets a SolidColorFill for the color Red.

Remarks

This property will yield a frozen shared immutable value.

ROSY_BROWN

Gets a SolidColorFill for the color RosyBrown.

Remarks

This property will yield a frozen shared immutable value.

ROYAL_BLUE

Gets a SolidColorFill for the color RoyalBlue.

Remarks

This property will yield a frozen shared immutable value.

SADDLE_BROWN

Gets a SolidColorFill for the color SaddleBrown.

Remarks

This property will yield a frozen shared immutable value.

SALMON

Gets a SolidColorFill for the color Salmon.

Remarks

This property will yield a frozen shared immutable value.

SANDY_BROWN

Gets a SolidColorFill for the color SandyBrown.

Remarks

This property will yield a frozen shared immutable value.

SEA_GREEN

Gets a SolidColorFill for the color SeaGreen.

Remarks

This property will yield a frozen shared immutable value.

SEA_SHELL

Gets a SolidColorFill for the color SeaShell.

Remarks

This property will yield a frozen shared immutable value.

SIENNA

Gets a SolidColorFill for the color Sienna.

Remarks

This property will yield a frozen shared immutable value.

SILVER

Gets a SolidColorFill for the color Silver.

Remarks

This property will yield a frozen shared immutable value.

SKY_BLUE

Gets a SolidColorFill for the color SkyBlue.

Remarks

This property will yield a frozen shared immutable value.

SLATE_BLUE

Gets a SolidColorFill for the color SlateBlue.

Remarks

This property will yield a frozen shared immutable value.

SLATE_GRAY

Gets a SolidColorFill for the color SlateGray.

Remarks

This property will yield a frozen shared immutable value.

SNOW

Gets a SolidColorFill for the color Snow.

Remarks

This property will yield a frozen shared immutable value.

SPRING_GREEN

Gets a SolidColorFill for the color SpringGreen.

Remarks

This property will yield a frozen shared immutable value.

STEEL_BLUE

Gets a SolidColorFill for the color SteelBlue.

Remarks

This property will yield a frozen shared immutable value.

TAN

Gets a SolidColorFill for the color Tan.

Remarks

This property will yield a frozen shared immutable value.

TEAL

Gets a SolidColorFill for the color Teal.

Remarks

This property will yield a frozen shared immutable value.

THISTLE

Gets a SolidColorFill for the color Thistle.

Remarks

This property will yield a frozen shared immutable value.

TOMATO

Gets a SolidColorFill for the color Tomato.

Remarks

This property will yield a frozen shared immutable value.

TRANSPARENT

Gets a SolidColorFill for the color Transparent.

Remarks

This property will yield a frozen shared immutable value.

TURQUOISE

Gets a SolidColorFill for the color Turquoise.

Remarks

This property will yield a frozen shared immutable value.

VIOLET

Gets a SolidColorFill for the color Violet.

Remarks

This property will yield a frozen shared immutable value.

WHEAT

Gets a SolidColorFill for the color Wheat.

Remarks

This property will yield a frozen shared immutable value.

WHITE

Gets a SolidColorFill for the color White.

Remarks

This property will yield a frozen shared immutable value.

WHITE_SMOKE

Gets a SolidColorFill for the color WhiteSmoke.

Remarks

This property will yield a frozen shared immutable value.

YELLOW

Gets a SolidColorFill for the color Yellow.

Remarks

This property will yield a frozen shared immutable value.

YELLOW_GREEN

Gets a SolidColorFill for the color YellowGreen.

Remarks

This property will yield a frozen shared immutable value.

Static Methods

from

(fillLike: Fill) : Fill

Creates a Fill instance from the given fill-like object by performing automatic type conversion.

Parameters

options - Object
A map of options to pass to the method.

fillLike - Fill: The object to convert to a Fill.

Returns

↪Fill: The given fillLike if it is already a Fill, or a new instance initialized to the values found in fillLike.

setFill

(fill: Fill, element: SVGElement, context: ICanvasContext)

Sets the Fill on a given SVG element as the fill.

Remarks

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 instance method counter part applyTo. However being static, it also allows for the case where the fill is null.

Parameters

options - Object
A map of options to pass to the method.

fill - Fill: The fill that should be applied. If null, the element's fill is set to none.
element - SVGElement: The SVG element whose fill should be set.
context - ICanvasContext: The context to use for managing possible defs entries.

See Also