The BarcodeController is responsible for all communication regarding Barcodes. Methods inside this controller can be called by window.SDK.barcode.{method-name}

Hierarchy

  • BarcodeController

Methods

  • Experimental

    This method will remove the source from the barcode frame provided.

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to have the source removed.

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method sets the combined state of the quiet zone values.

    Parameters

    • id: string

      The id of the specific barcode frame

    • value: boolean

      Whether the quiet zone values are combined

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method will set the barcode background color of a specified barcode frame.

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to be updated.

    • backgroundColor: ColorUsage

      the new barcode background color that you want to set to the barcodeFrame.

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method sets the bar height for 1-dimensional barcodes.

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to be updated.

    • barHeight: string

      the height of the bars in the barcode. The string value will be calculated (f.e. 1+1 will result in 2)

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method will set the background of a barcode enabled or disabled

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to be updated.

    • enableBackground: boolean

      Whether the barcode's background is visible.

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method will set the visibility of the barcode's bars.

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to be updated.

    • enableBars: boolean

      Whether the barcode bars are visible.

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method enables/disables displaying the text of the barcode.

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to be updated.

    • enableText: boolean

      true if the text should be displayed, false otherwise.

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method sets the magnification for 1-dimensional barcodes.

    Returns

    Parameters

    • id: string

      the id of the barcodeFrame that needs to be updated.

    • magnification: number

      the magnification of the barcode. This is a decimal value where 1 denotes 100%. (f.e. 1.5 will result in 150%)

    Returns Promise<EditorResponse<null>>

  • Experimental

    This method sets the quiet zone value of a specific barcode.

    Parameters

    • id: string

      The id of the specific barcode frame

    • value: string

      The quiet zone value

    • Optional position: PositionEnum

      When defined will update the quiet value of a single position, otherwise will set all positions to the same value. Depending on this parameter being defined, the areQuietZoneValuesCombined will also be updated.

    Returns Promise<EditorResponse<null>>

Generated using TypeDoc