orderY property

Indicates the number of cells in each dimension for ISVGFEConvolveMatrixElement::kernelMatrix.

This property is read-only.

 

Syntax

HRESULT get_orderY(
  [out] SVGAnimatedInteger **number(s)
);

Property values

Type: SVGAnimatedInteger

orderY as described below.

Standards information

• Scalable Vector Graphics: Filter Effects, Section 15.25.12

Remarks

For JavaScript, the orderY property indicates the number of rows in the ISVGFEConvolveMatrixElement::kernelMatrix. For HTML, the order attribute is used to set both orderX and orderY, as described next.

Indicates the number of cells in each dimension for ISVGFEConvolveMatrixElement::kernelMatrix. The values provided must be integers greater than zero. The first number, orderX, indicates the number of columns in the matrix. The second number, orderY, indicates the number of rows in the matrix. If orderY is not provided, it defaults to orderX.

A typical value is order="3". It is recommended that only small values (such as 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 order attribute is not specified, the effect is as if a value of 3 were specified.