elm-community / typed-svg / TypedSvg.Filters.Attributes

Attributes of SVG filter elements

Attributes

azimuth : Basics.Float -> TypedSvg.Core.Attribute msg

The azimuth attribute represents the direction angle of the light source on the XY plane (clockwise), in degrees from the x axis.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.distantLight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/azimuth

baseFrequency : Basics.Float -> Basics.Float -> TypedSvg.Core.Attribute msg

The baseFrequency attribute represents the frequency parameter for the noise function of the Filters.turbulence primitive. The first Float represents a base frequency in the X direction and the second value represents a base frequency in the Y direction.

Negative values are forbidden.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.turbulence

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/baseFrequency

bias : Basics.Float -> TypedSvg.Core.Attribute msg

The bias attribute shifts the range of a filter. After applying the kernelMatrix of the Filters.convolveMatrix element to the input image to yield a Float and applying the divisor attribute, the bias attribute is added to each component. This allows representation of values that would otherwise be clamped to 0 or 1.

If bias is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/bias

colorInterpolationFilters : TypedSvg.Types.ColorInterpolation -> TypedSvg.Core.Attribute msg

The colorInterpolationFilters attribute specifies the color space for imaging operations performed via filter effects.

Note that colorInterpolationFilters has a different initial value than colorInterpolation. colorInterpolationFilters has an initial value of linearRGB, whereas color-interpolation has an initial value of sRGB. Thus, in the default case, filter effects operations occur in the linearRGB color space, whereas all other color interpolations occur by default in the sRGB color space.

As a presentation attribute, it also can be used as a property directly inside a CSS stylesheet.

Used by Elements: Filters.blend, Filters.colorMatrix, Filters.componentTransfer, Filters.composite, Filters.convolveMatrix, Filters.diffuseLighting, Filters.displacementMap, Filters.gaussianBlur, Filters.morphology, Filters.offset, Filters.specularLighting, Filters.tile

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/color-interpolation-filters

colorMatrixType : TypedSvg.Types.ColorMatrixType -> TypedSvg.Core.Attribute msg

Indicates the type of matrix operation. The keyword matrix indicates that a full 5x4 matrix of values will be provided. The other keywords represent convenience shortcuts to allow commonly used color operations to be performed without specifying a complete matrix.

Used by Elements: Filters.colorMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/type

colorMatrixValues : String -> TypedSvg.Core.Attribute msg

Contents of colorMatrixValues depends on the value of the attribute type.

Used by Elements: Filters.colorMatrix

NOTE: this is called values in elm-lang/svg but is different here in order to differentiate from animationValues.

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/values

compositeOperator : TypedSvg.Types.CompositeOperator -> TypedSvg.Core.Attribute msg

compositeOperator defines the compositing operation that is to be performed in the Filters.composite element

Used by Elements: Filters.composite

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/operator

diffuseConstant : Basics.Float -> TypedSvg.Core.Attribute msg

The diffuseConstant attribute represant the kd value in the Phong lighting model. In SVG, this can be any non-negative number.

If the attribute is not specified, then the effect is as if a value of 1 were specified.

Used by Elements: Filters.diffuseLighting

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/diffuseConstant

divisor : Basics.Float -> TypedSvg.Core.Attribute msg

After applying the kernelMatrix of the Filters.convolveMatrix element to the input image to yield a number, that Float is divided by the value given to the divisor attribute to yield the final destination color value. A divisor that is the sum of all the matrix values tends to have an evening effect on the overall color intensity of the result.

The default value is the sum of all values in kernelMatrix, with the exception that if the sum is zero, then the divisor is set to 1.

It is an error to specify a divisor of zero.

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/divisor

edgeMode : TypedSvg.Types.EdgeMode -> TypedSvg.Core.Attribute msg

The edgeMode attribute determines how to extend the input image as necessary with color values so that the matrix operations can be applied when the kernel is positioned at or near the edge of the input image.

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/edgeMode

elevation : Basics.Float -> TypedSvg.Core.Attribute msg

The elevation attribute represents the direction angle for a light source from the XY plane towards the Z axis, in degrees. Note the positive Z-axis points towards the viewer of the content.

Used by Elements: Filters.distantLight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/elevation

filterRes : Basics.Float -> Basics.Float -> TypedSvg.Core.Attribute msg

A filter element can define a region to which a given filter effect applies and can provide a resolution for any intermediate continuous tone images used to process any raster-based filter primitives.

NOTE: Obsolete.

Used by Elements: Filters.filter

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/filterRes

filterUnits : TypedSvg.Types.CoordinateSystem -> TypedSvg.Core.Attribute msg

The filterUnits attribute defines the coordinate system for attributes x, y, width and height.

Used by Elements: Filters.filter

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/filterUnits

floodColor : TypedSvg.Types.FloodColor -> TypedSvg.Core.Attribute msg

