Class ArcStyle

A style which applies an arc to LineString geometries depending on their first and last coordinates. All other coordinates will be ignored. This still will not render non-LineString geometries (same as ArrowStyle).

Hierarchy

ArrowStyle
- ArcStyle

Accessors

arcFactor

get arcFactor(): number
The factor with which to calculate the 'height' of an arc using the distance from start to end of the LineString.

Returns number
- Defined in src/style/arcStyle.ts:392
set arcFactor(value): void
Parameters
- value: number
Returns void
- Defined in src/style/arcStyle.ts:396

color

get color(): ColorType
The color of the stroke and icon styles. Setting the color will not re-apply the icons color.

Returns ColorType
Inherited from ArrowStyle.color
- Defined in src/style/arrowStyle.ts:202
set color(color): void
Parameters
- color: ColorType
Returns void
Inherited from ArrowStyle.color
- Defined in src/style/arrowStyle.ts:206

numberOfSegments

get numberOfSegments(): number
The number of segments to render the arc with.

Returns number
- Defined in src/style/arcStyle.ts:358
set numberOfSegments(value): void
Parameters
- value: number
Returns void
- Defined in src/style/arcStyle.ts:362

offset

get offset(): number
An offset from the arc end/start to the starting point / end point

Returns number
- Defined in src/style/arcStyle.ts:377
set offset(value): void
Parameters
- value: number
Returns void
- Defined in src/style/arcStyle.ts:381

width

get width(): undefined | number
Same as getStroke().getWidth() / getStroke().setWidth()

Returns undefined | number
Inherited from ArrowStyle.width
- Defined in src/style/arrowStyle.ts:191
set width(width): void
Parameters
- width: undefined | number
Returns void
Inherited from ArrowStyle.width
- Defined in src/style/arrowStyle.ts:195

Constructors

constructor

new ArcStyle(options?): ArcStyle
Parameters
- Optional options: ArcStyleOptions = {}
Returns ArcStyle
Overrides ArrowStyle.constructor
- Defined in src/style/arcStyle.ts:344

Methods

`Protected` _getCloneOptions

_getCloneOptions(): ArcStyleOptions
Returns ArcStyleOptions
Overrides ArrowStyle._getCloneOptions
- Defined in src/style/arcStyle.ts:422

`Private` _getFeatureArcGeometry

_getFeatureArcGeometry(feature): undefined | Geometry
Parameters
- feature: Feature<Geometry> & {
  [featureArcStyleId]?: string;
  }
Returns undefined | Geometry
- Defined in src/style/arcStyle.ts:404

clone

clone(): ArcStyle
Returns ArcStyle
Overrides ArrowStyle.clone
- Defined in src/style/arcStyle.ts:429

getFill

getFill(): Fill
Get the fill style.

Returns Fill
Fill style.

Api
Inherited from ArrowStyle.getFill
- Defined in node_modules/ol/style/Style.d.ts:324

getGeometry

getGeometry(): string | Geometry | GeometryFunction
Get the geometry to be rendered.

Returns string | Geometry | GeometryFunction
Feature property or geometry or function that returns the geometry that will be rendered with this style.

Api
Inherited from ArrowStyle.getGeometry
- Defined in node_modules/ol/style/Style.d.ts:311

getGeometryFunction

getGeometryFunction(): GeometryFunction
Get the function used to generate a geometry for rendering.

Returns GeometryFunction
Function that is called with a feature and returns the geometry to render instead of the feature's geometry.

Api
Inherited from ArrowStyle.getGeometryFunction
- Defined in node_modules/ol/style/Style.d.ts:318

getHitDetectionRenderer

getHitDetectionRenderer(): null | RenderFunction
Get the custom renderer function that was configured with #setHitDetectionRenderer or the hitDetectionRenderer constructor option.

Returns null | RenderFunction
Custom renderer function.

Api
Inherited from ArrowStyle.getHitDetectionRenderer
- Defined in node_modules/ol/style/Style.d.ts:303

getImage

getImage(): ImageStyle
Get the image style.

Returns ImageStyle
Image style.

Api
Inherited from ArrowStyle.getImage
- Defined in node_modules/ol/style/Style.d.ts:336

getOlcsStyle

getOlcsStyle(): Style
Returns the style used to render primitives (a style with a circle image and the color of this style).

Returns Style
Inherited from ArrowStyle.getOlcsStyle
- Defined in src/style/arrowStyle.ts:280

getRenderer

getRenderer(): null | RenderFunction
Get the custom renderer function that was configured with #setRenderer or the renderer constructor option.

Returns null | RenderFunction
Custom renderer function.

Api
Inherited from ArrowStyle.getRenderer
- Defined in node_modules/ol/style/Style.d.ts:282

getStroke

getStroke(): Stroke
Get the stroke style.

Returns Stroke
Stroke style.

