TextOptions interface

Referencia

Paquete:: azure-maps-control

Opciones usadas para personalizar el texto en un SymbolLayer

Extends: Options

Propiedades

allowOverlap	Especifica si el texto estará visible si entra en conflicto con otros símbolos. Si es true, el texto será visible incluso si entra en conflicto con otros símbolos dibujados anteriormente. El valor predeterminado es `false`.
anchor	Especifica qué parte del icono se coloca más cerca de la posición del delimitador de iconos en el mapa. '"center"': el centro del icono se coloca más cerca del delimitador. '"left"': el lado izquierdo del icono se coloca más cerca del delimitador. '"right"': el lado derecho del icono se coloca más cerca del delimitador. '"top"': la parte superior del icono se coloca más cerca del delimitador. '"bottom"': la parte inferior del icono se coloca más cerca del delimitador. '"top-left"': la esquina superior izquierda del icono se coloca más cerca del delimitador. '"top-right"': la esquina superior derecha del icono se coloca más cerca del delimitador. '"bottom-left"': la esquina inferior izquierda del icono se coloca más cerca del delimitador. '"bottom-right"': la esquina inferior derecha del icono se coloca más cerca del delimitador. Predeterminado '"center"'.
color	Color del texto. El valor predeterminado es `"#000000"`.
font	Pila de fuentes que se va a usar para mostrar texto. Valores posibles: `"SegoeFrutigerHelveticaMYingHei-Bold"`, `"SegoeFrutigerHelveticaMYingHei-Medium"`, `"SegoeFrutigerHelveticaMYingHei-Regular"`, , `"SegoeUi-Light""SegoeUi-SemiBold""SegoeUi-Regular""StandardCondensedSegoeUi-Black""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Regular""SegoeUi-Bold""SegoeUi-SemiLight""StandardCondensedSegoeUi-Light"`, . `"StandardFontCondensed-Regular""StandardFont-Black""StandardFont-Bold""StandardFont-Light""StandardFont-Regular""StandardFontCondensed-Black""StandardFontCondensed-Bold""StandardFontCondensed-Light"` El valor predeterminado es `["StandardFont-Regular"]`.
haloBlur	Distancia de atenuación del halo hacia el exterior en píxeles. Debe ser un número mayor o igual a 0. El valor predeterminado es `0`.
haloColor	Color del halo del texto, que ayuda a destacar de los fondos. El valor predeterminado es `"rgba(0,0,0,0)"`.
haloWidth	Distancia del halo al contorno de fuente en píxeles. Debe ser un número mayor o igual a 0. El ancho máximo del halo de texto es de 1/4 del tamaño de fuente. El valor predeterminado es `0`.
ignorePlacement	Especifica si se permite que los demás símbolos entren en conflicto con el texto. Si es true, otros símbolos pueden ser visibles aunque entren en conflicto con el texto. El valor predeterminado es `false`.
justify	Opciones de justificación de texto. '"auto"': el texto se alinea hacia la posición del delimitador. '"left"': el texto se alinea a la izquierda. '"center"': el texto está centrado. '"right"': el texto está alineado a la derecha. Predeterminado '"center"'.
offset	Especifica una distancia de desplazamiento del icono desde su delimitador en ems. Los valores positivos indican derecha y abajo, mientras que los valores negativos indican hacia la izquierda y hacia arriba. El valor predeterminado es `[0, 0]`.
opacity	Número entre 0 y 1 que indica la opacidad en la que se dibujará el texto. El valor predeterminado es `1`.
optional	Especifica si el texto se puede ocultar si se superpone con otro símbolo. Si es true, los iconos se mostrarán sin su texto correspondiente cuando el texto entre en conflicto con otros símbolos y el icono no lo hace. El valor predeterminado es `false`.
padding	Tamaño del área adicional alrededor del cuadro de límite de texto usado para detectar colisiones de símbolos. El valor predeterminado es `2`.
pitchAlignment	Especifica la orientación del texto cuando se inclina el mapa. '"auto"': coincide automáticamente con el valor de 'rotationAlignment'. '"map"': el texto se alinea con el plano del mapa. '"viewport"': el texto está alineado con el plano de la ventanilla. Valor predeterminado: '"auto"'
radialOffset	Desplazamiento radial del texto, en la dirección del delimitador del símbolo. Resulta útil en combinación con `variableAnchor`, que usa de forma predeterminada la bidimensional `offset` si está presente. Valor predeterminado: `0`
rotation	Cantidad que se va a girar el texto en sentido de las agujas del reloj en grados. Predeterminado `0`
rotationAlignment	En combinación con la `placement` propiedad de `SymbolLayerOptions`, especifica el comportamiento de rotación de los glifos individuales que forman el texto. '"auto"': cuando 'placement' está establecido en '"point"', esto equivale a '"map"'. Cuando 'placement' se establece en ''line'' esto equivale a ''map''. '"map"': cuando 'placement' está establecido en ''point'', alinea el texto east-west. Cuando "placement" se establece en "line"", alinea los ejes x de texto con la línea. '"viewport"': genera glifos cuyos ejes X se alinean con el eje x de la ventanilla, independientemente del valor de 'placement'. Valor predeterminado: '"auto"'
size	Tamaño de la fuente en píxeles. Debe ser un número mayor o igual a 0. El valor predeterminado es `16`.
textField	Especifica el nombre de una propiedad en las características que se van a usar para una etiqueta de texto.
variableAnchor	Lista de posibles ubicaciones de anclaje, para aumentar la posibilidad de colocar etiquetas de alta prioridad en el mapa. El representador intentará colocar la etiqueta en cada ubicación, en orden, antes de pasar a la etiqueta siguiente. Use `justify: "auto"` para elegir la justificación de texto en función de la posición del delimitador. Para aplicar un desplazamiento, use las `radialOffset` opciones bidimensionales `offset` o . '"center"': el centro del icono se coloca más cerca del delimitador. '"left"': el lado izquierdo del icono se coloca más cerca del delimitador. '"right"': el lado derecho del icono se coloca más cerca del delimitador. '"top"': la parte superior del icono se coloca más cerca del delimitador. '"bottom"': la parte inferior del icono se coloca más cerca del delimitador. '"top-left"': la esquina superior izquierda del icono se coloca más cerca del delimitador. '"top-right"': la esquina superior derecha del icono se coloca más cerca del delimitador. '"bottom-left"': la esquina inferior izquierda del icono se coloca más cerca del delimitador. '"bottom-right"': la esquina inferior derecha del icono se coloca más cerca del delimitador. Valor predeterminado: 'undefined'

