TextOptions interface

Referentie

Pakket:: azure-maps-control

Opties die worden gebruikt om de tekst in een Symboollaag aan te passen

Extends: Options

Eigenschappen

allowOverlap	Hiermee geeft u op of de tekst zichtbaar is als deze botst met andere symbolen. Indien waar, is de tekst zichtbaar, zelfs als deze botst met andere eerder getekende symbolen. Standaard `false`.
anchor	Hiermee geeft u op welk deel van het pictogram het dichtst bij de ankerpositie van pictogrammen op de kaart wordt geplaatst. 'midden': het midden van het pictogram wordt het dichtst bij het anker geplaatst. '"links":de linkerkant van het pictogram wordt het dichtst bij het anker geplaatst. ''right': De rechterkant van het pictogram wordt het dichtst bij het anker geplaatst. ''top': de bovenkant van het pictogram wordt het dichtst bij het anker geplaatst. ''bottom': de onderkant van het pictogram wordt het dichtst bij het anker geplaatst. '"linksboven": De linkerbovenhoek van het pictogram wordt het dichtst bij het anker geplaatst. '"rechtsboven": de rechterbovenhoek van het pictogram wordt het dichtst bij het anker geplaatst. '"linksonder": de linkerbenedenhoek van het pictogram wordt het dichtst bij het anker geplaatst. '"rechtsonder": de rechterbenedenhoek van het pictogram wordt het dichtst bij het anker geplaatst. Standaard 'midden'.
color	De kleur van de tekst. Standaard `"#000000"`.
font	De lettertypestack die moet worden gebruikt voor het weergeven van tekst. Mogelijke waarden: `"SegoeFrutigerHelveticaMYingHei-Bold"`, `"SegoeFrutigerHelveticaMYingHei-Medium"`, `"SegoeFrutigerHelveticaMYingHei-Regular"`, `"SegoeUi-Bold"`, `"SegoeUi-Light"`, `"StandardFont-Light""StandardFontCondensed-Light""StandardCondensedSegoeUi-Regular""StandardFont-Black""StandardFont-Bold""StandardCondensedSegoeUi-Light""StandardFontCondensed-Bold""StandardCondensedSegoeUi-Bold""StandardFontCondensed-Black""StandardCondensedSegoeUi-Black""StandardFont-Regular""StandardFontCondensed-Regular""SegoeUi-Regular""SegoeUi-SemiBold""SegoeUi-SemiLight""SegoeUi-SymbolRegular"` Standaard `["StandardFont-Regular"]`.
haloBlur	De fade-outafstand van de halo naar buiten in pixels. Moet een getal groter of gelijk aan 0 zijn. Standaard `0`.
haloColor	De kleur van de halo van de tekst, waardoor deze zich onderscheidt van achtergronden. Standaard `"rgba(0,0,0,0)"`.
haloWidth	De afstand van de halo tot het lettertypekader in pixels. Moet een getal groter of gelijk aan 0 zijn. De maximale breedte van de tekst halo is 1/4 van de tekengrootte. Standaard `0`.
ignorePlacement	Hiermee geeft u op of de andere symbolen mogen botsen met de tekst. Indien waar, kunnen andere symbolen zichtbaar zijn, zelfs als ze botsen met de tekst. Standaard `false`.
justify	Opties voor tekstopvulling. ''auto': de tekst wordt uitgelijnd op de ankerpositie. ''links': de tekst wordt links uitgelijnd. 'midden': de tekst is gecentreerd. 'rechts': de tekst wordt rechts uitgelijnd. Standaard 'midden'.
offset	Hiermee geeft u een offsetafstand van het pictogram van het anker in ems. Positieve waarden geven rechts en omlaag aan, terwijl negatieve waarden links en omhoog aangeven. Standaard `[0, 0]`.
opacity	Een getal tussen 0 en 1 dat de dekking aangeeft waarop de tekst wordt getekend. Standaard `1`.
optional	Hiermee geeft u op of de tekst kan worden verborgen als deze door een ander symbool wordt overlapt. Indien waar, worden pictogrammen weergegeven zonder de bijbehorende tekst wanneer de tekst botst met andere symbolen en het pictogram niet. Standaard `false`.
padding	Grootte van het extra gebied rond het tekstgrensvak dat wordt gebruikt voor het detecteren van symboolconflicten. Standaard `2`.
pitchAlignment	Hiermee geeft u de afdrukstand van de tekst op wanneer de kaart wordt gegooid. 'auto': komt automatisch overeen met de waarde 'rotationAlignment'. ''kaart': de tekst wordt uitgelijnd op het vlak van de kaart. '"viewport": de tekst wordt uitgelijnd op het vlak van de viewport. Standaard: ''auto''
radialOffset	Radiale verschuiving van tekst, in de richting van het anker van het symbool. Handig in combinatie met `variableAnchor`, die standaard de tweedimensionale `offset` als aanwezig is. Standaard: `0`
rotation	De hoeveelheid om de tekst rechtsom te draaien in graden. Standaard `0`
rotationAlignment	In combinatie met de `placement` eigenschap van de `SymbolLayerOptions`, geeft het rotatiegedrag van de afzonderlijke glyphs vormen de tekst. ''auto'': wanneer de plaatsing is ingesteld op 'punt', is dit gelijk aan ''kaart'. Wanneer de plaatsing is ingesteld op ''lijn', is dit gelijk aan ''kaart'. ''kaart': wanneer de plaatsing is ingesteld op 'punt', wordt tekst oost-west uitgelijnd. Wanneer de plaatsing is ingesteld op ''lijn', lijnt u tekst x-assen uit met de lijn. '"viewport": produceert glyphs waarvan de x-assen zijn uitgelijnd met de x-as van de viewport, ongeacht de waarde van 'plaatsing'. Standaard: ''auto''
size	De grootte van het lettertype in pixels. Moet een getal groter of gelijk aan 0 zijn. Standaard `16`.
textField	Hiermee geeft u de naam van een eigenschap op voor de functies die moeten worden gebruikt voor een tekstlabel.
variableAnchor	Lijst met mogelijke ankerlocaties om de kans op labels met hoge prioriteit op de kaart te vergroten. De renderer probeert het label op elke locatie te plaatsen, in volgorde voordat u naar het volgende label gaat. Gebruik `justify: "auto"` deze optie om tekstopvulling te kiezen op basis van ankerpositie. Als u een offset wilt toepassen, gebruikt u de `radialOffset` of tweedimensionale `offset` opties. 'midden': het midden van het pictogram wordt het dichtst bij het anker geplaatst. '"links":de linkerkant van het pictogram wordt het dichtst bij het anker geplaatst. ''right': De rechterkant van het pictogram wordt het dichtst bij het anker geplaatst. ''top': de bovenkant van het pictogram wordt het dichtst bij het anker geplaatst. ''bottom': de onderkant van het pictogram wordt het dichtst bij het anker geplaatst. '"linksboven": De linkerbovenhoek van het pictogram wordt het dichtst bij het anker geplaatst. '"rechtsboven": de rechterbovenhoek van het pictogram wordt het dichtst bij het anker geplaatst. '"linksonder": de linkerbenedenhoek van het pictogram wordt het dichtst bij het anker geplaatst. '"rechtsonder": de rechterbenedenhoek van het pictogram wordt het dichtst bij het anker geplaatst. Standaard: 'niet gedefinieerd'

