---
title: "MTColorRamp | Mobile sdk | Mobile sdk android | Android"
description: "MTColorRamp"
---

# MTColorRamp

@Serializable(with = MTColorRampSerializer::class)

class [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Reference to a color ramp instance.

Members

## Types

[Companion](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/-companion/)

object [Companion](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/-companion/)

## Functions

[clone](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/clone/)

suspend fun [clone](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/clone/)(): [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Clone this color ramp.

[getBounds](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-bounds/)

suspend fun [getBounds](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-bounds/)(): [MTColorRampBounds](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-bounds/)

Returns the bounds of this color ramp.

[getCanvasStrip](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-canvas-strip/)

suspend fun [getCanvasStrip](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-canvas-strip/)(options: [MTColorRampCanvasOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-canvas-options/)? = null): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?

Returns a data URL of the rendered strip of this color ramp.

[getColor](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-color/)

suspend fun [getColor](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-color/)(value: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html), options: [MTColorRampGetColorOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-get-color-options/)? = null): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)\>

Returns the RGBA color for a given value.

[getColorHex](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-color-hex/)

suspend fun [getColorHex](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-color-hex/)(value: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html), options: [MTColorRampGetColorOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-get-color-options/)? = null): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)?

Returns the hex color for a given value.

[getColorRelative](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-color-relative/)

suspend fun [getColorRelative](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-color-relative/)(value: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html), options: [MTColorRampGetColorOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-get-color-options/)? = null): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)\>

Returns the RGBA color for a relative value between 0 and 1.

[getRawColorStops](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-raw-color-stops/)

suspend fun [getRawColorStops](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/get-raw-color-stops/)(): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[MTColorStop](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-stop/)\>

Returns the raw color stops backing this ramp.

[hasTransparentStart](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/has-transparent-start/)

suspend fun [hasTransparentStart](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/has-transparent-start/)(): [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)

Indicates if the ramp starts with transparency.

[resample](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/resample/)

suspend fun [resample](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/resample/)(method: [MTColorRampResamplingMethod](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-resampling-method/), samples: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 15): [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Resample the ramp using a non-linear method.

[reverse](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/reverse/)

suspend fun [reverse](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/reverse/)(options: [MTColorRampCloneOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-clone-options/)? = null): [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Reverse the ramp. When clone is false, the current ramp is mutated and returned.

[scale](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/scale/)

suspend fun [scale](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/scale/)(min: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html), max: [Double](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html), options: [MTColorRampCloneOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-clone-options/)? = null): [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Scale the ramp to a new interval. When clone is false, the current ramp is mutated and returned.

[setStops](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/set-stops/)

suspend fun [setStops](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/set-stops/)(stops: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[MTColorStop](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-stop/)\>, options: [MTColorRampCloneOptions](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp-clone-options/)? = null): [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Replace the stops of this ramp. When clone is false, the current ramp is mutated and returned.

[transparentStart](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/transparent-start/)

suspend fun [transparentStart](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/transparent-start/)(): [MTColorRamp](https://docs.maptiler.com/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.colorramp/-m-t-color-ramp/)

Returns a ramp that starts fully transparent.