Class TextStyleBuilder

public shape of the accessors this class declares itself

Hierarchy (View Summary)

BillboardStyleBuilder<any, TextStyleBuilderOptions>
Omit<
    Accessors,
    | "backgroundColor"
    | "borderColor"
    | "borderWidth"
    | "breakLines"
    | "fontName"
    | "fontSize"
    | "strokeColor"
    | "textField",
>
Methods
Omit<
    Accessors,
    "anchorPointX"
    | "anchorPointY"
    | "flippable"
    | "orientationMode",
>
Omit<Methods, "buildStyle">
Accessors
Methods
Omit<Accessors, "color">
Methods
- TextStyleBuilder

Index

Constructors

Methods

buildStyle dispose getAnchorPointX getAnchorPointY getAnimationStyle getAttachAnchorPointX getAttachAnchorPointY getBackgroundColor getBorderColor getBorderWidth getColor getFontName getFontSize getHorizontalOffset getNative getOrientationMode getPlacementPriority getRenderScale getScalingMode getStrokeColor getStrokeWidth getTextField getTextMargins getVerticalOffset initNativeView isBreakLines isCausesOverlap isFlippable isHideIfOverlapped isScaleWithDPI setAnchorPoint setAnchorPointX setAnchorPointY setAnimationStyle setAttachAnchorPoint setAttachAnchorPointX setAttachAnchorPointY setBackgroundColor setBorderColor setBorderWidth setBreakLines setCausesOverlap setColor setFlippable setFontName setFontSize setHideIfOverlapped setHorizontalOffset setOrientationMode setPlacementPriority setRenderScale setScaleWithDPI setScalingMode setStrokeColor setStrokeWidth setTextField setTextMargins setVerticalOffset

Constructors

constructor

new TextStyleBuilder(
options?: TextStyleBuilderOptions,
native?: any,
): TextStyleBuilder
Parameters
- Optionaloptions: TextStyleBuilderOptions
- Optionalnative: any
Returns TextStyleBuilder
Inherited from BillboardStyleBuilder.constructor
- Defined in packages/ui-massifmaps/index.d.ts:18

Properties

`Optional`anchorPointX

anchorPointX?: number

`Optional`anchorPointY

anchorPointY?: number

animationStyle

animationStyle: any

attachAnchorPointX

attachAnchorPointX: number

attachAnchorPointY

attachAnchorPointY: number

`Optional`backgroundColor

backgroundColor?: string | Color

`Optional`borderColor

borderColor?: string | Color

`Optional`borderWidth

borderWidth?: number

`Optional`breakLines

breakLines?: boolean

causesOverlap

causesOverlap: boolean

`Optional`color

color?: string | Color

duringInit

duringInit: boolean

`Optional`flippable

flippable?: boolean

`Optional`fontName

fontName?: string

`Optional`fontSize

fontSize?: number

hideIfOverlapped

hideIfOverlapped: boolean

horizontalOffset

horizontalOffset: number

native

native: any

options

options: TextStyleBuilderOptions

`Optional`orientationMode

orientationMode?: BillboardOrientation

placementPriority

placementPriority: number

renderScale

renderScale: number

scaleWithDPI

scaleWithDPI: boolean

scalingMode

scalingMode: BillboardScaling

`Optional`strokeColor

strokeColor?: string | Color

strokeWidth

strokeWidth: number

`Optional`textField

textField?: string

textMargins

textMargins: any

verticalOffset

verticalOffset: number

Methods

buildStyle

buildStyle(): any
Returns any
Inherited from BillboardStyleBuilder.buildStyle
- Defined in packages/ui-massifmaps/vectorelements/index.d.ts:86

dispose

dispose(): any
Returns any
Inherited from BillboardStyleBuilder.dispose
- Defined in packages/ui-massifmaps/index.d.ts:21

getAnchorPointX

