On this page

Type Alias SymbolLayoutPropsPossiblyEvaluated

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

Properties

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