The floodColor attribute indicates what color to use to flood the current filter primitive subregion defined through the Filters.flood element. The keyword currentColor and ICC colors can be specified in the same manner as within a paint specification for the fill and stroke attributes.

As a presentation attribute, it also can be used as a property directly inside a CSS stylesheet.

Used by Elements: Filters.flood

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/flood-color

floodOpacity : TypedSvg.Types.Opacity -> TypedSvg.Core.Attribute msg

The floodOpacity attribute indicates the opacity value to use across the current filter primitive subregion defined through the Filters.flood element.

Used by Elements: Filters.flood

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/flood-opacity

funcType : TypedSvg.Types.FuncType -> TypedSvg.Core.Attribute msg

Indicates the type of component transfer function.

Used by Elements: Filters.funcR, Filters.funcG, Filters.funcA, Filters.funcB

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/type

in2 : TypedSvg.Types.InValue -> TypedSvg.Core.Attribute msg

The in2 attribute identifies the second input for the given filter primitive. It works exactly like the in attribute.

Used by Elements: Filters.blend, Filters.colorMatrix, Filters.componentTransfer, Filters.composite, Filters.convolveMatrix, Filters.diffuseLighting, Filters.displacementMap, Filters.gaussianBlur, Filters.morphology, Filters.offset, Filters.specularLighting, Filters.tile

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/in2

in_ : TypedSvg.Types.InValue -> TypedSvg.Core.Attribute msg

The in_ attribute identifies input for the given filter primitive.

Takes type InValue, which can be one of 6 constants, or a reference

If no value is provided and this is the first filter primitive, then this filter primitive will use InSourceGraphic as its input.

If no value is provided and this is a subsequent filter primitive, then this filter primitive will use the result from the previous filter primitive as its input.

Used by Elements: Filters.blend, Filters.colorMatrix, Filters.componentTransfer, Filters.composite, Filters.convolveMatrix, Filters.diffuseLighting, Filters.displacementMap, Filters.gaussianBlur, Filters.morphology, Filters.offset, Filters.specularLighting, Filters.tile

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/in

k1 : Basics.Float -> TypedSvg.Core.Attribute msg

The k1 attribute defines one of the values to be used within the arithmetic operation of the Filters.composite filter primitive.

If this attribute is not set, its default value is 0.

Used by Elements: Filters.composite

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/k1

k2 : Basics.Float -> TypedSvg.Core.Attribute msg

The k2 attribute defines one of the values to be used within the arithmetic operation of the Filters.composite filter primitive.

If this attribute is not set, its default value is 0.

Used by Elements: Filters.composite

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/k2

k3 : Basics.Float -> TypedSvg.Core.Attribute msg

The k3 attribute defines one of the values to be used within the arithmetic operation of the Filters.composite filter primitive.

If this attribute is not set, its default value is 0.

Used by Elements: Filters.composite

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/k3

k4 : Basics.Float -> TypedSvg.Core.Attribute msg

The k4 attribute defines one of the values to be used within the arithmetic operation of the Filters.composite filter primitive.

If this attribute is not set, its default value is 0.

Used by Elements: Filters.composite

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/k4

kernelMatrix : List Basics.Float -> TypedSvg.Core.Attribute msg

The order attribute defines the list of numbers that makes up the kernel matrix for the Filters.convolveMatrix element.

The Float of entries in the list must be equal to orderX x orderY, as defined in the order attribute.

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/kernelMatrix

kernelUnitLength : Basics.Float -> Basics.Float -> TypedSvg.Core.Attribute msg

The kernelUnitLength attribute has two meaning based on the context it's used:

Used by Elements: Filters.convolveMatrix, Filters.diffuseLighting, Filters.specularLighting

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/kernelUnitLength

limitingConeAngle : Basics.Float -> TypedSvg.Core.Attribute msg

The limitingConeAngle attribute represents the angle in degrees between the spot light axis (i.e. the axis between the light source and the point to which it is pointing at) and the spot light cone. So it defines a limiting cone which restricts the region where the light is projected. No light is projected outside the cone.

If no value is specified, then no limiting cone will be applied.

Used by Elements: Filters.spotlight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/limitingConeAngle

mode : TypedSvg.Types.Mode -> TypedSvg.Core.Attribute msg

The mode attribute defines the blending mode on the Filters.blend filter primitive.

Used by Elements: Filters.blend

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/mode

morphologyOperator : TypedSvg.Types.MorphologyOperator -> TypedSvg.Core.Attribute msg

morphologyOperator defines the compositing operation that is to be performed in the feMorphology element

Used by Elements: Filters.morphology

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/operator

numOctaves : Basics.Int -> TypedSvg.Core.Attribute msg

The numOctaves parameter for the noise function of the Filters.turbulence primitive.

If the attribute is not specified, then the effect is as if a value of 1 were specified.

Used by Elements: Filters.turbulence

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/

order : Basics.Float -> Basics.Float -> TypedSvg.Core.Attribute msg

The order attribute indicates the size of the matrix to be used by an Filters.convolveMatrix element.

