TronDesigner Website Integration
    Preparing search index...
    interface IEditorArgumentsBuilder {
        addCustomProperties(
            customProperties: Record<string, string>,
        ): IEditorArgumentsBuilder;
        addCustomProperty(key: string, value: string): IEditorArgumentsBuilder;
        addExactPrinting(
            printPositionCode: string,
            printTechnologyCode: string,
            positionCodeOverride?: string,
            positionNameOverride?: string,
            technologyCodeOverride?: string,
            technologyNameOverride?: string,
            options?: Partial<
                Pick<
                    EditorOptions,
                    "showSelectedPrintOptions"
                    | "alwaysShowImageSelect",
                >,
            >,
        ): 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,
            backgroundUrls?: string[],
            options?: Partial<
                Pick<
                    EditorOptions,
                    "showSelectedPrintOptions"
                    | "alwaysShowImageSelect",
                >,
            >,
        ): Pick<IEditorArgumentsBuilder, "open" | "addOwnPrinting">;
        open(options: DesignerOptions): void;
        setExactProduct(
            supplierCode?: string,
            supplierGuid?: string,
            buildProduct?: (
                productBuilder: IEditorArgumentsExactProductBuilder,
            ) => void,
        ): 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): Pick<IEditorArgumentsBuilder, "open">;
        setPrintJobCustomer(
            customerIdentity?: string,
            customerPerson?: string,
            customerCompany?: string,
            customerEmail?: string,
        ): IEditorArgumentsBuilder;
        setResultActionCloseEditor(redirectUrl?: string): IEditorArgumentsBuilder;
        setResultActionNone(): IEditorArgumentsBuilder;
        setResultActionShowDialog(
            dialogLocalizations: EditorResultDialog[],
            redirectUrl?: string,
        ): IEditorArgumentsBuilder;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    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 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

      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
      • OptionalbackgroundUrls: string[]
      • Optionaloptions: Partial<
            Pick<
                EditorOptions,
                "showSelectedPrintOptions"
                | "alwaysShowImageSelect",
            >,
        >

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

    • 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

      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

    • 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