PHPExcel_Worksheet
[ class tree: PHPExcel_Worksheet ] [ index: PHPExcel_Worksheet ] [ all elements ]
Packages:
default
JAMA
Math_Stats
PHPExcel
PHPExcel_Calculation
PHPExcel_Cell
PHPExcel_Reader
PHPExcel_Reader_Excel5
PHPExcel_RichText
PHPExcel_Shared
PHPExcel_Shared_Escher
PHPExcel_Shared_OLE
PHPExcel_Style
PHPExcel_Worksheet
PHPExcel_Worksheet_Drawing
PHPExcel_Writer
PHPExcel_Writer_Excel5
PHPExcel_Writer_Excel2007


Files:
BaseDrawing.php
ColumnDimension.php
HeaderFooter.php
HeaderFooterDrawing.php
MemoryDrawing.php
PageMargins.php
PageSetup.php
Protection.php
RowDimension.php
SheetView.php
Worksheet.php

Classes:
PHPExcel_Worksheet
PHPExcel_Worksheet_BaseDrawing
PHPExcel_Worksheet_ColumnDimension
PHPExcel_Worksheet_HeaderFooter
PHPExcel_Worksheet_HeaderFooterDrawing
PHPExcel_Worksheet_MemoryDrawing
PHPExcel_Worksheet_PageMargins
PHPExcel_Worksheet_PageSetup
PHPExcel_Worksheet_Protection
PHPExcel_Worksheet_RowDimension
PHPExcel_Worksheet_SheetView

Class: PHPExcel_Worksheet_BaseDrawing

Source Location: /PHPExcel/Worksheet/BaseDrawing.php

Class Overview




PHPExcel_Worksheet_BaseDrawing




Author(s):


    
        





      
  


Copyright:


    
  
  • Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
    • 


                

            Implements interfaces:
            

        

        




Variables







Methods















Child classes:






PHPExcel_Worksheet_Drawing

	
PHPExcel_Worksheet_Drawing






PHPExcel_Worksheet_MemoryDrawing

	
PHPExcel_Worksheet_MemoryDrawing

















Class Details



[line 45]

PHPExcel_Worksheet_BaseDrawing

PHPExcel_Worksheet_BaseDrawing





