aspose.cells

Class ImageOrPrintOptions

Allows to specify options when rendering worksheet to images, printing worksheet or rendering chart to image.

Example:

$options = new cells\ImageOrPrintOptions();
//set Horizontal resolution
$options->setHorizontalResolution(200);
//set Vertica; Resolution
$options->setVerticalResolution(300);

//Instantiate Workbook
$workbook = new cells\Workbook();
$cells = $workbook->getWorksheets()->get(0)->getCells();
$cells->get("a1")->putValue(2);
$cells->get("a2")->putValue(5);
$cells->get("a3")->putValue(3);
$cells->get("a4")->putValue(6);
$cells->get("b1")->putValue(4);
$cells->get("b2")->putValue(3);
$cells->get("b3")->putValue(6);
$cells->get("b4")->putValue(7);
$chartIndex = $workbook->getWorksheets()->get(0)->getCharts()->add(cells\ChartType::COLUMN, 11, 0, 27, 10);
$chart = $workbook->getWorksheets()->get(0)->getCharts()->get($chartIndex);
$chart->getNSeries()->add("A1:B4", true);
//Save chart as Image using ImageOrPrint Options
$chart->toImage("res.png", $options);

Constructor Summary
 
Property Getters/Setters Summary
functiongetAllColumnsInOnePagePerSheet()
function
           If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
functiongetChartImageType()
function
           Indicate the chart imagetype when converting. default value: PNG.
functiongetCheckWorkbookDefaultFont()
function
           When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook's default font to show these characters first.
functiongetDefaultEditLanguage()
function
           Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.
functiongetDefaultFont()
function
           When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
functiongetDrawObjectEventHandler()
function
           Implements this interface to get DrawObject and Bound when rendering.
functiongetEmbededImageNameInSvg()
function
           Indicate the filename of embedded image in svg. This should be full path with directory like "c:\\xpsEmbedded"
functiongetEmfRenderSetting()
function
           Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
functiongetGridlineType()
function
           Gets or sets gridline type. The value of the property is GridlineType integer constant.
functiongetHorizontalResolution()
function
           Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.
functiongetImageType()
function
           Gets or sets the format of the generated images. default value: PNG. The value of the property is ImageType integer constant.
functionisCellAutoFit()
function
           Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
functionisFontSubstitutionCharGranularity()
function
           Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
functionisOptimized()
function
           Indicates whether to optimize the output elements.
functiongetOnePagePerSheet()
function
           If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
functiongetOnlyArea()
function
           If this property is true , one Area will be output, and no scale will take effect.
functiongetOutputBlankPageWhenNothingToPrint()
function
           Indicates whether to output a blank page when there is nothing to print.
functiongetPageCount()
function
           Gets or sets the number of pages to save.
functiongetPageIndex()
function
           Gets or sets the 0-based index of the first page to save.
functiongetPageSavingCallback()
function
           Control/Indicate progress of page saving process.
functiongetPrintingPage()
function
           Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
functiongetPrintWithStatusDialog()
function
           If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
functiongetQuality()
function
setQuality(value)
           Gets or sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100
functiongetSaveFormat()
function
           Gets or sets the output file format type Support Tiff/XPS The value of the property is SaveFormat integer constant.
functiongetSheetSet()
function
           Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
functiongetSVGFitToViewPort()
function
           if this property is true, the generated svg will fit to view port.
functiongetTextCrossType()
function
           Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.
functiongetTiffColorDepth()
function
           Gets or sets bit depth to apply only when saving pages to the Tiff format. The value of the property is ColorDepth integer constant.
functiongetTiffCompression()
function
           Gets or sets the type of compression to apply only when saving pages to the Tiff format. The value of the property is TiffCompression integer constant.
functiongetTransparent()
function
           Indicates if the background of generated image should be transparent.
functiongetVerticalResolution()
function
           Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.
 
