OdsPageBackground

OdsPageBackground class

Represents the page background of ods.

class OdsPageBackground;

Constructors

Constructor	Description
constructor()	Default Constructor.

Properties

Property	Type	Description
type	OdsPageBackgroundType	Gets and sets the page background type.
color	Color	Gets and sets the color of background.
graphicType	OdsPageBackgroundGraphicType	Gets and sets the page background graphic type.
graphicPositionType	OdsPageBackgroundGraphicPositionType	Gets and set the background graphic position.
isLink	boolean	Readonly. Indicates whether it’s a linked graphic.
linkedGraphic	string	Gets and sets the linked graphic path.
graphicData	Uint8Array	Gets and sets the graphic data.

Methods

Method	Description
getType()	@deprecated. Please use the ’type’ property instead. Gets and sets the page background type.
setType(OdsPageBackgroundType)	@deprecated. Please use the ’type’ property instead. Gets and sets the page background type.
getColor()	@deprecated. Please use the ‘color’ property instead. Gets and sets the color of background.
setColor(Color)	@deprecated. Please use the ‘color’ property instead. Gets and sets the color of background.
getGraphicType()	@deprecated. Please use the ‘graphicType’ property instead. Gets and sets the page background graphic type.
setGraphicType(OdsPageBackgroundGraphicType)	@deprecated. Please use the ‘graphicType’ property instead. Gets and sets the page background graphic type.
getGraphicPositionType()	@deprecated. Please use the ‘graphicPositionType’ property instead. Gets and set the background graphic position.
setGraphicPositionType(OdsPageBackgroundGraphicPositionType)	@deprecated. Please use the ‘graphicPositionType’ property instead. Gets and set the background graphic position.
isLink()	@deprecated. Please use the ‘isLink’ property instead. Indicates whether it’s a linked graphic.
getLinkedGraphic()	@deprecated. Please use the ’linkedGraphic’ property instead. Gets and sets the linked graphic path.
setLinkedGraphic(string)	@deprecated. Please use the ’linkedGraphic’ property instead. Gets and sets the linked graphic path.
getGraphicData()	@deprecated. Please use the ‘graphicData’ property instead. Gets and sets the graphic data.
setGraphicData(Uint8Array)	@deprecated. Please use the ‘graphicData’ property instead. Gets and sets the graphic data.
isNull()	Checks whether the implementation object is null.

constructor()

Default Constructor.

constructor();

type

Gets and sets the page background type.

type : OdsPageBackgroundType;

color

Gets and sets the color of background.

color : Color;

graphicType

Gets and sets the page background graphic type.

graphicType : OdsPageBackgroundGraphicType;

graphicPositionType

Gets and set the background graphic position.

graphicPositionType : OdsPageBackgroundGraphicPositionType;

isLink

Readonly. Indicates whether it’s a linked graphic.

isLink : boolean;

linkedGraphic

Gets and sets the linked graphic path.

linkedGraphic : string;

graphicData

Gets and sets the graphic data.

graphicData : Uint8Array;

getType()

@deprecated. Please use the ’type’ property instead. Gets and sets the page background type.

getType() : OdsPageBackgroundType;

Returns

OdsPageBackgroundType

setType(OdsPageBackgroundType)

@deprecated. Please use the ’type’ property instead. Gets and sets the page background type.

setType(value: OdsPageBackgroundType) : void;

Parameters:

Parameter	Type	Description
value	OdsPageBackgroundType	The value to set.

getColor()

@deprecated. Please use the ‘color’ property instead. Gets and sets the color of background.

getColor() : Color;

Returns

Color

setColor(Color)

@deprecated. Please use the ‘color’ property instead. Gets and sets the color of background.

setColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getGraphicType()

@deprecated. Please use the ‘graphicType’ property instead. Gets and sets the page background graphic type.

getGraphicType() : OdsPageBackgroundGraphicType;

Returns

OdsPageBackgroundGraphicType

setGraphicType(OdsPageBackgroundGraphicType)

@deprecated. Please use the ‘graphicType’ property instead. Gets and sets the page background graphic type.

setGraphicType(value: OdsPageBackgroundGraphicType) : void;

Parameters:

Parameter	Type	Description
value	OdsPageBackgroundGraphicType	The value to set.

getGraphicPositionType()

@deprecated. Please use the ‘graphicPositionType’ property instead. Gets and set the background graphic position.

getGraphicPositionType() : OdsPageBackgroundGraphicPositionType;

Returns

OdsPageBackgroundGraphicPositionType

setGraphicPositionType(OdsPageBackgroundGraphicPositionType)

@deprecated. Please use the ‘graphicPositionType’ property instead. Gets and set the background graphic position.

setGraphicPositionType(value: OdsPageBackgroundGraphicPositionType) : void;

Parameters:

Parameter	Type	Description
value	OdsPageBackgroundGraphicPositionType	The value to set.

isLink()

@deprecated. Please use the ‘isLink’ property instead. Indicates whether it’s a linked graphic.

isLink() : boolean;

getLinkedGraphic()

@deprecated. Please use the ’linkedGraphic’ property instead. Gets and sets the linked graphic path.

getLinkedGraphic() : string;

setLinkedGraphic(string)

@deprecated. Please use the ’linkedGraphic’ property instead. Gets and sets the linked graphic path.

setLinkedGraphic(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getGraphicData()

@deprecated. Please use the ‘graphicData’ property instead. Gets and sets the graphic data.

getGraphicData() : Uint8Array;

setGraphicData(Uint8Array)

@deprecated. Please use the ‘graphicData’ property instead. Gets and sets the graphic data.

setGraphicData(value: Uint8Array) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;