Share via

2.2.4.61 RestRangePngRequest

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

When passed as the request parameter of the ProcessRestRequest input (section 3.1.4.56.2.1), indicates retrieving an image representing a range.

 <xs:complexType name="RestRangePngRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:RestRequest">
       <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="RangeName" type="xs:string"/>
         <xs:element minOccurs="1" maxOccurs="1" name="Nov" type="xs:boolean"/>
         <xs:element minOccurs="1" maxOccurs="1" name="Width" type="xs:int"/>
         <xs:element minOccurs="1" maxOccurs="1" name="Height" type="xs:int"/>
         <xs:element minOccurs="1" maxOccurs="1" name="CropX" type="xs:int"/>
         <xs:element minOccurs="1" maxOccurs="1" name="CropY" type="xs:int"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

RangeName: The name of the range to retrieve. MUST not be empty.

Nov:  Specifies whether the operation is performed on a named object. MUST be set to true if the operation is being performed on a named object. Otherwise, MUST be set to false.

Width: When scaling, indicates the maximum width in pixels the image needs to be scaled to. If the value is less than or equal to zero, the protocol server ignores it. Because the returned image keeps aspect ratio of the original image and it is possible to indicate the maximum height of the image, the actual width of the returned image MAY be smaller than requested. Only scale down is supported.

Height: When scaling, Indicates the maximum height in pixels the image needs to be scaled to. If the value is less than or equal to zero, the protocol server ignores it. Because the returned image keeps aspect ratio of the original image and it is possible to indicate the maximum width of the image, the actual height of the returned image MAY be smaller than requested. Only scaled down is supported.

CropX: The width in pixels used to limit the number of columns of the range of the returned image. If the value is less than or equal to zero, the protocol server ignores it. The cumulative pixel width of all visible columns in the requested range will be compared with CropX. If the cumulative width of a column is equal or exceeds CropX, then that column will be last one rendered into the returned image.

CropY: The height in pixels used to limit the number of rows of the range of the returned image. If the value is less than or equal to zero, the protocol server ignores it. The cumulative pixel height of all visible rows in the requested range will be compared with CropY. If the cumulative height of a row is equal or exceeds CropY, then that row will be last one rendered into the returned image.