Interface AsukaParametric3DApi

Generic Product 3D parameter controls exposed through designer.util.parametric3d.

interface AsukaParametric3DApi {
    get: ((productId?: null | string) => null | AsukaParametricProductDescriptor);
    set: ((productId: undefined | null | string, parameterId: string, value: AsukaParametricValue, options?: AsukaParametricMutationOptions) => null | AsukaMutationPromise<null | AsukaParametricProductDescriptor>);
    setMany: ((productId: undefined | null | string, values: Record<string, unknown>, options?: AsukaParametricMutationOptions) => null | AsukaMutationPromise<null | AsukaParametricProductDescriptor>);
    validate: ((productId: undefined | null | string, values?: Record<string, unknown>) => null | AsukaParametricProductDescriptor);
}

Properties

get: ((productId?: null | string) => null | AsukaParametricProductDescriptor)

Return the selected or requested Product 3D parameter descriptor.

set: ((productId: undefined | null | string, parameterId: string, value: AsukaParametricValue, options?: AsukaParametricMutationOptions) => null | AsukaMutationPromise<null | AsukaParametricProductDescriptor>)

Change one parameter on a Product 3D instance.

setMany: ((productId: undefined | null | string, values: Record<string, unknown>, options?: AsukaParametricMutationOptions) => null | AsukaMutationPromise<null | AsukaParametricProductDescriptor>)

Change several parameters atomically.

validate: ((productId: undefined | null | string, values?: Record<string, unknown>) => null | AsukaParametricProductDescriptor)

Normalize values and evaluate constraints without changing the product.