Class: TextStyle

• [new TextStyle(color, baseLine, alignment, font, autoSize, multiline, shadow)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.attributes.textstyle.textstyle.md#new textstyle(color, baseline, alignment, font, autosize, multiline, shadow))

• new TextStyle(color?, baseLine?, alignment?, font?, autoSize?, multiline?, shadow?)

Create TextStyle

ColoredStyle.constructor

▸ clone(): TextStyle

All inheritors should implement copy constructor or provide custom implementation for this method

TextStyle

this

ColoredStyle.clone

▸ Protected copyConstructor(src, deepCopy?): TextStyle

copy constructor

TextStyle

this

ColoredStyle.copyConstructor

▸ dispose(): void

Dispose.

void

ColoredStyle.dispose

▸ getAlignment(): AlignmentStyle

Return text alignment

AlignmentStyle

alignment in CSS format

▸ getAutoSize(): boolean

Return text auto size

boolean

▸ getBackground(): FillStyle

Gets background style

FillStyle

background style

▸ getBaseLine(): BaseLineStyle

Return current text baseline

BaseLineStyle

baseline in CSS format

▸ getClassName(): string

string

ColoredStyle.getClassName

▸ getColor(): string

Returns color

string

color in CSS form

ColoredStyle.getColor

▸ getFillStyle(): FillStyle

Gets text fill style

FillStyle

text fill style

▸ getFont(): string

Return font

string

font in CSS format

▸ getFontFamily(): string

Return Font family

string

▸ getFontSize(): string

Return Font size

string

▸ getFontStyle(): string

Return Font style

string

▸ getFontWeight(): string

Return Font weight

string

▸ getLineHeight(): string | number

Return line height see https://developer.mozilla.org/en-US/docs/Web/CSS/line-height

string | number

lineHeight

▸ getMultiLine(): boolean

true if text is multiline

boolean

multiline

▸ getOutline(): LineStyle

Gets outline style

LineStyle

outline style

▸ getOverflowWrap(): OverflowWrapStyle

Return text overflow-wrap CSS rule

OverflowWrapStyle

▸ getProcessedFont(): Object

Return an object results of the inline font string.

Object

▸ getProperties(context?): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

ColoredStyle.getProperties

▸ getRgbaColor(): RgbaColor

Return RGBA color

RgbaColor

color

ColoredStyle.getRgbaColor

▸ getShadow(): Shadow

Gets all properties pertaining to shadow

Shadow

JSON with offsetX, offsetY, color and blur properties

ColoredStyle.getShadow

▸ getStrikethrough(): LineStyle

Gets strikethrough style

LineStyle

strikethrough style

▸ getTextOverflow(): TextOverflowStyle

Return text text-overflow CSS rule

TextOverflowStyle

▸ getTimeStamp(): number

Gets time stamp

number

timeStamp

ColoredStyle.getTimeStamp

▸ getUnderline(): LineStyle

Gets underline style

LineStyle

underline style

▸ getUnderlineOffset(): string | number

Gets underline offset distance

string | number

underline offset distance

▸ getWhiteSpace(): WhiteSpaceStyle

Return text white-space CSS rule

WhiteSpaceStyle

▸ getWordBreak(): WordBreakStyle

Return text word-break CSS rule

WordBreakStyle

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

ColoredStyle.hasEventListener

▸ invalidate(): TextStyle

notify the node that the style is invalidated

TextStyle

this

ColoredStyle.invalidate

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ColoredStyle.isDisposed

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

ColoredStyle.isSilent

▸ notify<E&gt;(type, source, args?): TextStyle

Notify listeners

TextStyle

this

ColoredStyle.notify

▸ off<E&gt;(type?, callback?): TextStyle

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

TextStyle

this

ColoredStyle.off

▸ on<E&gt;(type, callback): TextStyle

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>

TextStyle

this

ColoredStyle.on

▸ setAlignment(alignment): TextStyle

Sets text alignment

TextStyle

▸ setAutoSize(autoSize): TextStyle

Sets auto size

TextStyle

▸ setBackground(style): TextStyle

Sets background style

TextStyle

this

▸ setBaseLine(baseLine): TextStyle

Sets base line, for alignment Text use AnchorType

TextStyle

▸ setColor(color): TextStyle

Sets color

TextStyle

this

ColoredStyle.setColor

▸ setFillStyle(fill): TextStyle

Sets text fill style

TextStyle

this

▸ setFont(font): TextStyle

Sets font

TextStyle

▸ setFontFamily(fontFamily): TextStyle

Set Font family

TextStyle

▸ setFontSize(fontSize): TextStyle

Set Font size

TextStyle

▸ setFontStyle(fontStyle): TextStyle

Set Font style

TextStyle

▸ setFontWeight(fontWeight): TextStyle

Set Font weight

TextStyle

▸ setLineHeight(lineHeight): TextStyle

Sets line height see https://developer.mozilla.org/en-US/docs/Web/CSS/line-height

TextStyle

this

▸ setMultiLine(multiLine): TextStyle

Allows text to be printed along multiple lines.

TextStyle

this

▸ setOutline(style): TextStyle

Sets outline style

TextStyle

▸ setOverflowWrap(overflowWrap): TextStyle

Set text overflow-wrap CSS rule

TextStyle

▸ setProperties(properties?): TextStyle

Sets all the properties pertaining to this object

TextStyle

this

ColoredStyle.setProperties

▸ setShadow(shadow): TextStyle

Sets all properties pertaining to shadow

TextStyle

this

ColoredStyle.setShadow

▸ setSilent(bool, force?): TextStyle

Set silent mode

TextStyle

this

ColoredStyle.setSilent

▸ setStrikethrough(style): TextStyle

Sets strikethrough style

TextStyle

this

▸ setTextOverflow(textOverflow): TextStyle

Set text text-overflow CSS rule

TextStyle

▸ setUnderline(style): TextStyle

Sets underline style

TextStyle

this

▸ setUnderlineOffset(offset): TextStyle

Sets underline offset distance, see https://developer.mozilla.org/en-US/docs/Web/CSS/text-underline-offset

TextStyle

this

▸ setWhiteSpace(whiteSpace): TextStyle

Set text white-space CSS rule

TextStyle

▸ setWordBreak(wordBreak): TextStyle

Set text word-break CSS rule

TextStyle

▸ toGrayScale(clone?): TextStyle

Clone the instance in grayscale style, or convert itself if [clone] is false.

TextStyle

ColoredStyle.toGrayScale

▸ toString(): string

string

▸ updateTimeStamp(silent?): TextStyle

Update time stamp to indicate that style has been changed.

TextStyle

this

ColoredStyle.updateTimeStamp

▸ Static fromObject(object): TextStyle

Create or get text style from object

TextStyle

▸ Static getClassName(): string

string

ColoredStyle.getClassName

▸ Static isStyleNotificationEnabled(): boolean

Return status of the global notification for all styles.

boolean

ColoredStyle.isStyleNotificationEnabled

▸ Static mergeFromObject(node, textStyle, object, merge?, invalidateMethod?): TextStyle

Merge textstyle object with existing instance

Example

// after mergeFromObject() text shape will change only color property
import {Text} from '@int/geotoolkit/scene/shapes/Text';
import {TextStyle} from '@int/geotoolkit/attributes/TextStyle';
const t1 = new TextStyle({
'color': KnownColors.Black,
'alignment': 'center',
'font': '42px Arial'
});
const t2 = {
'color': 'red'
};
const textStyle = TextStyle.mergeFromObject(null, t1, t2, true);
const text = new Text({
'text': 'Alphabetical',
'ax': 185,
'ay': 50,
'textStyle': textStyle,
'alignment': AnchorType.Center
});

TextStyle

textStyle