ProductParser

Classes

ProductParser

Constructors

Constructor

new ProductParser(additionalConverters?): ProductParser;

Parameters

Parameter	Type
additionalConverters?	AdditionalConverter[]

Returns

ProductParser

Methods

parseArchedTextItem()

parseArchedTextItem(rawArchedText, baseConverters): ArchedTextItem;

Parameters

Parameter	Type
rawArchedText	Object
baseConverters	PropertyConverter[]

Returns

ArchedTextItem

parseAutoScaledTextItem()

parseAutoScaledTextItem(rawAutoScaledText, baseConverters): AutoScaledTextItem;

Parameters

Parameter	Type
rawAutoScaledText	Object
baseConverters	PropertyConverter[]

Returns

AutoScaledTextItem

parseBarcodeItem()

parseBarcodeItem(rawBarcode, baseConverters): BarcodeItem;

Parameters

Parameter	Type
rawBarcode	Object
baseConverters	PropertyConverter[]

Returns

BarcodeItem

parseBarcodePermissions()

parseBarcodePermissions(rawPerms): BarcodePermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

BarcodePermissions

parseBoundedTextItem()

parseBoundedTextItem(rawBoundedText, baseConverters): BoundedTextItem;

Parameters

Parameter	Type
rawBoundedText	Object
baseConverters	PropertyConverter[]

Returns

BoundedTextItem

parseClipartItem()

parseClipartItem(rawClipartItem, baseConverters): ClipartItem;

Parameters

Parameter	Type
rawClipartItem	Object
baseConverters	PropertyConverter[]

Returns

ClipartItem

parseCollection()

parseCollection<T>(
   rawCollection, 
   parseCollectionItem, 
   targetCollection): void;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
rawCollection	any[]
parseCollectionItem	(raw) => T
targetCollection	Collection<T>

Returns

void

parseColor()

parseColor(rawColor): Color;

Parameters

Parameter	Type
rawColor	any

Returns

Color

parseColorEntries()

parseColorEntries(rawColorEntries): Map<Color, Color>;

Parameters

Parameter	Type
rawColorEntries	ColorDictionaryEntry[]

Returns

Map<Color, Color>

parseColorGroup()

parseColorGroup(rawPerms): ColorGroup;

Parameters

Parameter	Type
rawPerms	Object

Returns

ColorGroup

parseContainer()

readonly parseContainer(
   rawContainer, 
   emptyContainer?, 
   converters?): any;

Parameters

Parameter	Type	Default value
rawContainer	Object	undefined
emptyContainer	any	...
converters	PropertyConverter[]	[]

Returns

any

parseContentPermissions()

parseContentPermissions(rawContentPermissions, baseConverters): ContentPermissions;

Parameters

Parameter	Type
rawContentPermissions	Object
baseConverters	PropertyConverter[]

Returns

ContentPermissions

parseCropMark()

readonly parseCropMark(rawCropMark): any;

Parameters

Parameter	Type
rawCropMark	Object

Returns

any

parseCropMarkText()

readonly parseCropMarkText(rawCropMarkText): any;

Parameters

Parameter	Type
rawCropMarkText	Object

Returns

any

parseCurvedTextItem()

parseCurvedTextItem(rawCurvedText, baseConverters): CurvedTextItem;

Parameters

Parameter	Type
rawCurvedText	Object
baseConverters	PropertyConverter[]

Returns

CurvedTextItem

parseDashedLineItem()

parseDashedLineItem(rawLine, baseConverters): DashedLineItem;

Parameters

Parameter	Type
rawLine	Object
baseConverters	PropertyConverter[]

Returns

DashedLineItem

parseEllipseItem()

parseEllipseItem(rawEllipse, baseConverters): EllipseItem;

Parameters

Parameter	Type
rawEllipse	Object
baseConverters	PropertyConverter[]

Returns

EllipseItem

parseEncodingOptions()

parseEncodingOptions(raw): any;

Parameters

Parameter	Type
raw	Object

Returns

any

parseFontSettings()

parseFontSettings(rawSettings, destTextItem): FontSettings;

Parameters

Parameter	Type
rawSettings	Object
destTextItem	BaseTextItem

Returns

FontSettings

parseFrontendPermissions()

parseFrontendPermissions(rawPerms): FrontendPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

FrontendPermissions

parseGroupItem()

