DS Server

Javascript: Image.setVerticalScaling Method

Method|Introduced in 28.0

Description

Sets an images's vertical scaling factor in percent.

Syntax

<void> Image.setVerticalScaling(<number> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
value

The new property value.

callback

Optional. Is called when the operation completed.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates Image.setVerticalScaling in a practical document-editing workflow. It sets an images's vertical scaling factor in percent.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.images.getItem(function(image) {
    if (!image) {
        console.warn("No image is available at the current input position.");
        return;
    }

    image.setVerticalScaling(
        1,
        function() {
            console.log("set vertical scaling completed.");
        },
        onTxError
    );
}, onTxError);