Detalles de las propiedades

allowOverlap

Especifica si el texto estará visible si entra en conflicto con otros símbolos. Si es true, el texto será visible incluso si entra en conflicto con otros símbolos dibujados anteriormente. El valor predeterminado es false.

allowOverlap?: boolean

Valor de propiedad

boolean

anchor

Especifica qué parte del icono se coloca más cerca de la posición del delimitador de iconos en el mapa.

'"center"': el centro del icono se coloca más cerca del delimitador.

'"left"': el lado izquierdo del icono se coloca más cerca del delimitador.

'"right"': el lado derecho del icono se coloca más cerca del delimitador.

'"top"': la parte superior del icono se coloca más cerca del delimitador.

'"bottom"': la parte inferior del icono se coloca más cerca del delimitador.

'"top-left"': la esquina superior izquierda del icono se coloca más cerca del delimitador.

'"top-right"': la esquina superior derecha del icono se coloca más cerca del delimitador.

'"bottom-left"': la esquina inferior izquierda del icono se coloca más cerca del delimitador.

'"bottom-right"': la esquina inferior derecha del icono se coloca más cerca del delimitador.

Predeterminado '"center"'.

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

Valor de propiedad

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

color

Color del texto. El valor predeterminado es "#000000".

color?: string | DataDrivenPropertyValueSpecification<string>

Valor de propiedad

string | DataDrivenPropertyValueSpecification<string>

font

Pila de fuentes que se va a usar para mostrar texto. Valores posibles: "SegoeFrutigerHelveticaMYingHei-Bold", "SegoeFrutigerHelveticaMYingHei-Medium", "SegoeFrutigerHelveticaMYingHei-Regular", , "SegoeUi-Light""SegoeUi-SemiBold""SegoeUi-Regular""StandardCondensedSegoeUi-Black""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Regular""SegoeUi-Bold""SegoeUi-SemiLight""StandardCondensedSegoeUi-Light", . "StandardFontCondensed-Regular""StandardFont-Black""StandardFont-Bold""StandardFont-Light""StandardFont-Regular""StandardFontCondensed-Black""StandardFontCondensed-Bold""StandardFontCondensed-Light" El valor predeterminado es ["StandardFont-Regular"].

font?: string[] | DataDrivenPropertyValueSpecification<string[]>

Valor de propiedad

string[] | DataDrivenPropertyValueSpecification<string[]>

haloBlur

Distancia de atenuación del halo hacia el exterior en píxeles. Debe ser un número mayor o igual a 0. El valor predeterminado es 0.

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

Valor de propiedad

number | DataDrivenPropertyValueSpecification<number>

haloColor

Color del halo del texto, que ayuda a destacar de los fondos. El valor predeterminado es "rgba(0,0,0,0)".

haloColor?: string | DataDrivenPropertyValueSpecification<string>