Api
Inherited from ArrowStyle.getStroke
- Defined in node_modules/ol/style/Style.d.ts:348

getText

getText(): Text
Get the text style.

Returns Text
Text style.

Api
Inherited from ArrowStyle.getText
- Defined in node_modules/ol/style/Style.d.ts:360

getZIndex

getZIndex(): undefined | number
Get the z-index for the style.

Returns undefined | number
ZIndex.

Api
Inherited from ArrowStyle.getZIndex
- Defined in node_modules/ol/style/Style.d.ts:372

setFill

setFill(fill): void
Set the fill style.
Parameters
- fill: Fill
  
  Fill style.
Returns void

Api
Inherited from ArrowStyle.setFill
- Defined in node_modules/ol/style/Style.d.ts:330

setGeometry

setGeometry(geometry): void
Set a geometry that is rendered instead of the feature's geometry.
Parameters
- geometry: string | Geometry | GeometryFunction
  
  Feature property or geometry or function returning a geometry to render for this style.
Returns void

Api
Inherited from ArrowStyle.setGeometry
- Defined in node_modules/ol/style/Style.d.ts:381

setHitDetectionRenderer

setHitDetectionRenderer(renderer): void
Sets a custom renderer function for this style used in hit detection.
Parameters
- renderer: null | RenderFunction
  
  Custom renderer function.
Returns void

Api
Inherited from ArrowStyle.setHitDetectionRenderer
- Defined in node_modules/ol/style/Style.d.ts:296

setImage

setImage(image): void
Set the image style.
Parameters
- image: ImageStyle
  
  Image style.
Returns void

Api
Inherited from ArrowStyle.setImage
- Defined in node_modules/ol/style/Style.d.ts:342

setRenderer

setRenderer(renderer): void
Sets a custom renderer function for this style. When set, fill, stroke and image options of the style will be ignored.
Parameters
- renderer: null | RenderFunction
  
  Custom renderer function.
Returns void

Api
Inherited from ArrowStyle.setRenderer
- Defined in node_modules/ol/style/Style.d.ts:289

setStroke

setStroke(stroke): void
Set the stroke style.
Parameters
- stroke: Stroke
  
  Stroke style.
Returns void

Api
Inherited from ArrowStyle.setStroke
- Defined in node_modules/ol/style/Style.d.ts:354

setText

setText(text): void
Set the text style.
Parameters
- text: Text
  
  Text style.
Returns void

Api
Inherited from ArrowStyle.setText
- Defined in node_modules/ol/style/Style.d.ts:366

setZIndex

setZIndex(zIndex): void
Set the z-index.
Parameters
- zIndex: undefined | number
  
  ZIndex.
Returns void

Api
Inherited from ArrowStyle.setZIndex
- Defined in node_modules/ol/style/Style.d.ts:388

Properties

`Private` _arcFactor

_arcFactor: number

`Private` _numberOfSegments

_numberOfSegments: number

The number of line segments to interpolate by

`Private` _offset

_offset: number

`Private` _revisionId

_revisionId: string = ...

This styles revision ID. This will enforce an update of a features arc struct, if the feature get applied a new ArcStyle

end

end: ArrowEnd

primitiveOptions

primitiveOptions: VectorPropertiesPrimitiveOptions

Class ArcStyle

Hierarchy

Index

Accessors

Constructors

Methods

Properties

Accessors

arcFactor

Returns number

Parameters

value: number

Returns void

color

Returns ColorType

Parameters

color: ColorType

Returns void

numberOfSegments

Returns number

Parameters

value: number

Returns void

offset

Returns number

Parameters

value: number

Returns void

width

Returns undefined | number

Parameters

width: undefined | number

Returns void

Constructors

constructor

Parameters

Optional options: ArcStyleOptions = {}

Returns ArcStyle

Methods

Protected _getCloneOptions

Returns ArcStyleOptions

Private _getFeatureArcGeometry

Parameters

feature: Feature<Geometry> & { [featureArcStyleId]?: string; }

Returns undefined | Geometry

clone

Returns ArcStyle

getFill

Returns Fill

Api

getGeometry

Returns string | Geometry | GeometryFunction

Api

getGeometryFunction

Returns GeometryFunction

Api

getHitDetectionRenderer

Returns null | RenderFunction

Api

getImage

Returns ImageStyle

Api

getOlcsStyle

Returns Style

getRenderer

Returns null | RenderFunction

Api

getStroke

Returns Stroke

Api

getText

Returns Text

Api

getZIndex

Returns undefined | number

Api

setFill

Parameters

fill: Fill

Returns void

`Optional` options: ArcStyleOptions = {}

`Protected` _getCloneOptions

`Private` _getFeatureArcGeometry

feature: Feature<Geometry> & {
[featureArcStyleId]?: string;
}

`Private` _arcFactor

`Private` _numberOfSegments

`Private` _offset

`Private` _revisionId