TronDesigner Website Integration
    Preparing search index...

    Interface IEditorArgumentsBuilder

    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 IEditorArgumentsBuilder {
        addCustomProperties(
            customProperties: Record<string, string>,
        ): IEditorArgumentsBuilder;
        addCustomProperty(key: string, value: string): IEditorArgumentsBuilder;
        addEditorButton(button: EditorButton): IEditorArgumentsBuilder;
        addExactPrinting(
            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,
            maxAreaOverride?: number,
        ): IEditorArgumentsBuilder;
        addExactPrintings(
            options?: Partial<
                Pick<
                    EditorOptions,
                    "showSelectedPrintOptions"
                    | "alwaysShowImageSelect",
                >,
            >,
            ...printings: ArgAddPrinting[],
        ): IEditorArgumentsBuilder;
        addOwnPrinting(
            positionCode: string,
            positionName: string,
            technologyCode: string,
            technologyName: string,
            colorMode: ColorMode,
            maxColors?: number,
            maxWidth?: number,
            maxHeight?: number,
            maxDiameter?: number,
            maxArea?: number,
            backgroundUrls?: string[],
            options?: Partial<
                Pick<
                    EditorOptions,
                    "showSelectedPrintOptions"
                    | "alwaysShowImageSelect",
                >,
            >,
        ): Pick<IEditorArgumentsBuilder, "open" | "addOwnPrinting">;
        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;
        open(options: DesignerOptions): void;
        removePrintingFromPrintJob(
            printPositionCode: string,
            printTechnologyCode: string,
        ): IEditorArgumentsOpenPrintJobBuilder;
        removePrintingsFromPrintJob(
            removedPrintings: {
                printPositionCode: string;
                printTechnologyCode: string;
            }[],
        ): IEditorArgumentsOpenPrintJobBuilder;
        removeProductVariantFromPrintJob(
            productCode: string,
        ): IEditorArgumentsOpenPrintJobBuilder;
        removeProductVariantsFromPrintJob(
            productCodes: string[],
        ): IEditorArgumentsOpenPrintJobBuilder;
        setDefaultPrintJobLogo(logo: ArgPrintingLogo): IEditorArgumentsBuilder;
        setEditorButtons(buttons: EditorButton[]): IEditorArgumentsBuilder;
        setExactProduct(
            supplierCode?: string,
            supplierGuid?: string,
            buildProduct?: (
                productBuilder: IEditorArgumentsExactProductBuilder,
            ) => void,
        ): IEditorArgumentsBuilder;
        setLastAddedPrintingLogo(logo: ArgPrintingLogo): IEditorArgumentsBuilder;
        setOpenMode(mode: OpenMode): IEditorArgumentsBuilder;
        setOrderInfo(
            orderTitle?: string,
            orderCode?: string,
            orderItemCode?: string,
        ): IEditorArgumentsBuilder;
        setOwnEmptyProduct(): Pick<
            IEditorArgumentsBuilder,
            "open"
            | "addOwnPrinting",
        >;
        setOwnProductSingleDimension(
            modelCode: string,
            modelName: string,
            isDimension1Color: boolean,
            description?: string,
            buildProduct?: (
                productBuilder: IEditorArgumentsOwnSingleDimensionProductBuilder,
            ) => void,
            options?: Partial<
                Pick<EditorOptions, "showSelectedVariants" | "showQuantityInputs">,
            >,
        ): IEditorArgumentsBuilder;
        setOwnProductSingleVariant(
            modelCode: string,
            modelName: string,
            description?: string,
            quantity?: number,
        ): Pick<IEditorArgumentsBuilder, "open" | "addOwnPrinting">;
        setOwnProductTwoDimensions(
            modelCode: string,
            modelName: string,
            isDimension1Color: boolean,
            description?: string,
            buildProduct?: (
                productBuilder: IEditorArgumentsOwnTwoDimensionsProductBuilder,
            ) => void,
        ): IEditorArgumentsBuilder;
        setPartialProduct(
            supplierCode?: string,
            supplierGuid?: string,
            buildProduct?: (
                productBuilder: IEditorArgumentsPartialProductBuilder,
            ) => void,
            options?: Partial<
                Pick<EditorOptions, "showSelectedVariants" | "showQuantityInputs">,
            >,
        ): IEditorArgumentsBuilder;
        setPrintJob(
            printJobGuid: string,
            mode: "Edit",
        ): IEditorArgumentsOpenPrintJobBuilder;
        setPrintJob(
            printJobGuid: string,
            mode?: "View",
        ): Pick<IEditorArgumentsBuilder, "open">;
        setPrintJobCustomer(
            customerIdentity?: string,
            customerPerson?: string,
            customerCompany?: string,
            customerEmail?: string,
        ): IEditorArgumentsBuilder;
        setPrintJobLanguage(languageCode: string): IEditorArgumentsBuilder;
        setPrintJobTitle(title: undefined | string): IEditorArgumentsBuilder;
        setProofreadingTemplateTag(tag: string): IEditorArgumentsBuilder;
        setResultActionCloseEditor(redirectUrl?: string): IEditorArgumentsBuilder;
        setResultActionNone(): IEditorArgumentsBuilder;
        setResultActionShowDialog(
            dialogLocalizations: EditorResultDialog[],
            redirectUrl?: string,
        ): IEditorArgumentsBuilder;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    addCustomProperties addCustomProperty addEditorButton addExactPrinting addExactPrintings addOwnPrinting addPrintingsToPrintJob addPrintingToPrintJob addProductVariantsToPrintJob addProductVariantToPrintJob open removePrintingFromPrintJob removePrintingsFromPrintJob removeProductVariantFromPrintJob removeProductVariantsFromPrintJob setDefaultPrintJobLogo setEditorButtons setExactProduct setLastAddedPrintingLogo setOpenMode setOrderInfo setOwnEmptyProduct setOwnProductSingleDimension setOwnProductSingleVariant setOwnProductTwoDimensions setPartialProduct setPrintJob setPrintJobCustomer setPrintJobLanguage setPrintJobTitle setProofreadingTemplateTag setResultActionCloseEditor setResultActionNone setResultActionShowDialog

    Methods

    • Adds multiple custom properties to the print job.

      Parameters

      • customProperties: Record<string, string>

        Object containing key-value pairs of custom properties

      Returns IEditorArgumentsBuilder

    • Adds a custom property to the print job.

      Parameters

      • key: string
      • value: string

      Returns IEditorArgumentsBuilder

    • Adds a new printing with TronCloud position and technology codes.

      Parameters

      • printPositionCode: string

        TronCloud mockup print position code

      • printTechnologyCode: string

        TronCloud mockup print technology code

      • OptionalpositionCodeOverride: string

        Optional override for the position code

      • OptionalpositionNameOverride: string

        Optional override for the position name

      • OptionaltechnologyCodeOverride: string

        Optional override for the technology code

      • OptionaltechnologyNameOverride: string

        Optional override for the technology name

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

        Options for displaying the printing in the editor

      • OptionalmaxColorsOverride: number

        Optional override for maximum number of colors

      • OptionalmaxWidthOverride: number

        Optional override for maximum width

      • OptionalmaxHeightOverride: number

        Optional override for maximum height

      • OptionalmaxDiameterOverride: number

        Optional override for maximum diameter

      • OptionalmaxAreaOverride: number

        Optional override for maximum area

      Returns IEditorArgumentsBuilder

    • Adds multiple printings with exact position and technology codes.

      Parameters

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

        Options for displaying the printings in the editor

      • ...printings: ArgAddPrinting[]

        Array of printings to add

      Returns IEditorArgumentsBuilder

    • Parameters

      • positionCode: string
      • positionName: string
      • technologyCode: string
      • technologyName: string
      • colorMode: ColorMode
      • OptionalmaxColors: number
      • OptionalmaxWidth: number
      • OptionalmaxHeight: number
      • OptionalmaxDiameter: number
      • OptionalmaxArea: number
      • OptionalbackgroundUrls: string[]
      • Optionaloptions: Partial<
            Pick<
                EditorOptions,
                "showSelectedPrintOptions"
                | "alwaysShowImageSelect",
            >,
        >

      Returns Pick<IEditorArgumentsBuilder, "open" | "addOwnPrinting">

    • 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

    • Opens the editor with previously set arguments.

      Parameters

      Returns void

    • Sets order information for the print job.

      Parameters

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

      Returns IEditorArgumentsBuilder

    • Parameters

      • modelCode: string
      • modelName: string
      • Optionaldescription: string
      • Optionalquantity: number

      Returns Pick<IEditorArgumentsBuilder, "open" | "addOwnPrinting">

    • Sets an already existing print job to be opened.

      Parameters

      • printJobGuid: string
      • mode: "Edit"

        Mode in which the editor should be opened. If not specified, defaults to 'View'

      Returns IEditorArgumentsOpenPrintJobBuilder

    • Parameters

      • printJobGuid: string
      • Optionalmode: "View"

      Returns Pick<IEditorArgumentsBuilder, "open">

    • 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

    • Can be used to override the language in which the product and printing data will be loaded

      Parameters

      • languageCode: string

        ISO-2 Code of the language

      Returns IEditorArgumentsBuilder

    • Sets the title of the print job.

      Parameters

      • title: undefined | string

        The title to set, or undefined to leave it unspecified

      Returns IEditorArgumentsBuilder

    • Configures editor to close the editor when user confirms the print job final verification.

      Parameters

      • OptionalredirectUrl: string

        Optional URL to redirect to after closing the editor

      Returns IEditorArgumentsBuilder

    • Configures editor to show a dialog when user confirms the print job final verification.

      Parameters

      • dialogLocalizations: EditorResultDialog[]

        Localizations for the dialog to be shown

      • OptionalredirectUrl: string

        Optional URL to redirect to after closing the dialog

      Returns IEditorArgumentsBuilder

    Settings

    Member Visibility

    On This Page

    Methods