com.esri.arcgis.carto
Interface IRasterStretch

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRasterStretchProxy, RasterRGBRenderer, RasterStretchColorRampRenderer

public interface IRasterStretch
extends java.io.Serializable

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

Description: 'Provides access to members which control contrast stretching.' 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	IID48bb9988_8250_11d3_aba2_0008c73fca1c
static int	xxDummy Deprecated. Internal use only

Method Summary

IColor	getBackgroundColor() Background display color.
double	getBackgroundValues() Indicates whether an array of background values is being used.
double	getStandardDeviationsParam() Standard deviation parameter for the stretch renderer.
int	getStretchType() 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) Background display color.
void	setBackgroundValues(double[] pBkg) Indicates whether an array of background values is being used.
void	setInvert(boolean pInvert) Indicates if the stretch is inverted.
void	setStandardDeviationsParam(double param) Standard deviation parameter for the stretch renderer.
void	setStretchType(int en_stretch) Current stretch type.

Field Detail

IID48bb9988_8250_11d3_aba2_0008c73fca1c

static final int IID48bb9988_8250_11d3_aba2_0008c73fca1c

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 en_stretch)
                    throws java.io.IOException,
                           AutomationException

Current stretch type.

Parameters:

en_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

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

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

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.

getBackgroundValues

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

Indicates whether an array of background values is being used.

Returns:

The pBkg

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

void setBackgroundValues(double[] pBkg)
                         throws java.io.IOException,
                                AutomationException

Indicates whether an array of background values is being used.

Parameters:

pBkg - The pBkg (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

Background display color.

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

Background display color.

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.