com.esri.arcgis.carto
Interface IRasterStretch2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRasterStretch2Proxy, RasterRGBRenderer, RasterStretchColorRampRenderer

public interface IRasterStretch2
extends java.io.Serializable

COM Interface 'IRasterStretch2'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members which control stretch.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID51ee1518_7261_4fdd_99c7_b4e35cfc7da0
static int	xxDummy Deprecated. Internal use only

Method Summary

IColor	getBackgroundColor() The color of background.
java.lang.Object	getBackgroundValue() The list of background value(s).
IArray	getSpecificationHistogram() The statistics for histogram specification stretch.
double	getStandardDeviationsParam() The standard deviation parameter for the stretch renderer.
IArray	getStretchStats() The global raster stretch statistics.
int	getStretchStatsType() The current stretch statistics type.
int	getStretchType() The current stretch type.
boolean	isBackground() Indicates if a background value is being used.
boolean	isInvert() Indicates if the stretch is inverted.
void	setBackground(boolean b) Indicates if a background value is being used.
void	setBackgroundColorByRef(IColor ppColor) The color of background.
void	setBackgroundValue(java.lang.Object background) The list of background value(s).
void	setInvert(boolean pInvert) Indicates if the stretch is inverted.
void	setSpecificationHistogramByRef(IArray pRGBStats) The statistics for histogram specification stretch.
void	setStandardDeviationsParam(double param) The standard deviation parameter for the stretch renderer.
void	setStretchStatsByRef(IArray ppRGBStats) The global raster stretch statistics.
void	setStretchStatsType(int stats) The current stretch statistics type.
void	setStretchType(int stretch) The current stretch type.

Field Detail

IID51ee1518_7261_4fdd_99c7_b4e35cfc7da0

static final int IID51ee1518_7261_4fdd_99c7_b4e35cfc7da0

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setStretchType

void setStretchType(int stretch)
                    throws java.io.IOException,
                           AutomationException

The current stretch type.

Parameters:

stretch - A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStretchType

int getStretchType()
                   throws java.io.IOException,
                          AutomationException

The current stretch type.

Returns:

A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStandardDeviationsParam

void setStandardDeviationsParam(double param)
                                throws java.io.IOException,
                                       AutomationException

The standard deviation parameter for the stretch renderer.

Parameters:

param - The param (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardDeviationsParam

double getStandardDeviationsParam()
                                  throws java.io.IOException,
                                         AutomationException

The standard deviation parameter for the stretch renderer.

Returns:

The param

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInvert

void setInvert(boolean pInvert)
               throws java.io.IOException,
                      AutomationException

Indicates if the stretch is inverted.

Parameters:

pInvert - The pInvert (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInvert

boolean isInvert()
                 throws java.io.IOException,
                        AutomationException

Indicates if the stretch is inverted.

Returns:

The pInvert

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(boolean b)
                   throws java.io.IOException,
                          AutomationException

Indicates if a background value is being used.

Parameters:

b - The b (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBackground

boolean isBackground()
                     throws java.io.IOException,
                            AutomationException

Indicates if a background value is being used.

Returns:

The b

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundValue

java.lang.Object getBackgroundValue()
                                    throws java.io.IOException,
                                           AutomationException

The list of background value(s).

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundValue

void setBackgroundValue(java.lang.Object background)
                        throws java.io.IOException,
                               AutomationException

The list of background value(s).

Parameters:

background - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

The color of background.

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundColorByRef

void setBackgroundColorByRef(IColor ppColor)
                             throws java.io.IOException,
                                    AutomationException

The color of background.

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStretchStatsType

void setStretchStatsType(int stats)
                         throws java.io.IOException,
                                AutomationException

The current stretch statistics type.

Parameters:

stats - A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStretchStatsType

int getStretchStatsType()
                        throws java.io.IOException,
                               AutomationException

The current stretch statistics type.

Returns:

A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStretchStatsByRef

void setStretchStatsByRef(IArray ppRGBStats)
                          throws java.io.IOException,
                                 AutomationException

The global raster stretch statistics.

Parameters:

ppRGBStats - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStretchStats

IArray getStretchStats()
                       throws java.io.IOException,
                              AutomationException

The global raster stretch statistics.

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpecificationHistogramByRef

void setSpecificationHistogramByRef(IArray pRGBStats)
                                    throws java.io.IOException,
                                           AutomationException

The statistics for histogram specification stretch.

Parameters:

pRGBStats - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpecificationHistogram

IArray getSpecificationHistogram()
                                 throws java.io.IOException,
                                        AutomationException

The statistics for histogram specification stretch.

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.