Class: SimpleLabel

cercaliagl.SimpleLabel


Javascript ES5

const simpleLabel = new cercaliagl.SimpleLabel({ ... });

Create a marker text. This text is rendered on <canvas/> via webgl. It is not possible to edit via CSS classes.

Example usage:

const simpleLabel = new cercaliagl.SimpleLabe({
  text: '
});

new SimpleLabel(options)

SimpleLabel.js, line 40
Name Type Description
options

Options

Name Type Description
fontSize number

Text size, in pixels. Default 13.
offset Array.<number>

Simpel Label offset, units in ems. Defaults to [0, 0].
anchor string

Anchor. Possible values: center, left, right, top, bottom, top-left, top-right, bottom-left, bottom-right. Defaults top
justify string

Justify: Possible values: auto, left, center, right. Defaults center
text string

Simple Label text (with no background).
visible boolean

Visible. Show or hide text.
textColor string

Text color. Default #000000.
textOpacity number

Text opacity. Default 1.
strokeColor string

Stroke color. Default #ffffff.
strokeWidth number

Stroke width. Default 2.
textRotation number

Text rotation. Default 0.

Methods

getAnchor(){string}

SimpleLabel.js, line 220

Get simple label anchor

Returns:
Anchor

getFontSize(){number}

SimpleLabel.js, line 152

Returns text font

Returns:
Font size in pixels.

getJustify(){string}

SimpleLabel.js, line 265

Get simple label justify

Returns:
Justify

getOffset(){Array.<number>}

SimpleLabel.js, line 171

Returns offset.

Returns:
Offset [x,y].

getStrokeColor(){string}

SimpleLabel.js, line 238

Get simple label stroke color

Returns:
strokeColor

getStrokeWidth(){number}

SimpleLabel.js, line 247

Get simple label stroke width

Returns:
strokeWidth

getText(ignoreVisibility){string}

SimpleLabel.js, line 192

Get simple label text

Name Type Description
ignoreVisibility boolean (defaults to false)

Ignore visibility
Returns:
Text.

getTextColor(){string}

SimpleLabel.js, line 229

Get simple label color

Returns:
Color

getTextOpacity(){number}

SimpleLabel.js, line 211

Get simple label text opacity

Returns:
Text opacity

getTextRotation(){number}

SimpleLabel.js, line 256

Get simple label text rotation

Returns:
Text rotation

isVisible(){boolean}

SimpleLabel.js, line 282

Return if simple label is visible

setFontSize(fontSize)

SimpleLabel.js, line 142

Change the text size in pixels. If have an assigned marker updates it

Name Type Description
fontSize number

Font size in pixels.

setOffset(offset)

SimpleLabel.js, line 161

Change displacement on the horizontal axis. If have an assigned marker updates it

Name Type Description
offset Array.<number>

Offset [x,y].

setText(text)

SimpleLabel.js, line 180

Change the text passed by parameter. If have an assigned marker updates it

Name Type Description
text string

Text to put to simple label.

setTextOpacity(textOpacity)

SimpleLabel.js, line 201

Change simple label opacity. If have an assigned marker updates it

Name Type Description
textOpacity number

Text opacity

setVisible(visible)

SimpleLabel.js, line 291

Show or hide simple label text

Name Type Description
visible boolean

Visible