Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface stretchCreateRendererParams

Hierarchy

  • Object
    • stretchCreateRendererParams

Index

Properties

Optional bandId

bandId: number

The 0-based index of a selected band.

Read more...

Optional colorRamp

The color ramp to apply to the renderer.

Read more...

constructor

constructor: Function

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Optional dynamicRangeAdjustment

dynamicRangeAdjustment: boolean

When true, calculates the renderer's statistics based on the current display extent and recalculates them as you zoom and pan around the image.

Read more...

Optional estimateStatistics

estimateStatistics: boolean

Useful in scenarios where an image service does not have statistics.

Read more...

Optional gamma

gamma: number[]

The gamma values to be used if useGamma is true.

Read more...

Optional includeStatisticsInStretch

includeStatisticsInStretch: boolean

When true, the returned stretch renderer will extract statistics from service stats by considering band information and set them in the output renderer's statistics property.

Read more...

layer

The input layer for which the renderer is generated.

Read more...

Optional renderingRule

renderingRule: RasterFunction

Specifies the rule for how the requested image should be rendered.

Read more...

Optional signal

signal: AbortSignal

Allows for cancelable requests.

Read more...

Optional stretchType

stretchType: "none" | "standard-deviation" | "histogram-equalization" | "min-max" | "percent-clip" | "sigmoid"

A preferred stretch type can be provided.

Read more...

Optional useGamma

useGamma: boolean

Indicates whether the gamma values should be used.

Read more...

Optional variableName

variableName: string

Only applicable to multidimensional datasets where a raster layer can contain more than one variable (such as temperature, humidity, wind speed) with different statistics.

Read more...

Methods

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object
  • Returns the primitive value of the specified object.

    Returns Object

Generated using TypeDoc