Documentation

DggContainer
in package

Table of Contents

Properties

$bstoreContainer  : BstoreContainer|null
BLIP Store Container.
$cDgSaved  : int
Total number of drawings saved.
$cSpSaved  : int
Total number of shapes saved (including group shapes).
$IDCLs  : array<string|int, mixed>
Array of identifier clusters containg information about the maximum shape identifiers.
$OPT  : array<string|int, mixed>
Array of options for the drawing group.
$spIdMax  : int
Maximum shape index of all shapes in all drawings increased by one.

Methods

getBstoreContainer()  : BstoreContainer|null
Get BLIP Store Container.
getCDgSaved()  : int
Get total number of drawings saved.
getCSpSaved()  : int
Get total number of shapes saved (including group shapes).
getIDCLs()  : array<string|int, mixed>
Get identifier clusters.
getOPT()  : mixed
Get an option for the drawing group.
getSpIdMax()  : int
Get maximum shape index of all shapes in all drawings (plus one).
setBstoreContainer()  : void
Set BLIP Store Container.
setCDgSaved()  : void
Set total number of drawings saved.
setCSpSaved()  : void
Set total number of shapes saved (including group shapes).
setIDCLs()  : void
Set identifier clusters. [<drawingId> => <max shape id>, ...].
setOPT()  : void
Set an option for the drawing group.
setSpIdMax()  : void
Set maximum shape index of all shapes in all drawings (plus one).

Properties

$cDgSaved

Total number of drawings saved.

private int $cDgSaved

$cSpSaved

Total number of shapes saved (including group shapes).

private int $cSpSaved

$IDCLs

Array of identifier clusters containg information about the maximum shape identifiers.

private array<string|int, mixed> $IDCLs = []

$OPT

Array of options for the drawing group.

private array<string|int, mixed> $OPT = []

$spIdMax

Maximum shape index of all shapes in all drawings increased by one.

private int $spIdMax

Methods

getCDgSaved()

Get total number of drawings saved.

public getCDgSaved() : int
Return values
int

getCSpSaved()

Get total number of shapes saved (including group shapes).

public getCSpSaved() : int
Return values
int

getIDCLs()

Get identifier clusters.

public getIDCLs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOPT()

Get an option for the drawing group.

public getOPT(int $property) : mixed
Parameters
$property : int

The number specifies the option

getSpIdMax()

Get maximum shape index of all shapes in all drawings (plus one).

public getSpIdMax() : int
Return values
int

setCDgSaved()

Set total number of drawings saved.

public setCDgSaved(int $value) : void
Parameters
$value : int

setCSpSaved()

Set total number of shapes saved (including group shapes).

public setCSpSaved(int $value) : void
Parameters
$value : int

setIDCLs()

Set identifier clusters. [<drawingId> => <max shape id>, ...].

public setIDCLs(array<string|int, mixed> $IDCLs) : void
Parameters
$IDCLs : array<string|int, mixed>

setOPT()

Set an option for the drawing group.

public setOPT(int $property, mixed $value) : void
Parameters
$property : int

The number specifies the option

$value : mixed

setSpIdMax()

Set maximum shape index of all shapes in all drawings (plus one).

public setSpIdMax(int $value) : void
Parameters
$value : int

        
On this page

Search results