parseGroupItem(rawGroupItem, baseConverters): GroupItem;

Parameters

Parameter	Type
rawGroupItem	Object
baseConverters	PropertyConverter[]

Returns

GroupItem

parseGroupItemPermissions()

readonly parseGroupItemPermissions(rawPerms): GroupItemPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

GroupItemPermissions

parseImageItem()

parseImageItem(rawImage, baseConverters): ImageItem;

Parameters

Parameter	Type
rawImage	Object
baseConverters	PropertyConverter[]

Returns

ImageItem

parseImagePermissions()

parseImagePermissions(rawPerms): ImagePermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

ImagePermissions

parseImageSource()

parseImageSource(rawImageSource): ImageSource;

Parameters

Parameter	Type
rawImageSource	Object

Returns

ImageSource

parseInStringPlaceholder()

parseInStringPlaceholder(rawSettings): InStringPlaceholder;

Parameters

Parameter	Type
rawSettings	Object

Returns

InStringPlaceholder

parseInteractiveZone()

readonly parseInteractiveZone(rawActivityZone): any;

Parameters

Parameter	Type
rawActivityZone	Object

Returns

any

parseItem()

readonly parseItem(rawItem): any;

Parameters

Parameter	Type
rawItem	Object

Returns

any

parseItemPermissions()

parseItemPermissions(rawPerms): ItemPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

ItemPermissions

parseLayoutItem()

parseLayoutItem(rawLayoutItem, baseConverters): LayoutItem;

Parameters

Parameter	Type
rawLayoutItem	Object
baseConverters	PropertyConverter[]

Returns

LayoutItem

parseLayoutSettings()

readonly parseLayoutSettings(rawPerms): any;

Parameters

Parameter	Type
rawPerms	Object

Returns

any

parseLineItem()

readonly parseLineItem(rawLine, baseConverters): any;

Parameters

Parameter	Type
rawLine	Object
baseConverters	PropertyConverter[]

Returns

any

parseLinePermissions()

readonly parseLinePermissions(rawPerms): LinePermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

LinePermissions

parseManipulationPermissions()

parseManipulationPermissions(rawPerms): ManipulationPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

ManipulationPermissions

parseMask()

parseMask(rawMask): ItemMask;

Parameters

Parameter	Type
rawMask	any

Returns

ItemMask

parseMockup()

parseMockup(rawMockup): SurfaceMockup;

Parameters

Parameter	Type
rawMockup	Object

Returns

SurfaceMockup

parseMockupContainer()

readonly parseMockupContainer(rawContainer): any;

Parameters

Parameter	Type
rawContainer	Object

Returns

any

parseNDEffects()

parseNDEffects(rawNDEffects): NDEffects;

Parameters

Parameter	Type
rawNDEffects	IRawNDEffects

Returns

NDEffects

parsePalette()

readonly parsePalette(rawPalette): any;

Parameters

Parameter	Type
rawPalette	Object

Returns

any

parseParagraphSettings()

parseParagraphSettings(rawSettings): ParagraphSettings;

Parameters

Parameter	Type
rawSettings	Object

Returns

ParagraphSettings

parsePath()

parsePath(rawPath): Path;

Parameters

Parameter	Type
rawPath	| string | { path: string; }

Returns

Path

parsePathBoundedTextItem()

parsePathBoundedTextItem(rawBoundedText, baseConverters): PathBoundedTextItem;

Parameters

Parameter	Type
rawBoundedText	Object
baseConverters	PropertyConverter[]

Returns

PathBoundedTextItem

parsePathBoundedTextPermissions()

parsePathBoundedTextPermissions(rawPerms): PathBoundedTextPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

PathBoundedTextPermissions

parsePaths()

parsePaths(rawPaths): Path[];

Parameters

Parameter	Type
rawPaths	Object

Returns

Path[]

parsePlaceholderItem()

parsePlaceholderItem(rawPlaceholder, baseConverters): PlaceholderItem;

Parameters

Parameter	Type
rawPlaceholder	Object
baseConverters	PropertyConverter[]

Returns

PlaceholderItem

parsePlaceholderPermissions()

readonly parsePlaceholderPermissions(rawPerms): PlaceholderPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

PlaceholderPermissions

parsePlainTextItem()

parsePlainTextItem(rawPlainText, baseConverters): PlainTextItem;

