CarIconSpan

@CarProtocol
class CarIconSpan : CarSpan

A span that replaces the text it is attached to with a CarIcon that is aligned with the surrounding text.

The image may be scaled with the text differently depending on the template that the text belongs to. Refer to the documentation of each template for that information.

For example, the following code creates a string for a navigation maneuver that has an image with the number of a highway rendered as an icon in between "on" and "East":

SpannableString string = new SpannableString("Turn right on 520 East");
string.setSpan(
    CarIconSpan.create(new CarIcon.Builder(
        IconCompat.createWithResource(getCarContext(), R.drawable.ic_520_highway))),
        14, 17, SPAN_INCLUSIVE_EXCLUSIVE);

CarIconSpans in strings passed to the library templates may be ignored by the host when displaying the text unless support for them is explicitly documented in the API that takes the string.

This span will be ignored if it overlaps with any span that replaces text, such as another DistanceSpan, DurationSpan, or CarIconSpan.

Summary

const val ALIGN_BASELINE = 1: Int

const val ALIGN_BOTTOM = 0: Int

const val ALIGN_CENTER = 2: Int

java-static fun create(icon: CarIcon): CarIconSpan

java-static fun create(icon: CarIcon, alignment: Int): CarIconSpan

fun equals(other: Any?): Boolean

fun getAlignment(): Int

fun getIcon(): CarIcon

fun hashCode(): Int

fun toString(): String