PicFormatOption

PicFormatOption class

Represents picture format option

class PicFormatOption;

Constructors

Constructor	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
type	FillPictureType	Gets or sets the picture fill type.
scale	number	Gets or sets how many the picture stack and scale with.
left	number	Gets or sets the left offset for stretching picture.
top	number	Gets or sets the top offset for stretching picture.
bottom	number	Gets or sets the bottom offset for stretching picture.
right	number	Gets or sets the right offset for stretching picture.

Methods

Method	Description
getType()	@deprecated. Please use the ’type’ property instead. Gets or sets the picture fill type.
setType(FillPictureType)	@deprecated. Please use the ’type’ property instead. Gets or sets the picture fill type.
getScale()	@deprecated. Please use the ‘scale’ property instead. Gets or sets how many the picture stack and scale with.
setScale(number)	@deprecated. Please use the ‘scale’ property instead. Gets or sets how many the picture stack and scale with.
getLeft()	@deprecated. Please use the ’left’ property instead. Gets or sets the left offset for stretching picture.
setLeft(number)	@deprecated. Please use the ’left’ property instead. Gets or sets the left offset for stretching picture.
getTop()	@deprecated. Please use the ’top’ property instead. Gets or sets the top offset for stretching picture.
setTop(number)	@deprecated. Please use the ’top’ property instead. Gets or sets the top offset for stretching picture.
getBottom()	@deprecated. Please use the ‘bottom’ property instead. Gets or sets the bottom offset for stretching picture.
setBottom(number)	@deprecated. Please use the ‘bottom’ property instead. Gets or sets the bottom offset for stretching picture.
getRight()	@deprecated. Please use the ‘right’ property instead. Gets or sets the right offset for stretching picture.
setRight(number)	@deprecated. Please use the ‘right’ property instead. Gets or sets the right offset for stretching picture.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

type

Gets or sets the picture fill type.

type : FillPictureType;

scale

Gets or sets how many the picture stack and scale with.

scale : number;

left

Gets or sets the left offset for stretching picture.

left : number;

top

Gets or sets the top offset for stretching picture.

top : number;

bottom

Gets or sets the bottom offset for stretching picture.

bottom : number;

right

Gets or sets the right offset for stretching picture.

right : number;

getType()

@deprecated. Please use the ’type’ property instead. Gets or sets the picture fill type.

getType() : FillPictureType;

Returns

FillPictureType

setType(FillPictureType)

@deprecated. Please use the ’type’ property instead. Gets or sets the picture fill type.

setType(value: FillPictureType) : void;

Parameters:

Parameter	Type	Description
value	FillPictureType	The value to set.

getScale()

@deprecated. Please use the ‘scale’ property instead. Gets or sets how many the picture stack and scale with.

getScale() : number;

setScale(number)

@deprecated. Please use the ‘scale’ property instead. Gets or sets how many the picture stack and scale with.

setScale(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getLeft()

@deprecated. Please use the ’left’ property instead. Gets or sets the left offset for stretching picture.

getLeft() : number;

setLeft(number)

@deprecated. Please use the ’left’ property instead. Gets or sets the left offset for stretching picture.

setLeft(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getTop()

@deprecated. Please use the ’top’ property instead. Gets or sets the top offset for stretching picture.

getTop() : number;

setTop(number)

@deprecated. Please use the ’top’ property instead. Gets or sets the top offset for stretching picture.

setTop(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBottom()

@deprecated. Please use the ‘bottom’ property instead. Gets or sets the bottom offset for stretching picture.

getBottom() : number;

setBottom(number)

@deprecated. Please use the ‘bottom’ property instead. Gets or sets the bottom offset for stretching picture.

setBottom(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getRight()

@deprecated. Please use the ‘right’ property instead. Gets or sets the right offset for stretching picture.

getRight() : number;

setRight(number)

@deprecated. Please use the ‘right’ property instead. Gets or sets the right offset for stretching picture.

setRight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;