getAnchorPointX(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:7

getAnchorPointY

getAnchorPointY(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:8

getAnimationStyle

getAnimationStyle(): any
Returns any
Inherited from BillboardStyleBuilder.getAnimationStyle
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:5

getAttachAnchorPointX

getAttachAnchorPointX(): number
Returns number
Inherited from BillboardStyleBuilder.getAttachAnchorPointX
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:6

getAttachAnchorPointY

getAttachAnchorPointY(): number
Returns number
Inherited from BillboardStyleBuilder.getAttachAnchorPointY
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:7

getBackgroundColor

getBackgroundColor(): Color
Returns Color
Inherited from Methods.getBackgroundColor
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:7

getBorderColor

getBorderColor(): Color
Returns Color
Inherited from Methods.getBorderColor
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:8

getBorderWidth

getBorderWidth(): number
Returns number
Inherited from Methods.getBorderWidth
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:9

getColor

getColor(): Color
Returns Color
Inherited from Methods.getColor
- Defined in packages/ui-massifmaps/bindings/styles/StyleBuilder.d.ts:6

getFontName

getFontName(): string
Returns string
Inherited from Methods.getFontName
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:10

getFontSize

getFontSize(): number
Returns number
Inherited from Methods.getFontSize
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:11

getHorizontalOffset

getHorizontalOffset(): number
Returns number
Inherited from BillboardStyleBuilder.getHorizontalOffset
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:8

getNative

getNative(): any
Returns any
Inherited from BillboardStyleBuilder.getNative
- Defined in packages/ui-massifmaps/index.d.ts:20

getOrientationMode

getOrientationMode(): BillboardOrientation
Returns BillboardOrientation
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:9

getPlacementPriority

getPlacementPriority(): number
Returns number
Inherited from BillboardStyleBuilder.getPlacementPriority
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:9

getRenderScale

getRenderScale(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:10

getScalingMode

getScalingMode(): BillboardScaling
Returns BillboardScaling
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:11

getStrokeColor

getStrokeColor(): Color
Returns Color
Inherited from Methods.getStrokeColor
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:12

getStrokeWidth

getStrokeWidth(): number
Returns number
Inherited from Methods.getStrokeWidth
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:13

getTextField

getTextField(): string
Returns string
Inherited from Methods.getTextField
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:14

getTextMargins

getTextMargins(): any
Returns any
Inherited from Methods.getTextMargins
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:15

getVerticalOffset

getVerticalOffset(): number
Returns number
Inherited from BillboardStyleBuilder.getVerticalOffset
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:10

initNativeView

initNativeView(native: any, options: TextStyleBuilderOptions): void
Parameters
- native: any
- options: TextStyleBuilderOptions
Returns void
Inherited from BillboardStyleBuilder.initNativeView
- Defined in packages/ui-massifmaps/index.d.ts:19

isBreakLines

isBreakLines(): boolean
Returns boolean
Inherited from Methods.isBreakLines
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:16

isCausesOverlap

isCausesOverlap(): boolean
Returns boolean
Inherited from BillboardStyleBuilder.isCausesOverlap
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:11

isFlippable

isFlippable(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:12

isHideIfOverlapped

isHideIfOverlapped(): boolean
Returns boolean
Inherited from BillboardStyleBuilder.isHideIfOverlapped
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:12

isScaleWithDPI

isScaleWithDPI(): boolean
Returns boolean
Inherited from BillboardStyleBuilder.isScaleWithDPI
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:13

setAnchorPoint

setAnchorPoint(arg0: number, arg1: number): void
Parameters
- arg0: number
- arg1: number
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:13

setAnchorPointX

setAnchorPointX(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:14

setAnchorPointY

setAnchorPointY(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:15

setAnimationStyle

setAnimationStyle(arg0: any): void
Parameters
- arg0: any
Returns void
Inherited from BillboardStyleBuilder.setAnimationStyle
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:14

setAttachAnchorPoint

setAttachAnchorPoint(arg0: number, arg1: number): void
Parameters
- arg0: number
- arg1: number
Returns void
Inherited from BillboardStyleBuilder.setAttachAnchorPoint
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:15

setAttachAnchorPointX

setAttachAnchorPointX(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from BillboardStyleBuilder.setAttachAnchorPointX
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:16

setAttachAnchorPointY

setAttachAnchorPointY(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from BillboardStyleBuilder.setAttachAnchorPointY
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:17

setBackgroundColor

setBackgroundColor(arg0: string | Color): void
Parameters
- arg0: string | Color
Returns void
Inherited from Methods.setBackgroundColor
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:17

setBorderColor

setBorderColor(arg0: string | Color): void
Parameters
- arg0: string | Color
Returns void
Inherited from Methods.setBorderColor
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:18

setBorderWidth

setBorderWidth(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setBorderWidth
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:19

setBreakLines

setBreakLines(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from Methods.setBreakLines
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:20

setCausesOverlap

setCausesOverlap(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from BillboardStyleBuilder.setCausesOverlap
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:18

setColor

setColor(arg0: string | Color): void
Parameters
- arg0: string | Color
Returns void
Inherited from Methods.setColor
- Defined in packages/ui-massifmaps/bindings/styles/StyleBuilder.d.ts:7

setFlippable

setFlippable(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:16

setFontName

setFontName(arg0: string): void
Parameters
- arg0: string
Returns void
Inherited from Methods.setFontName
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:21

setFontSize

setFontSize(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setFontSize
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:22

setHideIfOverlapped

setHideIfOverlapped(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from BillboardStyleBuilder.setHideIfOverlapped
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:19

setHorizontalOffset

setHorizontalOffset(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from BillboardStyleBuilder.setHorizontalOffset
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:20

setOrientationMode

setOrientationMode(arg0: BillboardOrientation): void
Parameters
- arg0: BillboardOrientation
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:17

setPlacementPriority

setPlacementPriority(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from BillboardStyleBuilder.setPlacementPriority
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:21

setRenderScale

setRenderScale(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:18

setScaleWithDPI

setScaleWithDPI(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from BillboardStyleBuilder.setScaleWithDPI
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:22

setScalingMode

setScalingMode(arg0: BillboardScaling): void
Parameters
- arg0: BillboardScaling
Returns void
- Defined in packages/ui-massifmaps/bindings/styles/LabelStyleBuilder.d.ts:19

setStrokeColor

setStrokeColor(arg0: string | Color): void
Parameters
- arg0: string | Color
Returns void
Inherited from Methods.setStrokeColor
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:23

setStrokeWidth

setStrokeWidth(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setStrokeWidth
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:24

setTextField

setTextField(arg0: string): void
Parameters
- arg0: string
Returns void
Inherited from Methods.setTextField
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:25

setTextMargins

setTextMargins(arg0: any): void
Parameters
- arg0: any
Returns void
Inherited from Methods.setTextMargins
- Defined in packages/ui-massifmaps/bindings/styles/TextStyleBuilder.d.ts:26

setVerticalOffset

setVerticalOffset(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from BillboardStyleBuilder.setVerticalOffset
- Defined in packages/ui-massifmaps/bindings/styles/BillboardStyleBuilder.d.ts:23

Class TextStyleBuilder

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TextStyleBuilder

Properties

OptionalanchorPointX

OptionalanchorPointY

animationStyle

attachAnchorPointX

attachAnchorPointY

OptionalbackgroundColor

OptionalborderColor

OptionalborderWidth

OptionalbreakLines

causesOverlap

Optionalcolor

duringInit

Optionalflippable

OptionalfontName

OptionalfontSize

hideIfOverlapped

horizontalOffset

native

options

OptionalorientationMode

placementPriority

renderScale

scaleWithDPI

scalingMode

OptionalstrokeColor

strokeWidth

OptionaltextField

textMargins

verticalOffset

Methods

buildStyle

Returns any

dispose

Returns any

getAnchorPointX

Returns number

getAnchorPointY

Returns number

getAnimationStyle

Returns any

getAttachAnchorPointX

Returns number

getAttachAnchorPointY

Returns number

getBackgroundColor

Returns Color

getBorderColor

Returns Color

getBorderWidth

Returns number

getColor

Returns Color

getFontName

Returns string

getFontSize

Returns number

getHorizontalOffset

Returns number

getNative

Returns any

getOrientationMode

Returns BillboardOrientation

getPlacementPriority

Returns number

getRenderScale

Returns number

getScalingMode

Returns BillboardScaling

getStrokeColor

`Optional`anchorPointX

`Optional`anchorPointY

`Optional`backgroundColor

`Optional`borderColor

`Optional`borderWidth

`Optional`breakLines

`Optional`color

`Optional`flippable

`Optional`fontName

`Optional`fontSize

`Optional`orientationMode

`Optional`strokeColor

`Optional`textField