Class ArrowStyle

A style which renders arrow heads at the ends of a line string. This style cannot be applied to non-LineString geometries. When setting this on a layer with heterogeneous geometry types, use a style function.

Hierarchy

Style
- ArrowStyle
  - ArcStyle

Index

Accessors

Constructors

Properties

end primitiveOptions

Accessors

color

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

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

width

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

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

Constructors

constructor

new ArrowStyle(options?): ArrowStyle
Parameters
- options: ArrowStyleOptions = {}
Returns ArrowStyle
Overrides Style.constructor
- Defined in src/style/arrowStyle.ts:161

Methods

`Private` _drawArrow

_drawArrow(ctx, imagePosition, rotation, pixelRatio): void
Parameters
- ctx: CanvasRenderingContext2D
- imagePosition: Coordinate
- rotation: number
- pixelRatio: number
Returns void
- Defined in src/style/arrowStyle.ts:210

`Protected` _getCloneOptions

_getCloneOptions(): ArrowStyleOptions
Returns ArrowStyleOptions
- Defined in src/style/arrowStyle.ts:289

`Private` _render

_render(geom, e): void
Parameters
- geom: Coordinate[]
- e: State
Returns void
- Defined in src/style/arrowStyle.ts:234

clone

clone(): ArrowStyle
Returns ArrowStyle
Overrides Style.clone
- Defined in src/style/arrowStyle.ts:298

getFill

getFill(): Fill
Get the fill style.

Returns Fill
Fill style.

Api
Inherited from Style.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 Style.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 Style.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 Style.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 Style.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
- 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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.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 Style.setZIndex
- Defined in node_modules/ol/style/Style.d.ts:388

Properties

end

primitiveOptions

primitiveOptions: VectorPropertiesPrimitiveOptions

Generated using TypeDoc