Api

IOrderLineAdapter

Download Markdown

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

remove

remove(): void;

Use the type signature above and the integration guide for the owning capability.

onModify

onModify(callback: () => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`callback`	`() => void`	Yes

onModify (overload 2)

onModify<T>(data: T, callback: (data: T) => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`data`	`T`	Yes
`callback`	`(data: T) => void`	Yes

onMove

onMove(callback: () => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`callback`	`() => void`	Yes

onMove (overload 2)

onMove<T>(data: T, callback: (data: T) => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`data`	`T`	Yes
`callback`	`(data: T) => void`	Yes

onMoving

onMoving(callback: () => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`callback`	`() => void`	Yes

onMoving (overload 2)

onMoving<T>(data: T, callback: (data: T) => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`data`	`T`	Yes
`callback`	`(data: T) => void`	Yes

onCancel

onCancel(callback: () => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`callback`	`() => void`	Yes

onCancel (overload 2)

onCancel<T>(data: T, callback: (data: T) => void): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`data`	`T`	Yes
`callback`	`(data: T) => void`	Yes

getPrice

getPrice(): number;

Use the type signature above and the integration guide for the owning capability.

setPrice

setPrice(value: number): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`number`	Yes

getText

getText(): string;

Use the type signature above and the integration guide for the owning capability.

setText

setText(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getTooltip

getTooltip(): string;

Use the type signature above and the integration guide for the owning capability.

setTooltip

setTooltip(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getModifyTooltip

getModifyTooltip(): string;

Use the type signature above and the integration guide for the owning capability.

setModifyTooltip

setModifyTooltip(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getCancelTooltip

getCancelTooltip(): string;

Use the type signature above and the integration guide for the owning capability.

setCancelTooltip

setCancelTooltip(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getQuantity

getQuantity(): string;

Use the type signature above and the integration guide for the owning capability.

setQuantity

setQuantity(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getEditable

getEditable(): boolean;

Use the type signature above and the integration guide for the owning capability.

setEditable

setEditable(value: boolean): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`boolean`	Yes

getCancellable

getCancellable(): boolean;

Use the type signature above and the integration guide for the owning capability.

setCancellable

setCancellable(value: boolean): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`boolean`	Yes

getExtendLeft

getExtendLeft(): boolean;

Use the type signature above and the integration guide for the owning capability.

setExtendLeft

setExtendLeft(value: boolean): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`boolean`	Yes

getLineLength

getLineLength(): number;

Use the type signature above and the integration guide for the owning capability.

getLineLengthUnit

getLineLengthUnit(): OrderLineLengthUnit;

Use the type signature above and the integration guide for the owning capability.

setLineLength

setLineLength(value: number, unit?: OrderLineLengthUnit): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`number`	Yes
`unit`	`OrderLineLengthUnit`	No

getLineStyle

getLineStyle(): number;

Use the type signature above and the integration guide for the owning capability.

setLineStyle

setLineStyle(value: number): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`number`	Yes

getLineWidth

getLineWidth(): number;

Use the type signature above and the integration guide for the owning capability.

setLineWidth

setLineWidth(value: number): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`number`	Yes

getBodyFont

getBodyFont(): string;

Use the type signature above and the integration guide for the owning capability.

setBodyFont

setBodyFont(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getQuantityFont

getQuantityFont(): string;

Use the type signature above and the integration guide for the owning capability.

setQuantityFont

setQuantityFont(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getLineColor

getLineColor(): string;

Use the type signature above and the integration guide for the owning capability.

setLineColor

setLineColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getBodyBorderColor

getBodyBorderColor(): string;

Use the type signature above and the integration guide for the owning capability.

setBodyBorderColor

setBodyBorderColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getBodyBackgroundColor

getBodyBackgroundColor(): string;

Use the type signature above and the integration guide for the owning capability.

setBodyBackgroundColor

setBodyBackgroundColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getBodyTextColor

getBodyTextColor(): string;

Use the type signature above and the integration guide for the owning capability.

setBodyTextColor

setBodyTextColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getQuantityBorderColor

getQuantityBorderColor(): string;

Use the type signature above and the integration guide for the owning capability.

setQuantityBorderColor

setQuantityBorderColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getQuantityBackgroundColor

getQuantityBackgroundColor(): string;

Use the type signature above and the integration guide for the owning capability.

setQuantityBackgroundColor

setQuantityBackgroundColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getQuantityTextColor

getQuantityTextColor(): string;

Use the type signature above and the integration guide for the owning capability.

setQuantityTextColor

setQuantityTextColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getCancelButtonBorderColor

getCancelButtonBorderColor(): string;

Use the type signature above and the integration guide for the owning capability.

setCancelButtonBorderColor

setCancelButtonBorderColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getCancelButtonBackgroundColor

getCancelButtonBackgroundColor(): string;

Use the type signature above and the integration guide for the owning capability.

setCancelButtonBackgroundColor

setCancelButtonBackgroundColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

getCancelButtonIconColor

getCancelButtonIconColor(): string;

Use the type signature above and the integration guide for the owning capability.

setCancelButtonIconColor

setCancelButtonIconColor(value: string): this;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`value`	`string`	Yes

OrderLineLengthUnit

On this page

remove onModify onModify (overload 2)onMove onMove (overload 2)onMoving onMoving (overload 2)onCancel onCancel (overload 2)getPrice setPrice getText setText getTooltip setTooltip getModifyTooltip setModifyTooltip getCancelTooltip setCancelTooltip getQuantity setQuantity getEditable setEditable getCancellable setCancellable getExtendLeft setExtendLeft getLineLength getLineLengthUnit setLineLength getLineStyle setLineStyle getLineWidth setLineWidth getBodyFont setBodyFont getQuantityFont setQuantityFont getLineColor setLineColor getBodyBorderColor setBodyBorderColor getBodyBackgroundColor setBodyBackgroundColor getBodyTextColor setBodyTextColor getQuantityBorderColor setQuantityBorderColor getQuantityBackgroundColor setQuantityBackgroundColor getQuantityTextColor setQuantityTextColor getCancelButtonBorderColor setCancelButtonBorderColor getCancelButtonBackgroundColor setCancelButtonBackgroundColor getCancelButtonIconColor setCancelButtonIconColor Related types