TronDesigner Website Integration
    Preparing search index...

    Class EditorArgumentsBuilder

    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.

    Implements

    Index

    Constructors

    Methods

    • 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

    • Parameters

      • modelCode: string
      • modelName: string
      • Optionaldescription: string
      • Optionalquantity: number
      • Optionaloptions: Pick<
            Partial<
                Pick<EditorOptions, "showSelectedVariants" | "showQuantityInputs">,
            >,
            "showQuantityInputs",
        >

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

    • Sets an already existing print job to be opened.

      Parameters

      • printJobGuid: string
      • mode: "Edit" | "View" = 'View'

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

      Returns 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