Tags:





  

    copyright:  Copyright (c) 2006 - 2009 PHPExcel (http://www.codeplex.com/PHPExcel)
  










[ Top ]







Class Variables



	
	

	
static $_imageCounter =  0

	
[line 52]

  Image counter

Image counter





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
static $_imageIndex =  0

	
[line 59]

  Image index

Image index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_coordinates = 

	
[line 87]

  Coordinates

Coordinates





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_description = 

	
[line 73]

  Description

Description





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_hashIndex = 

	
[line 456]

  Hash index

Hash index





Tags:





  

    access:  private
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_height = 

	
[line 115]

  Height

Height





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_name = 

	
[line 66]

  Name

Name





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$_offsetX = 

	
[line 94]

  Offset X

Offset X





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_offsetY = 

	
[line 101]

  Offset Y

Offset Y





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_resizeProportional = 

	
[line 122]

  Proportional resize

Proportional resize





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$_rotation = 

	
[line 129]

  Rotation

Rotation





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_shadow = 

	
[line 136]

  Shadow

Shadow





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet_Drawing_Shadow
    

      

	



	
[ Top ]


	
	

	
$_width = 

	
[line 108]

  Width

Width





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$_worksheet = 

	
[line 80]

  Worksheet

Worksheet





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      PHPExcel_Worksheet
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor __construct [line 141]

	

    

    

		PHPExcel_Worksheet_BaseDrawing __construct(
)
    

    


	
		Create a new PHPExcel_Worksheet_BaseDrawing

Create a new PHPExcel_Worksheet_BaseDrawing





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_Drawing::__construct()

		
Create a new PHPExcel_Worksheet_Drawing

	

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::__construct()

		
Create a new PHPExcel_Worksheet_HeaderFooterDrawing

	

		

	
PHPExcel_Worksheet_MemoryDrawing::__construct()

		
Create a new PHPExcel_Worksheet_MemoryDrawing

	

	

	
        
[ Top ]

  

  

	
	
method getCoordinates [line 254]

	

    

    

		string getCoordinates(
)
    

    


	
		Get Coordinates

Get Coordinates





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getDescription [line 193]

	

    

    

		string getDescription(
)
    

    


	
		Get Description

Get Description





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getHashCode [line 435]

	

    

    

		string getHashCode(
)
    

    


	
		Get hash code

Get hash code





Tags:





  

    return:  Hash code
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_Drawing::getHashCode()

		
Get hash code

	

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getHashCode()

		
Get hash code

	

		

	
PHPExcel_Worksheet_MemoryDrawing::getHashCode()

		
Get hash code

	

	

	
        
[ Top ]

  

  

	
	
method getHashIndex [line 466]

	

    

    

		string getHashIndex(
)
    

    


	
		Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    return:  Hash index
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_Drawing::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPExcel_Worksheet_MemoryDrawing::getHashIndex()

		
Get hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

	

	
        
[ Top ]

  

  

	
	
method getHeight [line 333]

	

    

    

		int getHeight(
)
    

    


	
		Get Height

Get Height





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getHeight()

		
Get Height

	

	

	
        
[ Top ]

  

  

	
	
method getImageIndex [line 166]

	

    

    

		int getImageIndex(
)
    

    


	
		Get image index

Get image index





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getName [line 175]

	

    

    

		string getName(
)
    

    


	
		Get Name

Get Name





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getName()

		
Get Name

	

	

	
        
[ Top ]

  

  

	
	
method getOffsetX [line 272]

	

    

    

		int getOffsetX(
)
    

    


	
		Get OffsetX

Get OffsetX





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getOffsetX()

		
Get OffsetX

	

	

	
        
[ Top ]

  

  

	
	
method getOffsetY [line 290]

	

    

    

		int getOffsetY(
)
    

    


	
		Get OffsetY

Get OffsetY





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getOffsetY()

		
Get OffsetY

	

	

	
        
[ Top ]

  

  

	
	
method getResizeProportional [line 380]

	

    

    

		boolean getResizeProportional(
)
    

    


	
		Get ResizeProportional

Get ResizeProportional





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getResizeProportional()

		
Get ResizeProportional

	

	

	
        
[ Top ]

  

  

	
	
method getRotation [line 398]

	

    

    

		int getRotation(
)
    

    


	
		Get Rotation

Get Rotation





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getShadow [line 416]

	

    

    

		PHPExcel_Worksheet_Drawing_Shadow getShadow(
)
    

    


	
		Get Shadow

Get Shadow





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method getWidth [line 308]

	

    

    

		int getWidth(
)
    

    


	
		Get Width

Get Width





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::getWidth()

		
Get Width

	

	

	
        
[ Top ]

  

  

	
	
method getWorksheet [line 211]

	

    

    

		PHPExcel_Worksheet getWorksheet(
)
    

    


	
		Get Worksheet

Get Worksheet





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method setCoordinates [line 263]

	

    

    

		void setCoordinates(
[string
$pValue = 'A1'])
    

    


	
		Set Coordinates

Set Coordinates





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setDescription [line 202]

	

    

    

		void setDescription(
[string
$pValue = ''])
    

    


	
		Set Description

Set Description





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setHashIndex [line 478]

	

    

    

		void setHashIndex(
string
$value)
    

    


	
		Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_Drawing::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

		

	
PHPExcel_Worksheet_MemoryDrawing::setHashIndex()

		
Set hash index
 Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

	

	

	
        
Parameters:

    

    

          

        string  
        $value  
        Hash index
      

        

    


        
[ Top ]

  

  

	
	
method setHeight [line 342]

	

    

    

		void setHeight(
[int
$pValue = 0])
    

    


	
		Set Height

Set Height





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setHeight()

		
Set Height

	

	

	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setName [line 184]

	

    

    

		void setName(
[string
$pValue = ''])
    

    


	
		Set Name

Set Name





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setName()

		
Set Name

	

	

	
        
Parameters:

    

    

          

        string  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setOffsetX [line 281]

	

    

    

		void setOffsetX(
[int
$pValue = 0])
    

    


	
		Set OffsetX

Set OffsetX





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setOffsetX()

		
Set OffsetX

	

	

	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setOffsetY [line 299]

	

    

    

		void setOffsetY(
[int
$pValue = 0])
    

    


	
		Set OffsetY

Set OffsetY





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setOffsetY()

		
Set OffsetY

	

	

	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setResizeProportional [line 389]

	

    

    

		void setResizeProportional(
[boolean
$pValue = true])
    

    


	
		Set ResizeProportional

Set ResizeProportional





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setResizeProportional()

		
Set ResizeProportional

	

	

	
        
Parameters:

    

    

          

        boolean  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setRotation [line 407]

	

    

    

		void setRotation(
[int
$pValue = 0])
    

    


	
		Set Rotation

Set Rotation





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setShadow [line 426]

	

    

    

		void setShadow(
[
$pValue = null])
    

    


	
		Set Shadow

Set Shadow





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet_Drawing_Shadow  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWidth [line 317]

	

    

    

		void setWidth(
[int
$pValue = 0])
    

    


	
		Set Width

Set Width





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setWidth()

		
Set Width

	

	

	
        
Parameters:

    

    

          

        int  
        $pValue  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWidthAndHeight [line 361]

	

    

    

		void setWidthAndHeight(
[int
$width = 0], [int
$height = 0])
    

    


	
		Set width and height with proportional resize

Set width and height with proportional resize





Tags:





  

    author:  Vincent@luo MSN:kele_100@hotmail.com
  

  

    access:  public
  

  

    example:  example not found
  

  

    example:  example not found
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::setWidthAndHeight()

		
Set width and height with proportional resize

	

	

	
        
Parameters:

    

    

          

        int  
        $width  
        
      

          

        int  
        $height  
        
      

        

    


        
[ Top ]

  

  

	
	
method setWorksheet [line 222]

	

    

    

		void setWorksheet(
[PHPExcel_Worksheet
$pValue = null], [bool
$pOverrideOld = false])
    

    


	
		Set Worksheet

Set Worksheet





Tags:





  

    throws:  Exception
  

  

    access:  public
  









	
        
Parameters:

    

    

          

        PHPExcel_Worksheet  
        $pValue  
        
      

          

        bool  
        $pOverrideOld  
        If a Worksheet has already been assigned, overwrite it and remove image from old Worksheet?
      

        

    


        
[ Top ]

  

  

	
	
method __clone [line 485]

	

    

    

		void __clone(
)
    

    


	
		Implement PHP __clone to create a deep clone, not just a shallow copy.

Implement PHP __clone to create a deep clone, not just a shallow copy.





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
PHPExcel_Worksheet_Drawing::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

		

	
PHPExcel_Worksheet_HeaderFooterDrawing::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

		

	
PHPExcel_Worksheet_MemoryDrawing::__clone()

		
Implement PHP __clone to create a deep clone, not just a shallow copy.

	

	

	
        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 05 Jan 2009 20:36:25 +0100 by phpDocumentor 1.4.1