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 (View Summary)

ArrowStyle
- ArcStyle

Index

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:393
set arcFactor(value: number): void
Parameters
- value: number
Returns void
- Defined in src/style/arcStyle.ts:397

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: ColorType): 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:359
set numberOfSegments(value: number): void
Parameters
- value: number
Returns void
- Defined in src/style/arcStyle.ts:363

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:378
set offset(value: number): void
Parameters
- value: number
Returns void
- Defined in src/style/arcStyle.ts:382

width

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

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

Constructors

constructor

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

Methods

`Protected`_getCloneOptions

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

clone

clone(): ArcStyle
Clones the style.

Returns ArcStyle
The cloned style.

Api
Overrides ArrowStyle.clone
- Defined in src/style/arcStyle.ts:430

getFill

getFill(): Fill | null
Get the fill style.

Returns Fill | null
Fill style.

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

getGeometry

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

Returns string | Geometry | GeometryFunction | null
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:328

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:335

getHitDetectionRenderer

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

Returns RenderFunction | null
Custom renderer function.

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

getImage

getImage(): ImageStyle | null
Get the image style.

Returns ImageStyle | null
Image style.

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

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(): RenderFunction | null
Get the custom renderer function that was configured with #setRenderer or the renderer constructor option.

Returns RenderFunction | null
Custom renderer function.

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

getStroke

getStroke(): Stroke | null
Get the stroke style.

Returns Stroke | null
Stroke style.

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

getText

getText(): Text | null
Get the text style.

Returns Text | null
Text style.

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

getZIndex

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

Returns number | undefined
ZIndex.

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

setFill

setFill(fill: Fill | null): void
Set the fill style.
Parameters
- fill: Fill | null
  Fill style.
Returns void
Api
Inherited from ArrowStyle.setFill
- Defined in node_modules/ol/style/Style.d.ts:347

setGeometry

setGeometry(geometry: string | Geometry | GeometryFunction | null): void
Set a geometry that is rendered instead of the feature's geometry.
Parameters
- geometry: string | Geometry | GeometryFunction | null
  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:398

setHitDetectionRenderer

setHitDetectionRenderer(renderer: RenderFunction | null): void
Sets a custom renderer function for this style used in hit detection.
Parameters
- renderer: RenderFunction | null
  Custom renderer function.
Returns void
Api
Inherited from ArrowStyle.setHitDetectionRenderer
- Defined in node_modules/ol/style/Style.d.ts:313

setImage

setImage(image: ImageStyle): 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:359

setRenderer

setRenderer(renderer: RenderFunction | null): void
Sets a custom renderer function for this style. When set, fill, stroke and image options of the style will be ignored.
Parameters
- renderer: RenderFunction | null
  Custom renderer function.
Returns void
Api
Inherited from ArrowStyle.setRenderer
- Defined in node_modules/ol/style/Style.d.ts:306

setStroke

setStroke(stroke: Stroke | null): void
Set the stroke style.
Parameters
- stroke: Stroke | null
  Stroke style.
Returns void
Api
Inherited from ArrowStyle.setStroke
- Defined in node_modules/ol/style/Style.d.ts:371

setText

setText(text: 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:383

setZIndex

setZIndex(zIndex: number | undefined): void
Set the z-index.
Parameters
- zIndex: number | undefined
  ZIndex.
Returns void
Api
Inherited from ArrowStyle.setZIndex
- Defined in node_modules/ol/style/Style.d.ts:405

Properties

end

primitiveOptions

primitiveOptions: VectorPropertiesPrimitiveOptions