Eigenschapdetails

allowOverlap

Hiermee geeft u op of de tekst zichtbaar is als deze botst met andere symbolen. Indien waar, is de tekst zichtbaar, zelfs als deze botst met andere eerder getekende symbolen. Standaard false.

allowOverlap?: boolean

Waarde van eigenschap

boolean

anchor

Hiermee geeft u op welk deel van het pictogram het dichtst bij de ankerpositie van pictogrammen op de kaart wordt geplaatst.

'midden': het midden van het pictogram wordt het dichtst bij het anker geplaatst.

'"links":de linkerkant van het pictogram wordt het dichtst bij het anker geplaatst.

''right': De rechterkant van het pictogram wordt het dichtst bij het anker geplaatst.

''top': de bovenkant van het pictogram wordt het dichtst bij het anker geplaatst.

''bottom': de onderkant van het pictogram wordt het dichtst bij het anker geplaatst.

'"linksboven": De linkerbovenhoek van het pictogram wordt het dichtst bij het anker geplaatst.

'"rechtsboven": de rechterbovenhoek van het pictogram wordt het dichtst bij het anker geplaatst.

'"linksonder": de linkerbenedenhoek van het pictogram wordt het dichtst bij het anker geplaatst.

'"rechtsonder": de rechterbenedenhoek van het pictogram wordt het dichtst bij het anker geplaatst.

Standaard 'midden'.

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

Waarde van eigenschap

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

color

De kleur van de tekst. Standaard "#000000".

color?: string | DataDrivenPropertyValueSpecification<string>

Waarde van eigenschap

string | DataDrivenPropertyValueSpecification<string>

font

De lettertypestack die moet worden gebruikt voor het weergeven van tekst. Mogelijke waarden: "SegoeFrutigerHelveticaMYingHei-Bold", "SegoeFrutigerHelveticaMYingHei-Medium", "SegoeFrutigerHelveticaMYingHei-Regular", "SegoeUi-Bold", "SegoeUi-Light", "StandardFont-Light""StandardFontCondensed-Light""StandardCondensedSegoeUi-Regular""StandardFont-Black""StandardFont-Bold""StandardCondensedSegoeUi-Light""StandardFontCondensed-Bold""StandardCondensedSegoeUi-Bold""StandardFontCondensed-Black""StandardCondensedSegoeUi-Black""StandardFont-Regular""StandardFontCondensed-Regular""SegoeUi-Regular""SegoeUi-SemiBold""SegoeUi-SemiLight""SegoeUi-SymbolRegular" Standaard ["StandardFont-Regular"].

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

Waarde van eigenschap

string[] | DataDrivenPropertyValueSpecification<string[]>

haloBlur

De fade-outafstand van de halo naar buiten in pixels. Moet een getal groter of gelijk aan 0 zijn. Standaard 0.

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

