TronDesigner Website Integration
    Preparing search index...

    Interface IEditorArgumentsOpenPrintJobBuilder

    Builder methods available after an existing print job has been selected. Use these methods to modify the loaded print job before opening it in the editor.

    interface IEditorArgumentsOpenPrintJobBuilder {
        addCustomProperties: (
            customProperties: Record<string, string>,
        ) => IEditorArgumentsBuilder;
        addCustomProperty: (key: string, value: string) => IEditorArgumentsBuilder;
        open: (options: DesignerOptions) => void;
        setOrderInfo: (
            orderTitle?: string,
            orderCode?: string,
            orderItemCode?: string,
        ) => IEditorArgumentsBuilder;
        setPrintJobCustomer: (
            customerIdentity?: string,
            customerPerson?: string,
            customerCompany?: string,
            customerEmail?: string,
        ) => IEditorArgumentsBuilder;
        setPrintJobTitle: (title: undefined | string) => IEditorArgumentsBuilder;
        addPrintingsToPrintJob(
            ...printings: ArgAddPrinting[],
        ): IEditorArgumentsOpenPrintJobBuilder;
        addPrintingToPrintJob(
            printPositionCode: string,
            printTechnologyCode: string,
            positionCodeOverride?: string,
            positionNameOverride?: string,
            technologyCodeOverride?: string,
            technologyNameOverride?: string,
            options?: Partial<
                Pick<
                    EditorOptions,
                    "showSelectedPrintOptions"
                    | "alwaysShowImageSelect",
                >,
            >,
            maxColorsOverride?: number,
            maxWidthOverride?: number,
            maxHeightOverride?: number,
            maxDiameterOverride?: number,
        ): IEditorArgumentsOpenPrintJobBuilder;
        addProductVariantsToPrintJob(
            ...variants: ArgAddProductVariant[],
        ): IEditorArgumentsOpenPrintJobBuilder;
        addProductVariantToPrintJob(
            productCode: string,
            quantity?: number,
            codeOverride?: string,
            nameOverride?: string,
        ): IEditorArgumentsOpenPrintJobBuilder;
        removePrintingFromPrintJob(
            printPositionCode: string,
            printTechnologyCode: string,
        ): IEditorArgumentsOpenPrintJobBuilder;
        removePrintingsFromPrintJob(
            removedPrintings: {
                printPositionCode: string;
                printTechnologyCode: string;
            }[],
        ): IEditorArgumentsOpenPrintJobBuilder;
        removeProductVariantFromPrintJob(
            productCode: string,
        ): IEditorArgumentsOpenPrintJobBuilder;
        removeProductVariantsFromPrintJob(
            productCodes: string[],
        ): IEditorArgumentsOpenPrintJobBuilder;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addCustomProperties addCustomProperty open setOrderInfo setPrintJobCustomer setPrintJobTitle

    Methods

    addPrintingsToPrintJob addPrintingToPrintJob addProductVariantsToPrintJob addProductVariantToPrintJob removePrintingFromPrintJob removePrintingsFromPrintJob removeProductVariantFromPrintJob removeProductVariantsFromPrintJob

    Properties

    addCustomProperties: (
        customProperties: Record<string, string>,
    ) => IEditorArgumentsBuilder

    Adds or updates multiple custom properties on the existing print job.

    Type declaration

      • (customProperties: Record<string, string>): IEditorArgumentsBuilder

      • Adds multiple custom properties to the print job.

        Parameters

        • customProperties: Record<string, string>

          Object containing key-value pairs of custom properties

        Returns IEditorArgumentsBuilder

    Object containing key-value pairs of custom properties

    addCustomProperty: (key: string, value: string) => IEditorArgumentsBuilder

    Adds or updates a custom property on the existing print job.

    Type declaration

    open: (options: DesignerOptions) => void

    Opens the editor using the configured existing print job arguments.

    Type declaration

      • (options: DesignerOptions): void

      • Opens the editor with previously set arguments.

        Parameters

        Returns void

    setOrderInfo: (
        orderTitle?: string,
        orderCode?: string,
        orderItemCode?: string,
    ) => IEditorArgumentsBuilder

    Sets order information for the existing print job.

    Type declaration

      • (
            orderTitle?: string,
            orderCode?: string,
            orderItemCode?: string,
        ): IEditorArgumentsBuilder

      • Sets order information for the print job.

        Parameters

        • OptionalorderTitle: string
        • OptionalorderCode: string
        • OptionalorderItemCode: string

        Returns IEditorArgumentsBuilder

    setPrintJobCustomer: (
        customerIdentity?: string,
        customerPerson?: string,
        customerCompany?: string,
        customerEmail?: string,
    ) => IEditorArgumentsBuilder

    Overrides customer information for the existing print job.

    Type declaration

      • (
            customerIdentity?: string,
            customerPerson?: string,
            customerCompany?: string,
            customerEmail?: string,
        ): IEditorArgumentsBuilder

      • Can be used to override the customer info specified by the customer guid attribute.

        Parameters

        • OptionalcustomerIdentity: string
        • OptionalcustomerPerson: string
        • OptionalcustomerCompany: string
        • OptionalcustomerEmail: string

        Returns IEditorArgumentsBuilder

    setPrintJobTitle: (title: undefined | string) => IEditorArgumentsBuilder

    Sets the title of the existing print job.

    Type declaration

    The title to set, or undefined to leave it unchanged

    Methods

    • Adds a print option to the existing print job. If the print option already exists, it is ignored.

      Parameters

      • printPositionCode: string

        Supplier/PTN print position code.

      • printTechnologyCode: string

        Supplier/PTN print technology code.

      • OptionalpositionCodeOverride: string

        Display code shown for the print position.

      • OptionalpositionNameOverride: string

        Display name shown for the print position.

      • OptionaltechnologyCodeOverride: string

        Display code shown for the print technology.

      • OptionaltechnologyNameOverride: string

        Display name shown for the print technology.

      • Optionaloptions: Partial<
            Pick<
                EditorOptions,
                "showSelectedPrintOptions"
                | "alwaysShowImageSelect",
            >,
        >

        Editor options applied while selecting/loading the new printing.

      • OptionalmaxColorsOverride: number

        Maximum color count override.

      • OptionalmaxWidthOverride: number

        Maximum print width override.

      • OptionalmaxHeightOverride: number

        Maximum print height override.

      • OptionalmaxDiameterOverride: number

        Maximum print diameter override.

      Returns IEditorArgumentsOpenPrintJobBuilder

    • Adds or updates a product variant in the existing print job. If the variant already exists, its quantity and display overrides are updated.

      Parameters

      • productCode: string

        Supplier/PTN product variant code.

      • Optionalquantity: number

        Variant quantity.

      • OptionalcodeOverride: string

        Display code shown for the product variant.

      • OptionalnameOverride: string

        Display name shown for the product variant.

      Returns IEditorArgumentsOpenPrintJobBuilder

    • Removes a printing from the existing print job.

      Parameters

      • printPositionCode: string

        Supplier/PTN print position code.

      • printTechnologyCode: string

        Supplier/PTN print technology code.

      Returns IEditorArgumentsOpenPrintJobBuilder

    • Removes multiple printings from the existing print job.

      Parameters

      • removedPrintings: { printPositionCode: string; printTechnologyCode: string }[]

        Print position and technology pairs to remove.

      Returns IEditorArgumentsOpenPrintJobBuilder

    Settings

    Member Visibility

    On This Page

    Properties
    Methods