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

> For AI agents: a documentation index is available at [/llms.txt](https://docs-qmgv.pages.dev/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# MTHaloOption

@Serializable(with = [MTHaloOptionSerializer::class](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option-serializer/))

sealed class [MTHaloOption](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/)

Union wrapper for halo option: can be a simple enable flag or a full config object.

#### Inheritors

[Enabled](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/-enabled/)

[Config](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/-config/)

Members

## Types

[Config](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/-config/)

data class [Config](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/-config/)(val value: [MTHalo](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo/)) : [MTHaloOption](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/)

Provide a full configuration.

[Enabled](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/-enabled/)

data object [Enabled](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/-enabled/) : [MTHaloOption](https://docs-qmgv.pages.dev/mobile-sdk/android/api/-map-tiler-s-d-k/com.maptiler.maptilersdk.map.options/-m-t-halo-option/)

Enable halo with default gradient.
