On this page

Type Alias SymbolLayoutProps

type SymbolLayoutProps = {
    "icon-allow-overlap": DataConstantProperty<boolean>;
    "icon-anchor": DataDrivenProperty<
        | "center"
        | "left"
        | "right"
        | "top"
        | "bottom"
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right",
    >;
    "icon-ignore-placement": DataConstantProperty<boolean>;
    "icon-image": DataDrivenProperty<ResolvedImage>;
    "icon-keep-upright": DataConstantProperty<boolean>;
    "icon-offset": DataDrivenProperty<[number, number]>;
    "icon-optional": DataConstantProperty<boolean>;
    "icon-overlap": DataConstantProperty<"never" | "always" | "cooperative">;
    "icon-padding": DataDrivenProperty<Padding>;
    "icon-pitch-alignment": DataConstantProperty<"map" | "viewport" | "auto">;
    "icon-rotate": DataDrivenProperty<number>;
    "icon-rotation-alignment": DataConstantProperty<
        "map"
        | "viewport"
        | "auto",
    >;
    "icon-size": DataDrivenProperty<number>;
    "icon-text-fit": DataConstantProperty<"none" | "width" | "height" | "both">;
    "icon-text-fit-padding": DataConstantProperty<
        [number, number, number, number],
    >;
    "symbol-avoid-edges": DataConstantProperty<boolean>;
    "symbol-placement": DataConstantProperty<"point" | "line" | "line-center">;
    "symbol-sort-key": DataDrivenProperty<number>;
    "symbol-spacing": DataConstantProperty<number>;
    "symbol-z-order": DataConstantProperty<"auto" | "viewport-y" | "source">;
    "text-allow-overlap": DataConstantProperty<boolean>;
    "text-anchor": DataDrivenProperty<
        | "center"
        | "left"
        | "right"
        | "top"
        | "bottom"
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right",
    >;
    "text-field": DataDrivenProperty<Formatted>;
    "text-font": DataDrivenProperty<string[]>;
    "text-ignore-placement": DataConstantProperty<boolean>;
    "text-justify": DataDrivenProperty<"auto" | "left" | "center" | "right">;
    "text-keep-upright": DataConstantProperty<boolean>;
    "text-letter-spacing": DataDrivenProperty<number>;
    "text-line-height": DataConstantProperty<number>;
    "text-max-angle": DataConstantProperty<number>;
    "text-max-width": DataDrivenProperty<number>;
    "text-offset": DataDrivenProperty<[number, number]>;
    "text-optional": DataConstantProperty<boolean>;
    "text-overlap": DataConstantProperty<"never" | "always" | "cooperative">;
    "text-padding": DataConstantProperty<number>;
    "text-pitch-alignment": DataConstantProperty<"map" | "viewport" | "auto">;
    "text-radial-offset": DataDrivenProperty<number>;
    "text-rotate": DataDrivenProperty<number>;
    "text-rotation-alignment": DataConstantProperty<
        "map"
        | "viewport"
        | "viewport-glyph"
        | "auto",
    >;
    "text-size": DataDrivenProperty<number>;
    "text-transform": DataDrivenProperty<"none" | "uppercase" | "lowercase">;
    "text-variable-anchor": DataConstantProperty<
        (
            | "center"
            | "left"
            | "right"
            | "top"
            | "bottom"
            | "top-left"
            | "top-right"
            | "bottom-left"
            | "bottom-right"
        )[],
    >;
    "text-variable-anchor-offset": DataDrivenProperty<
        VariableAnchorOffsetCollection,
    >;
    "text-writing-mode": DataConstantProperty<("horizontal" | "vertical")[]>;
}
Index

Properties

"icon-allow-overlap": DataConstantProperty<boolean>
"icon-anchor": DataDrivenProperty<
    | "center"
    | "left"
    | "right"
    | "top"
    | "bottom"
    | "top-left"
    | "top-right"
    | "bottom-left"
    | "bottom-right",
>
"icon-ignore-placement": DataConstantProperty<boolean>
"icon-keep-upright": DataConstantProperty<boolean>
"icon-offset": DataDrivenProperty<[number, number]>
"icon-optional": DataConstantProperty<boolean>
"icon-overlap": DataConstantProperty<"never" | "always" | "cooperative">
"icon-padding": DataDrivenProperty<Padding>
"icon-pitch-alignment": DataConstantProperty<"map" | "viewport" | "auto">
"icon-rotate": DataDrivenProperty<number>
"icon-rotation-alignment": DataConstantProperty<"map" | "viewport" | "auto">
"icon-size": DataDrivenProperty<number>
"icon-text-fit": DataConstantProperty<"none" | "width" | "height" | "both">
"icon-text-fit-padding": DataConstantProperty<[number, number, number, number]>
"symbol-avoid-edges": DataConstantProperty<boolean>
"symbol-placement": DataConstantProperty<"point" | "line" | "line-center">
"symbol-sort-key": DataDrivenProperty<number>
"symbol-spacing": DataConstantProperty<number>
"symbol-z-order": DataConstantProperty<"auto" | "viewport-y" | "source">
"text-allow-overlap": DataConstantProperty<boolean>
"text-anchor": DataDrivenProperty<
    | "center"
    | "left"
    | "right"
    | "top"
    | "bottom"
    | "top-left"
    | "top-right"
    | "bottom-left"
    | "bottom-right",
>
"text-font": DataDrivenProperty<string[]>
"text-ignore-placement": DataConstantProperty<boolean>
"text-justify": DataDrivenProperty<"auto" | "left" | "center" | "right">
"text-keep-upright": DataConstantProperty<boolean>
"text-letter-spacing": DataDrivenProperty<number>
"text-line-height": DataConstantProperty<number>
"text-max-angle": DataConstantProperty<number>
"text-max-width": DataDrivenProperty<number>
"text-offset": DataDrivenProperty<[number, number]>
"text-optional": DataConstantProperty<boolean>
"text-overlap": DataConstantProperty<"never" | "always" | "cooperative">
"text-padding": DataConstantProperty<number>
"text-pitch-alignment": DataConstantProperty<"map" | "viewport" | "auto">
"text-radial-offset": DataDrivenProperty<number>
"text-rotate": DataDrivenProperty<number>
"text-rotation-alignment": DataConstantProperty<
    "map"
    | "viewport"
    | "viewport-glyph"
    | "auto",
>
"text-size": DataDrivenProperty<number>
"text-transform": DataDrivenProperty<"none" | "uppercase" | "lowercase">
"text-variable-anchor": DataConstantProperty<
    (
        | "center"
        | "left"
        | "right"
        | "top"
        | "bottom"
        | "top-left"
        | "top-right"
        | "bottom-left"
        | "bottom-right"
    )[],
>
"text-variable-anchor-offset": DataDrivenProperty<
    VariableAnchorOffsetCollection,
>
"text-writing-mode": DataConstantProperty<("horizontal" | "vertical")[]>
Was this helpful?
SDK JS
Reference
SymbolLayoutProps