Parameters

Parameter	Type
rawPlainText	Object
baseConverters	PropertyConverter[]

Returns

PlainTextItem

parsePointF()

parsePointF(rawPoint): PointF;

Parameters

Parameter	Type
rawPoint	Object

Returns

PointF

parsePrintArea()

readonly parsePrintArea(rawPrintArea): any;

Parameters

Parameter	Type
rawPrintArea	Object

Returns

any

parseProduct()

parseProduct(rawProduct): Product;

Parameters

Parameter	Type
rawProduct	Object

Returns

Product

parseRectangleF()

parseRectangleF(rawRectangle): RectangleF;

Parameters

Parameter	Type
rawRectangle	Object

Returns

RectangleF

parseRectangleItem()

parseRectangleItem(rawRectangle, baseConverters): RectangleItem;

Parameters

Parameter	Type
rawRectangle	Object
baseConverters	PropertyConverter[]

Returns

RectangleItem

parseRgbColor()

parseRgbColor(rawColor): RgbColor;

Parameters

Parameter	Type
rawColor	any

Returns

RgbColor

parseRotatedRectangle()

parseRotatedRectangle(rawRectangle): any;

Parameters

Parameter	Type
rawRectangle	Object

Returns

any

parseSafetyLine()

readonly parseSafetyLine(rawSafetyLine): any;

Parameters

Parameter	Type
rawSafetyLine	Object

Returns

any

parseShadowSettings()

parseShadowSettings(rawSettings): ShadowSettings;

Parameters

Parameter	Type
rawSettings	Object

Returns

ShadowSettings

parseShapeItem()

parseShapeItem(rawShape, baseConverters): ShapeItem;

Parameters

Parameter	Type
rawShape	Object
baseConverters	PropertyConverter[]

Returns

ShapeItem

parseShapePermissions()

parseShapePermissions(rawPerms): ShapePermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

ShapePermissions

parseSizeF()

parseSizeF(rawSize): SizeF;

Parameters

Parameter	Type
rawSize	Object

Returns

SizeF

parseSmartItem()

parseSmartItem(rawSmartItem): SmartItem;

Parameters

Parameter	Type
rawSmartItem	Object

Returns

SmartItem

parseStrokeSettings()

parseStrokeSettings(rawSettings): StrokeSettings;

Parameters

Parameter	Type
rawSettings	Object

Returns

StrokeSettings

parseSurface()

readonly parseSurface(rawSurface): any;

Parameters

Parameter	Type
rawSurface	Object

Returns

any

parseSurfaceContainer()

readonly parseSurfaceContainer(rawContainer): any;

Parameters

Parameter	Type
rawContainer	Object

Returns

any

parseSwatch()

readonly parseSwatch(rawSwatch): any;

Parameters

Parameter	Type
rawSwatch	Object

Returns

any

parseTextPermissions()

parseTextPermissions(rawPerms): TextPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

TextPermissions

parseThemeBinding()

parseThemeBinding(rawThemeBinding): ThemeBinding;

Parameters

Parameter	Type
rawThemeBinding	any

Returns

ThemeBinding

parseTransform()

parseTransform(rawTransform): Transform;

Parameters

Parameter	Type
rawTransform	Object

Returns

Transform

parseViolationSettings()

parseViolationSettings(rawPerms): ViolationSettings;

Parameters

Parameter	Type
rawPerms	Object

Returns

ViolationSettings

parseVisualizationPermissions()

parseVisualizationPermissions(rawPerms): VisualizationPermissions;

Parameters

Parameter	Type
rawPerms	Object

Returns

VisualizationPermissions

parseWatermark()

parseWatermark(rawWatermark): any;

Parameters

Parameter	Type
rawWatermark	any

Returns

any

parseWatermarkConfig()

parseWatermarkConfig(rawConfig): any;

Parameters

Parameter	Type
rawConfig	any

Returns

any

---

PropertyConverter

Constructors

Constructor

new PropertyConverter(
   rawPropertyName, 
   convertFunc, 
   isSetByConvertFunc?): PropertyConverter;

Parameters

Parameter	Type	Default value
rawPropertyName	string	undefined
convertFunc	Function	undefined
isSetByConvertFunc	boolean	false

Returns

PropertyConverter

Properties

convert

convert: Function;

property

property: string;

setByConverter

setByConverter: boolean;