Class: StyleUtils

StyleUtils

new StyleUtils()

Utils/classes/styleutils/index.ts, line 5

This class is used to manage the styles of the GO API.

Methods

staticStyleUtils.createCircle(stroke, fill, radius){void}

Utils/classes/styleutils/index.ts, line 219

Private function, which creates a circle style for a point geometry, with all the possibilities of changing the style both inside and outside

Name Type Description
stroke module:types~Stroke

The stroke object from the user.

fill module:types~Fill

The fill object from the user.

radius number

The radius of the circle.

Returns:
Type Description
void Return nothing

staticStyleUtils.createImageSymbolizer(style){module:types~con}

Utils/classes/styleutils/index.ts, line 257

This function allow to create a new image Symbolizer, with all the possibilities of changing the style.

Name Type Description
style module:types~styleFromUser

The style object from the user.

Returns:
Type Description
module:types~con Return a new image object.

staticStyleUtils.createNewShape(stroke, fill, points, radius, rotationRadians, radius2, angle){module:types~RegularShape}

Utils/classes/styleutils/index.ts, line 239

Private function, which creates a regular style for a point geometry, with all the possibilities of changing the style, both inside and outside, and with its predefined geometric types according to the type [[typePoint]]

Name Type Description
stroke module:types~Stroke

The stroke object

fill module:types~Fill

The fill object

points number

The number of points of the regular shape

radius number

The radius of the regular shape

rotationRadians number

The rotation of the regular shape

radius2 number

The radius2 of the regular shape

angle number

The angle of the regular shape

Returns:
Type Description
module:types~RegularShape Return a new regular shape object.

staticStyleUtils.createPointSymbolizer(style){style_1.Image}

Utils/classes/styleutils/index.ts, line 177

Function for the creation of point models of geometry with regular figures. It internally calls two functionalities [[CreateNewShape]] and [[createCircle]]

Name Type Description
style module:types~styleFromUser

The style object from the user.

Returns:
Type Description
style_1.Image Return a new image object.

staticStyleUtils.editStroke(userStyle, textStroke, stroke){style_1.Stroke}

Utils/classes/styleutils/index.ts, line 300

This function allow to edit a stroke object, with all the possibilities of changing the style.

Name Type Description
userStyle module:types~styleFromUser

The style object from the user.

textStroke boolean

The boolean value to know if the stroke is for a text or not.

stroke style_1.Stroke

The stroke object to edit.

Returns:
Type Description
style_1.Stroke Return a new stroke object.

staticStyleUtils.editStyle(userStyle){module:types~Style}

Utils/classes/styleutils/index.ts, line 94

This function allow to edit the styles of the GO API.

Name Type Description
userStyle styleFromUser

The style object from the user.

Returns:
Type Description
module:types~Style Return a new style object.

staticStyleUtils.newStroke(userStyle, textStroke){style_1.Stroke}

Utils/classes/styleutils/index.ts, line 281

This function allow to create a new stroke object, with all the possibilities of changing the style.

Name Type Description
userStyle module:types~styleFromUser

The style object from the user.

textStroke boolean

The boolean value to know if the stroke is for a text or not.

Returns:
Type Description
style_1.Stroke Return a new stroke object.

staticStyleUtils.newStyle(style){module:types~Style}

Utils/classes/styleutils/index.ts, line 21

This function allow to create a new style object with the properties of the user.

Name Type Description
style module:types~styleFromUser

The style object from the user.

Returns:
Type Description
module:types~Style Return a new style object.