Skip to main content

Violation

Enumerations​

ViolationState​

Results of preflight check.

Enumeration Members​

Enumeration MemberValueDescription
Bad3The preflight check results in an error, 3.
Good1The preflight check is successful, 1.
None0The preflight check was not performed, 0.
Warning2The preflight check results in a warning, 2.

Classes​

abstract Violation​

Extended by​

Constructors​

Constructor​
new Violation(): Violation;
Returns​

Violation

Properties​

prepareItem​
prepareItem: (item) => void;
Parameters​
ParameterType
itemItem
Returns​

void

Methods​

getDataPropertyName()​
getDataPropertyName(): string;
Returns​

string

getStatePropertyName()​
getStatePropertyName(): string;
Returns​

string

getViolationInfo()​
getViolationInfo(item, oldViolationInfo): IViolationInfo<{
}>;
Parameters​
ParameterType
itemItem
oldViolationInfoITotalViolationInfo
Returns​

IViolationInfo<{ }>

isAvailableFor()​
isAvailableFor(item): boolean;
Parameters​
ParameterType
itemItem
Returns​

boolean

computeTotalViolationInfo()​
static computeTotalViolationInfo(
violations,
item,
oldViolationInfo): ITotalViolationInfo;
Parameters​
ParameterType
violationsViolation[]
itemItem
oldViolationInfoITotalViolationInfo
Returns​

ITotalViolationInfo


ViolationInfoResult​

Constructors​

Constructor​
new ViolationInfoResult(): ViolationInfoResult;
Returns​

ViolationInfoResult

Accessors​

good​
Get Signature​
get static good(): object;
Returns​

object

state​
state: ViolationState = ViolationState.Good;
none​
Get Signature​
get static none(): object;
Returns​

object

state​
state: ViolationState = ViolationState.None;

Interfaces​

IMaxArtorkSizeViolationData​

Extends​

Properties​

constraints​
constraints: MaxArtworkSizeConstraints;
overallBounds​
overallBounds: RectangleF;

ITotalViolationInfo​

Extended by​

Properties​

data?​
optional data?: object;
Index Signature​
[key: string]: IViolationData
messages?​
optional messages?: string[];
state​
state: ViolationState;

IViolationData​

Extended by​


IViolationInfo​

Type Parameters​

Type ParameterDefault type
T extends IViolationDataobject

Properties​

data?​
optional data?: T;
message?​
optional message?: string;
state​
state: ViolationState;
Was this page helpful?