.. _auto_math_offset:

*OFFSET A VALUE*
================

Adds a numeric offset to a scalar value and returns the result as a formatted string. Use this worker wherever a simple additive shift of a single number is needed inside a workflow.

When to use
-----------

Classification: **process**.

Tagged: ``arithmetic``, ``formatting``, ``math``, ``offset``, ``scalar``, ``transform``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Data To Be Offset
     - datatobeoffset
     - scalar
     - —
     - ✓
     - The numeric scalar value to be offset; this is the base number to which the offset will be added.
   * - Offset
     - offset
     - float
     - 0
     - 
     - The numeric amount to add to the input value; defaults to 0 (no shift).
   * - Format
     - format
     - scalar
     - %20.4f
     - 
     - C-style printf format string controlling how the result is rendered (e.g. '%20.4f' for a 20-wide, 4-decimal float); defaults to '%20.4f'.
   * - Trim Spaces
     - trim
     - scalar
     - no
     - 
     - Whether to strip leading/trailing whitespace from the formatted result; set to 'yes' when the output is used in concatenated strings or keyword fields; defaults to 'no'.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - math_offset_output_1
     - math_offset_output_1
     - scalar
     - The offset result returned as a formatted string, shaped by the 'format' and 'trim' inputs.

Disciplines
-----------

- data.curve.transform
- data.units

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=math_offset <https://www.d3view.com/api/workflow/example?id=math_offset>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>math_offset</code>. Schema hash: <code>7314357ae97d</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>