jQuery.scaleFrame.js

If jQuery.fn.scaleFrame() has already been applied to an element, remove it first and then re-create it using this newest call. Without this option set to true, if your selector includes elements that already have jQuery.fn.scaleFrame() applied, they will be skipped on the subsequent call.

Additional CSS class name to apply to the wrapping element. This can be a single class name or multiple class names. The names should be in the format of a normal HTML "class" attribute.

Setting the "zoom" option to a positive value greater than 0 will enable the zoom controls to appear with the affected <IFRAME> and the incremental controls will zoom by the amount given in the "zoom" option.

When setting the value for the "zoom" option, you may want to start with a small floating-point value. An equivalent zoom of 100% is a "zoom" option value of 1 and an equivalent zoom of 50% is a "zoom" option value of 0.5.

The zoom controls container is a <UL> element and does not have any default styling. The zoom controls themselves are made up of a <LI> elements and do not have any default styling. To stle these elements, see the "zoomClass" option.

There is a final <LI> element at the end of the zoom controls container with a "style" attribute of "clear: both;". This final <LI> is a safguard allowing you to style the individual control elements in any way you choose, including floating them.

Totally irrelevant if not using the "zoom" option.

Additional CSS class name to apply to the zoom controls <UL> element and its child <LI> elements. This should be a single class name.

The child <LI> elements will all have a class applied with "-item" appended to the "zoomClass" option. Additionally, the child <LI> elements will each have their type appended to this class name for convenience. For example, the "min" zoom control will have "-min" appended to the class name.

Here is some sample CSS assuming that the "zoomClass" option is set to "my-nav-class".

.my-nav-class {
   /* the nav container <UL> element */
}
.my-nav-class-item {
   /* affects all nav children */
}
.my-nav-class-max {
   /* affects only the "max" zoom nav control */
}
.my-nav-class-min {
   /* affects only the "min" zoom nav control */
}
.my-nav-class-minus {
   /* affects only the "minus" zoom nav control */
}
.my-nav-class-plus {
   /* affects only the "plus" zoom nav control */
}
.my-nav-class-reset {
   /* affects only the "reset" zoom nav control */
}
.my-nav-class-whole {
   /* affects only the "100%" zoom nav control */
}

Totally irrelevant if not using the "zoom" option.

Maximum amount that the frame can be scaled using the zoom controls. Must be a value of at least 0.

Totally irrelevant if not using the "zoom" option.

Minimum amount that the frame can be scaled using the zoom controls. Must be a value of at least 0.

Totally irrelevant if not using the "zoom" option.

This is an Array containing the names of individual zoom controls to include. If this Array is empty, no controls will be added. The order of this Array dictates the order in which the individual controls will appear.

The types of controls are as follows.

• max Scales the scale of the <IFRAME> directly to the value set in the "zoomMax" option.
• min Scales the scale of the <IFRAME> directly to the value set in the "zoomMin" option.
• minus Decrements the scale of the <IFRAME> by the value set in the "zoom" option.
• plus Increments the scale of the <IFRAME> by the value set in the "zoom" option.
• reset Scales the scale of the <IFRAME> directly to its original scal value.
• whole Scales the scale of the <IFRAME> directly to 100% of its size.

Totally irrelevant if not using the "zoom" option or if not using "max" in the "zoomControls" option.

String value which dictates the contents of the "max" zoom control. Strings containing HTMl are allowed.

Totally irrelevant if not using the "zoom" option or if not using "min" in the "zoomControls" option.

String value which dictates the contents of the "min" zoom control. Strings containing HTMl are allowed.

Totally irrelevant if not using the "zoom" option or if not using "minus" in the "zoomControls" option.

String value which dictates the contents of the "minus" zoom control. Strings containing HTMl are allowed.

Totally irrelevant if not using the "zoom" option or if not using "plus" in the "zoomControls" option.

String value which dictates the contents of the "plus" zoom control. Strings containing HTMl are allowed.

Totally irrelevant if not using the "zoom" option or if not using "reset" in the "zoomControls" option.

String value which dictates the contents of the "reset" zoom control. Strings containing HTMl are allowed.

Totally irrelevant if not using the "zoom" option or if not using "whole" in the "zoomControls" option.

String value which dictates the contents of the "whole" zoom control. Strings containing HTMl are allowed.

This is a duplicate of the function bpmv.incall(), which is part of one of my other projects: bpmv.js. Please see that project's documentation on bpmv.incall() for a full explanation of its syntax.

This will read the CSS transform matrix() from a matched element or set of matched elements. If only one element is matched, jQuery.fn.readMatrix() will return a single six-value array representing the matrix(). If multiple elements are matched, jQuery.fn.readMatrix() will return an array of six-value arrays representing the matrix() of each matched element.

This will read the CSS transform scale() from a matched element or set of matched elements. If only one element is matched, jQuery.fn.readScale() will return a single two-value array representing the scale(). If multiple elements are matched, jQuery.fn.readScale() will return an array of two-value arrays representing the scale() of each matched element.