The values provided must be integers greater than zero. The first number, orderX, indicates the Float of columns in the matrix. The second number, orderY, indicates the Float of rows in the matrix.

A typical value is order="3". It is recommended that only small values (e.g., 3) be used; higher values may result in very high CPU overhead and usually do not produce results that justify the impact on performance.

If the attribute is not specified, the effect is as if a value of 3 were specified.

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/order

pointsAtX : Basics.Float -> TypedSvg.Core.Attribute msg

The pointsAtX attribute represent the X location in the coordinate system established by attribute primitiveUnits on the filter element of the point at which the light source is pointing.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.spotlight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/pointsAtX

pointsAtY : Basics.Float -> TypedSvg.Core.Attribute msg

The pointsAtY attribute represent the Y location in the coordinate system established by attribute primitiveUnits on the filter element of the point at which the light source is pointing.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.spotlight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/pointsAtY

pointsAtZ : Basics.Float -> TypedSvg.Core.Attribute msg

The pointsAtZ attribute represents the Z location in the coordinate system established by attribute primitiveUnits on the filter element of the point at which the light source is pointing.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.spotlight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/pointsAtZ

preserveAlpha : Basics.Bool -> TypedSvg.Core.Attribute msg

The preserveAlpha attribute indicates how an feConvolveMatrix element handles alpha transparency.

A value of false indicates that the convolution matrix will apply to all channels, including the alpha channel. This is the default value.

A value of true indicates that the convolution matrix will only apply to the color channels.

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAlpha

radius : Basics.Float -> Basics.Float -> TypedSvg.Core.Attribute msg

The radius attribute represent the radius for the operation on a given feMorphology filter primitive. The values are in the coordinate system established by the primitiveUnits attribute on the filter element.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.morphology

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/radius

result : String -> TypedSvg.Core.Attribute msg

The result attribute defines the assigned name for this filter primitive. If supplied, then graphics that result from processing this filter primitive can be referenced by an in attribute on a subsequent filter primitive within the same filter element.

If no value is provided, the output will only be available for re-use as the implicit input into the next filter primitive if that filter primitive provides no value for its in attribute.

Used by Elements: feBlend, feColorMatrix, feComponentTransfer, feComposite, feConvolveMatrix, feDiffuseLighting, feDisplacementMap, feDropShadow, feFlood,feFuncA, feFuncB, feFuncG, feFuncR,feGaussianBlur, feImage, feMerge, feMergeNode, feMorphology, feOffset, feSpecularLighting, feTile, feTurbulence

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/result

scale : Basics.Float -> TypedSvg.Core.Attribute msg

The scale attribute define the displacement scale factor to be used on a Filters.displacementMap filter primitive. The amount is expressed in the coordinate system established by the primitiveUnits attribute on the filter element.

When the value of this attribute is 0, this operation has no effect on the source image.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.displacementMap

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/scale

seed : Basics.Float -> TypedSvg.Core.Attribute msg

The seed attribute represents the starting Float for the pseudo random number generator of the Filters.turbulence primitive.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.turbulence

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/seed

surfaceScale : Basics.Float -> TypedSvg.Core.Attribute msg

The surfaceScale attribute represents the height of the surface for a light filter primitive.

If the attribute is not specified, then the effect is as if a value of 1 were specified.

Used by Elements: Filters.diffuseLighting, Filters.specularLighting

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/surfaceScale

targetX : Basics.Float -> TypedSvg.Core.Attribute msg

The targetX attribute determines the positioning in X of the convolution matrix relative to a given target pixel in the input image. The leftmost column of the matrix is column Float zero. The value must be such that:

0 <= targetX < orderX

By default, the convolution matrix is centered in X over each pixel of the input image (i.e., targetX = floor ( orderX / 2 )).

Used by Elements: convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/targetX

targetY : Basics.Float -> TypedSvg.Core.Attribute msg

The targetY attribute determines the positioning in Y of the convolution matrix relative to a given target pixel in the input image. The topmost row of the matrix is row Float zero. The value must be such that:

0 <= targetY < orderY

By default, the convolution matrix is centered in Y over each pixel of the input image (i.e., targetY = floor ( orderY / 2 )).

Used by Elements: Filters.convolveMatrix

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/targetY

turbulenceType : TypedSvg.Types.TurbulenceType -> TypedSvg.Core.Attribute msg

Indicates whether the filter primitive should perform a noise or turbulence function.

Used by Elements: Filters.turbulence

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/type

z : Basics.Float -> TypedSvg.Core.Attribute msg

The z attribute difines the location along the Z-axis for a light source in the coordinate system established by the primitiveUnits attribute on the filter element, assuming that, in the initial coordinate system, the positive Z-axis comes out towards the person viewing the content and assuming that one unit along the Z-axis equals on unit in X and Z.

If the attribute is not specified, then the effect is as if a value of 0 were specified.

Used by Elements: Filters.pointlight, Filters.spotlight

See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/z