Valor de propiedad

string | DataDrivenPropertyValueSpecification<string>

haloWidth

Distancia del halo al contorno de fuente en píxeles. Debe ser un número mayor o igual a 0. El ancho máximo del halo de texto es de 1/4 del tamaño de fuente. El valor predeterminado es 0.

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

Valor de propiedad

number | DataDrivenPropertyValueSpecification<number>

ignorePlacement

Especifica si se permite que los demás símbolos entren en conflicto con el texto. Si es true, otros símbolos pueden ser visibles aunque entren en conflicto con el texto. El valor predeterminado es false.

ignorePlacement?: boolean

Valor de propiedad

boolean

justify

Opciones de justificación de texto.

'"auto"': el texto se alinea hacia la posición del delimitador.

'"left"': el texto se alinea a la izquierda.

'"center"': el texto está centrado.

'"right"': el texto está alineado a la derecha. Predeterminado '"center"'.

justify?: "auto" | "left" | "center" | "right"

Valor de propiedad

"auto" | "left" | "center" | "right"

offset

Especifica una distancia de desplazamiento del icono desde su delimitador en ems. Los valores positivos indican derecha y abajo, mientras que los valores negativos indican hacia la izquierda y hacia arriba. El valor predeterminado es [0, 0].

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

Valor de propiedad

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

Número entre 0 y 1 que indica la opacidad en la que se dibujará el texto. El valor predeterminado es 1.

opacity?: number | DataDrivenPropertyValueSpecification<number>

Valor de propiedad

number | DataDrivenPropertyValueSpecification<number>

optional

Especifica si el texto se puede ocultar si se superpone con otro símbolo. Si es true, los iconos se mostrarán sin su texto correspondiente cuando el texto entre en conflicto con otros símbolos y el icono no lo hace. El valor predeterminado es false.

optional?: boolean

Valor de propiedad

boolean

padding

Tamaño del área adicional alrededor del cuadro de límite de texto usado para detectar colisiones de símbolos. El valor predeterminado es 2.

padding?: number | PropertyValueSpecification<number>

Valor de propiedad

number | PropertyValueSpecification<number>

pitchAlignment

Especifica la orientación del texto cuando se inclina el mapa.

'"auto"': coincide automáticamente con el valor de 'rotationAlignment'.

'"map"': el texto se alinea con el plano del mapa.

'"viewport"': el texto está alineado con el plano de la ventanilla.

Valor predeterminado: '"auto"'

pitchAlignment?: "auto" | "map" | "viewport"

Valor de propiedad

"auto" | "map" | "viewport"

radialOffset

Desplazamiento radial del texto, en la dirección del delimitador del símbolo. Resulta útil en combinación con variableAnchor, que usa de forma predeterminada la bidimensional offset si está presente. Valor predeterminado: 0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

Valor de propiedad

number | DataDrivenPropertyValueSpecification<number>

rotation

Cantidad que se va a girar el texto en sentido de las agujas del reloj en grados. Predeterminado 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

Valor de propiedad

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

En combinación con la placement propiedad de SymbolLayerOptions, especifica el comportamiento de rotación de los glifos individuales que forman el texto.

'"auto"': cuando 'placement' está establecido en '"point"', esto equivale a '"map"'. Cuando 'placement' se establece en ''line'' esto equivale a ''map''.

'"map"': cuando 'placement' está establecido en ''point'', alinea el texto east-west. Cuando "placement" se establece en "line"", alinea los ejes x de texto con la línea.

'"viewport"': genera glifos cuyos ejes X se alinean con el eje x de la ventanilla, independientemente del valor de 'placement'.

Valor predeterminado: '"auto"'

rotationAlignment?: "auto" | "map" | "viewport"

Valor de propiedad

"auto" | "map" | "viewport"

size

Tamaño de la fuente en píxeles. Debe ser un número mayor o igual a 0. El valor predeterminado es 16.

size?: number | DataDrivenPropertyValueSpecification<number>

Valor de propiedad

number | DataDrivenPropertyValueSpecification<number>

textField

Especifica el nombre de una propiedad en las características que se van a usar para una etiqueta de texto.

textField?: string | DataDrivenPropertyValueSpecification<string>

Valor de propiedad

string | DataDrivenPropertyValueSpecification<string>

variableAnchor

Lista de posibles ubicaciones de anclaje, para aumentar la posibilidad de colocar etiquetas de alta prioridad en el mapa. El representador intentará colocar la etiqueta en cada ubicación, en orden, antes de pasar a la etiqueta siguiente. Use justify: "auto" para elegir la justificación de texto en función de la posición del delimitador. Para aplicar un desplazamiento, use las radialOffset opciones bidimensionales offset o .