Method Summary
functiongetTiffPhotometricInterpretation()
Gets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format.
functionsetDesiredSize(desiredWidth, desiredHeight)
Sets desired width and height of image.
functionsetDesiredSize(desiredWidth, desiredHeight, keepAspectRatio)
Sets desired width and height of image.
functionsetRenderingHint(key, value)
Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values.
functionsetTiffPhotometricInterpretation(value)
Sets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format.
 

    • Constructor Detail

      • ImageOrPrintOptions

        function ImageOrPrintOptions()
    • Property Getters/Setters Detail

      • getSaveFormat/setSaveFormat : Number 

        function getSaveFormat() / function setSaveFormat(value)
        
        Gets or sets the output file format type Support Tiff/XPS The value of the property is SaveFormat integer constant. NOTE: This member is now obsolete. Instead, For Tiff/Svg, use ImageType; For Xps, use Workbook.save(java.lang.String, com.aspose.cells.SaveOptions) with XpsSaveOptions. This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
      • getPrintWithStatusDialog/setPrintWithStatusDialog : boolean 

        function getPrintWithStatusDialog() / function setPrintWithStatusDialog(value)
        
        If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
      • getHorizontalResolution/setHorizontalResolution : Number 

        function getHorizontalResolution() / function setHorizontalResolution(value)
        
        Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. The default value is 96.
      • getVerticalResolution/setVerticalResolution : Number 

        function getVerticalResolution() / function setVerticalResolution(value)
        
        Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. The default value is 96.
      • getTiffCompression/setTiffCompression : Number 

        function getTiffCompression() / function setTiffCompression(value)
        
        Gets or sets the type of compression to apply only when saving pages to the Tiff format. The value of the property is TiffCompression integer constant. Has effect only when saving to TIFF. The default value is Lzw.
      • getTiffColorDepth/setTiffColorDepth : Number 

        function getTiffColorDepth() / function setTiffColorDepth(value)
        
        Gets or sets bit depth to apply only when saving pages to the Tiff format. The value of the property is ColorDepth integer constant. Has effect only when saving to TIFF. If TiffCompression is set to CCITT3, CCITT4, this will not take effect, the bit depth of the generated tiff image will be always 1.
      • getPrintingPage/setPrintingPage : Number 

        function getPrintingPage() / function setPrintingPage(value)
        
        Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
      • getQuality/setQuality : Number 

        function getQuality() / function setQuality(value)
        
        Gets or sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100 Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.
      • getImageType/setImageType : Number 

        function getImageType() / function setImageType(value)
        
        Gets or sets the format of the generated images. default value: PNG. The value of the property is ImageType integer constant.
      • getOnePagePerSheet/setOnePagePerSheet : boolean 

        function getOnePagePerSheet() / function setOnePagePerSheet(value)
        
        If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
      • getAllColumnsInOnePagePerSheet/setAllColumnsInOnePagePerSheet : boolean 

        function getAllColumnsInOnePagePerSheet() / function setAllColumnsInOnePagePerSheet(value)
        
        If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
      • getDrawObjectEventHandler/setDrawObjectEventHandler : DrawObjectEventHandler 

        function getDrawObjectEventHandler() / function setDrawObjectEventHandler(value)
        
        Implements this interface to get DrawObject and Bound when rendering.
      • getChartImageType/setChartImageType : ImageFormat 

        function getChartImageType() / function setChartImageType(value)
        
        Indicate the chart imagetype when converting. default value: PNG. NOTE: This member is now obsolete. Instead, Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.
      • getEmbededImageNameInSvg/setEmbededImageNameInSvg : String 

        function getEmbededImageNameInSvg() / function setEmbededImageNameInSvg(value)
        
        Indicate the filename of embedded image in svg. This should be full path with directory like "c:\\xpsEmbedded"
      • getSVGFitToViewPort/setSVGFitToViewPort : boolean 

        function getSVGFitToViewPort() / function setSVGFitToViewPort(value)
        
        if this property is true, the generated svg will fit to view port.
      • getOnlyArea/setOnlyArea : boolean 

        function getOnlyArea() / function setOnlyArea(value)
        
        If this property is true , one Area will be output, and no scale will take effect.
      • getTransparent/setTransparent : boolean 

        function getTransparent() / function setTransparent(value)
        
        Indicates if the background of generated image should be transparent. The default value is false. That means the background of the generated images is white.
      • getPageSavingCallback/setPageSavingCallback : IPageSavingCallback 

        function getPageSavingCallback() / function setPageSavingCallback(value)
        
        Control/Indicate progress of page saving process.
      • isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean 

        function isFontSubstitutionCharGranularity() / function setFontSubstitutionCharGranularity(value)
        
        Indicates whether to only substitute the font of character when the cell font is not compatibility for it. Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
      • getPageIndex/setPageIndex : Number 

        function getPageIndex() / function setPageIndex(value)
        
        Gets or sets the 0-based index of the first page to save. Default is 0.
      • getPageCount/setPageCount : Number 

        function getPageCount() / function setPageCount(value)
        
        Gets or sets the number of pages to save. Default is System.Int32.MaxValue which means all pages will be rendered.
      • isOptimized/setOptimized : boolean 

        function isOptimized() / function setOptimized(value)
        
        Indicates whether to optimize the output elements. Default value is false. Currently when this property is set to true, the following optimizations will be done: 1. optimize the border lines. 2. optimize the file size while rendering to Svg image.
      • getDefaultFont/setDefaultFont : String 

        function getDefaultFont() / function setDefaultFont(value)
        
        When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
      • getCheckWorkbookDefaultFont/setCheckWorkbookDefaultFont : boolean 

        function getCheckWorkbookDefaultFont() / function setCheckWorkbookDefaultFont(value)
        
        When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook's default font to show these characters first. Default is true.
      • getOutputBlankPageWhenNothingToPrint/setOutputBlankPageWhenNothingToPrint : boolean 

        function getOutputBlankPageWhenNothingToPrint() / function setOutputBlankPageWhenNothingToPrint(value)
        
        Indicates whether to output a blank page when there is nothing to print. Default is false.
      • getGridlineType/setGridlineType : Number 

        function getGridlineType() / function setGridlineType(value)
        
        Gets or sets gridline type. The value of the property is GridlineType integer constant. Default is Dotted type.
      • getTextCrossType/setTextCrossType : Number 

        function getTextCrossType() / function setTextCrossType(value)
        
        Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.
      • getDefaultEditLanguage/setDefaultEditLanguage : Number 

        function getDefaultEditLanguage() / function setDefaultEditLanguage(value)
        
        Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant. It may display/render different layouts for text paragraph when different edit languages is set. Default is DefaultEditLanguage.AUTO.
      • getSheetSet/setSheetSet : SheetSet 

        function getSheetSet() / function setSheetSet(value)
        
        Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible. The set is ignored when it is used in SheetRender
      • getEmfRenderSetting/setEmfRenderSetting : Number 

        function getEmfRenderSetting() / function setEmfRenderSetting(value)
        
        Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed. Default value is EmfRenderSetting.EMF_ONLY. For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored.
    • Method Detail

      • getTiffPhotometricInterpretation

        function getTiffPhotometricInterpretation()
        Gets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format. Has effect only when saving to TIFF. The default value is -1, represent no PhotometricInterpretation is applied.
      • setTiffPhotometricInterpretation

        function setTiffPhotometricInterpretation(value)
        Sets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format. Has effect only when saving to TIFF. The default value is -1, represent no PhotometricInterpretation is applied.
      • setRenderingHint

        function setRenderingHint(key, value)
        Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values.
        Parameters:
        key: Key - the key of the hint to be set.
        value: Object - the value indicating preferences for the specified hint category.
      • setDesiredSize

        function setDesiredSize(desiredWidth, desiredHeight)
        Sets desired width and height of image. NOTE: This member is now obsolete. Instead, please use setDesiredSize(int, int, boolean) by setting param keepAspectRatio to false. This property will be removed 12 months later since May 2023. Aspose apologizes for any inconvenience you may have experienced.
        Parameters:
        desiredWidth: Number - desired width in pixels
        desiredHeight: Number - desired height in pixels
      • setDesiredSize

        function setDesiredSize(desiredWidth, desiredHeight, keepAspectRatio)
        Sets desired width and height of image.
        Parameters:
        desiredWidth: Number - desired width in pixels
        desiredHeight: Number - desired height in pixels
        keepAspectRatio: boolean - whether to keep aspect ratio of origin image