DrawObject
DrawObject class
DrawObject will be initialized and returned when rendering.
class DrawObject;
Properties
Property | Type | Description |
---|---|---|
cell | Cell | Readonly. Indicates the Cell object when rendering. All properties of cell can be accessed. |
shape | Shape | Readonly. Indicates the Shape object when rendering. All properties of shape can be accessed. |
imageBytes | Uint8Array | Readonly. Indicates image bytes of rendered Chart, Shape when rendering. |
type | DrawObjectEnum | Readonly. Indicates the type of DrawObject. |
currentPage | number | Readonly. Indicates the page index of DrawObject. Page index is based on zero. One Sheet contains several pages when rendering. |
totalPages | number | Readonly. Indicates total pages in current rendering. |
sheetIndex | number | Readonly. Indicates current sheet index of DrawObject. |
Methods
Method | Description |
---|---|
getCell() | @deprecated. Please use the ‘cell’ property instead. Indicates the Cell object when rendering. All properties of cell can be accessed. |
getShape() | @deprecated. Please use the ‘shape’ property instead. Indicates the Shape object when rendering. All properties of shape can be accessed. |
getImageBytes() | @deprecated. Please use the ‘imageBytes’ property instead. Indicates image bytes of rendered Chart, Shape when rendering. |
getType() | @deprecated. Please use the ’type’ property instead. Indicates the type of DrawObject. |
getCurrentPage() | @deprecated. Please use the ‘currentPage’ property instead. Indicates the page index of DrawObject. Page index is based on zero. One Sheet contains several pages when rendering. |
getTotalPages() | @deprecated. Please use the ’totalPages’ property instead. Indicates total pages in current rendering. |
getSheetIndex() | @deprecated. Please use the ‘sheetIndex’ property instead. Indicates current sheet index of DrawObject. |
isNull() | Checks whether the implementation object is null. |
cell
Readonly. Indicates the Cell object when rendering. All properties of cell can be accessed.
cell : Cell;
shape
Readonly. Indicates the Shape object when rendering. All properties of shape can be accessed.
shape : Shape;
imageBytes
Readonly. Indicates image bytes of rendered Chart, Shape when rendering.
imageBytes : Uint8Array;
type
Readonly. Indicates the type of DrawObject.
type : DrawObjectEnum;
currentPage
Readonly. Indicates the page index of DrawObject. Page index is based on zero. One Sheet contains several pages when rendering.
currentPage : number;
totalPages
Readonly. Indicates total pages in current rendering.
totalPages : number;
sheetIndex
Readonly. Indicates current sheet index of DrawObject.
sheetIndex : number;
getCell()
@deprecated. Please use the ‘cell’ property instead. Indicates the Cell object when rendering. All properties of cell can be accessed.
getCell() : Cell;
Returns
getShape()
@deprecated. Please use the ‘shape’ property instead. Indicates the Shape object when rendering. All properties of shape can be accessed.
getShape() : Shape;
Returns
getImageBytes()
@deprecated. Please use the ‘imageBytes’ property instead. Indicates image bytes of rendered Chart, Shape when rendering.
getImageBytes() : Uint8Array;
getType()
@deprecated. Please use the ’type’ property instead. Indicates the type of DrawObject.
getType() : DrawObjectEnum;
Returns
getCurrentPage()
@deprecated. Please use the ‘currentPage’ property instead. Indicates the page index of DrawObject. Page index is based on zero. One Sheet contains several pages when rendering.
getCurrentPage() : number;
getTotalPages()
@deprecated. Please use the ’totalPages’ property instead. Indicates total pages in current rendering.
getTotalPages() : number;
getSheetIndex()
@deprecated. Please use the ‘sheetIndex’ property instead. Indicates current sheet index of DrawObject.
getSheetIndex() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;