Api

IPositionLineAdapter

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.

onClose

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

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

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

onClose (overload 2)

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

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

onReverse

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

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

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

onReverse (overload 2)

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

getProtectTooltip

getProtectTooltip(): string;

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

setProtectTooltip

setProtectTooltip(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getCloseTooltip

getCloseTooltip(): string;

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

setCloseTooltip

setCloseTooltip(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getReverseTooltip

getReverseTooltip(): string;

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

setReverseTooltip

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

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

getLineLengthUnit

getLineLengthUnit(): PositionLineLengthUnit;

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

getLineLength

getLineLength(): number;

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

setLineLength

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

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

Parameter	Type	Required
`value`	`number`	Yes
`unit`	`PositionLineLengthUnit`	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

getReverseButtonBorderColor

getReverseButtonBorderColor(): string;

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

setReverseButtonBorderColor

setReverseButtonBorderColor(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getReverseButtonBackgroundColor

getReverseButtonBackgroundColor(): string;

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

setReverseButtonBackgroundColor

setReverseButtonBackgroundColor(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getReverseButtonIconColor

getReverseButtonIconColor(): string;

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

setReverseButtonIconColor

setReverseButtonIconColor(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getCloseButtonBorderColor

getCloseButtonBorderColor(): string;

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

setCloseButtonBorderColor

setCloseButtonBorderColor(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getCloseButtonBackgroundColor

getCloseButtonBackgroundColor(): string;

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

setCloseButtonBackgroundColor

setCloseButtonBackgroundColor(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

getCloseButtonIconColor

getCloseButtonIconColor(): string;

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

setCloseButtonIconColor

setCloseButtonIconColor(value: string): this;

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

Parameter	Type	Required
`value`	`string`	Yes

PositionLineLengthUnit

On this page

remove onClose onClose (overload 2)onModify onModify (overload 2)onReverse onReverse (overload 2)getPrice setPrice getText setText getTooltip setTooltip getProtectTooltip setProtectTooltip getCloseTooltip setCloseTooltip getReverseTooltip setReverseTooltip getQuantity setQuantity getExtendLeft setExtendLeft getLineLengthUnit getLineLength setLineLength getLineStyle setLineStyle getLineWidth setLineWidth getBodyFont setBodyFont getQuantityFont setQuantityFont getLineColor setLineColor getBodyBorderColor setBodyBorderColor getBodyBackgroundColor setBodyBackgroundColor getBodyTextColor setBodyTextColor getQuantityBorderColor setQuantityBorderColor getQuantityBackgroundColor setQuantityBackgroundColor getQuantityTextColor setQuantityTextColor getReverseButtonBorderColor setReverseButtonBorderColor getReverseButtonBackgroundColor setReverseButtonBackgroundColor getReverseButtonIconColor setReverseButtonIconColor getCloseButtonBorderColor setCloseButtonBorderColor getCloseButtonBackgroundColor setCloseButtonBackgroundColor getCloseButtonIconColor setCloseButtonIconColor Related types