Waarde van eigenschap

number | DataDrivenPropertyValueSpecification<number>

haloColor

De kleur van de halo van de tekst, waardoor deze zich onderscheidt van achtergronden. Standaard "rgba(0,0,0,0)".

haloColor?: string | DataDrivenPropertyValueSpecification<string>

Waarde van eigenschap

string | DataDrivenPropertyValueSpecification<string>

haloWidth

De afstand van de halo tot het lettertypekader in pixels. Moet een getal groter of gelijk aan 0 zijn. De maximale breedte van de tekst halo is 1/4 van de tekengrootte. Standaard 0.

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

Waarde van eigenschap

number | DataDrivenPropertyValueSpecification<number>

ignorePlacement

Hiermee geeft u op of de andere symbolen mogen botsen met de tekst. Indien waar, kunnen andere symbolen zichtbaar zijn, zelfs als ze botsen met de tekst. Standaard false.

ignorePlacement?: boolean

Waarde van eigenschap

boolean

justify

Opties voor tekstopvulling.

''auto': de tekst wordt uitgelijnd op de ankerpositie.

''links': de tekst wordt links uitgelijnd.

'midden': de tekst is gecentreerd.

'rechts': de tekst wordt rechts uitgelijnd. Standaard 'midden'.

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

Waarde van eigenschap

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

offset

Hiermee geeft u een offsetafstand van het pictogram van het anker in ems. Positieve waarden geven rechts en omlaag aan, terwijl negatieve waarden links en omhoog aangeven. Standaard [0, 0].

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

Waarde van eigenschap

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

Een getal tussen 0 en 1 dat de dekking aangeeft waarop de tekst wordt getekend. Standaard 1.

opacity?: number | DataDrivenPropertyValueSpecification<number>

Waarde van eigenschap

number | DataDrivenPropertyValueSpecification<number>

optional

Hiermee geeft u op of de tekst kan worden verborgen als deze door een ander symbool wordt overlapt. Indien waar, worden pictogrammen weergegeven zonder de bijbehorende tekst wanneer de tekst botst met andere symbolen en het pictogram niet. Standaard false.

optional?: boolean

Waarde van eigenschap

boolean

padding

Grootte van het extra gebied rond het tekstgrensvak dat wordt gebruikt voor het detecteren van symboolconflicten. Standaard 2.

padding?: number | PropertyValueSpecification<number>

Waarde van eigenschap

number | PropertyValueSpecification<number>

pitchAlignment

Hiermee geeft u de afdrukstand van de tekst op wanneer de kaart wordt gegooid.

'auto': komt automatisch overeen met de waarde 'rotationAlignment'.

''kaart': de tekst wordt uitgelijnd op het vlak van de kaart.

'"viewport": de tekst wordt uitgelijnd op het vlak van de viewport.

Standaard: ''auto''

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

Waarde van eigenschap

"auto" | "map" | "viewport"

radialOffset

Radiale verschuiving van tekst, in de richting van het anker van het symbool. Handig in combinatie met variableAnchor, die standaard de tweedimensionale offset als aanwezig is. Standaard: 0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

Waarde van eigenschap

number | DataDrivenPropertyValueSpecification<number>

rotation

De hoeveelheid om de tekst rechtsom te draaien in graden. Standaard 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

Waarde van eigenschap

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

In combinatie met de placement eigenschap van de SymbolLayerOptions, geeft het rotatiegedrag van de afzonderlijke glyphs vormen de tekst.

''auto'': wanneer de plaatsing is ingesteld op 'punt', is dit gelijk aan ''kaart'. Wanneer de plaatsing is ingesteld op ''lijn', is dit gelijk aan ''kaart'.

''kaart': wanneer de plaatsing is ingesteld op 'punt', wordt tekst oost-west uitgelijnd. Wanneer de plaatsing is ingesteld op ''lijn', lijnt u tekst x-assen uit met de lijn.

'"viewport": produceert glyphs waarvan de x-assen zijn uitgelijnd met de x-as van de viewport, ongeacht de waarde van 'plaatsing'.

Standaard: ''auto''

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

Waarde van eigenschap

"auto" | "map" | "viewport"

size

De grootte van het lettertype in pixels. Moet een getal groter of gelijk aan 0 zijn. Standaard 16.

size?: number | DataDrivenPropertyValueSpecification<number>

Waarde van eigenschap

number | DataDrivenPropertyValueSpecification<number>

textField

Hiermee geeft u de naam van een eigenschap op voor de functies die moeten worden gebruikt voor een tekstlabel.

textField?: string | DataDrivenPropertyValueSpecification<string>

Waarde van eigenschap

string | DataDrivenPropertyValueSpecification<string>

variableAnchor

Lijst met mogelijke ankerlocaties om de kans op labels met hoge prioriteit op de kaart te vergroten. De renderer probeert het label op elke locatie te plaatsen, in volgorde voordat u naar het volgende label gaat. Gebruik justify: "auto" deze optie om tekstopvulling te kiezen op basis van ankerpositie. Als u een offset wilt toepassen, gebruikt u de radialOffset of tweedimensionale offset opties.