Class RegularShape

Classdesc

Set regular shape style for vector features. The resulting shape will be a regular polygon when radius is provided, or a star when radius1 and radius2 are provided.

Param: options

Options.

Api

Hierarchy

Constructors

constructor

Methods

getAnchor getAngle getFill getImage getOpacity getOrigin getPoints getRadius getRadius2 getRotateWithView getRotation getScale getSize getSnapToPixel getStroke setOpacity setRotation setScale

Constructors

constructor

  • new RegularShape(options): RegularShape

  • Parameters

    Returns RegularShape

    Classdesc

    Set regular shape style for vector features. The resulting shape will be a regular polygon when radius is provided, or a star when radius1 and radius2 are provided.

    Api

Methods

getAnchor

  • getAnchor(): number[]

  • Returns number[]

    Inherit Doc

    Api

getAngle

  • getAngle(): number

  • Get the angle used in generating the shape.

    Returns number

    Shape's rotation in radians.

    Api

getFill

  • getFill(): Fill

  • Get the fill style for the shape.

    Returns Fill

    Fill style.

    Api

getImage

  • getImage(pixelRatio): HTMLCanvasElement | ol.style.Image | HTMLVideoElement

  • Parameters

    • pixelRatio: number

    Returns HTMLCanvasElement | ol.style.Image | HTMLVideoElement

    Inherit Doc

    Api

getOpacity

  • getOpacity(): number

  • Get the symbolizer opacity.

    Returns number

    Opacity.

    Api

getOrigin

  • getOrigin(): number[]

  • Returns number[]

    Inherit Doc

    Api

getPoints

  • getPoints(): number

  • Get the number of points for generating the shape.

    Returns number

    Number of points for stars and regular polygons.

    Api

getRadius

  • getRadius(): number

  • Get the (primary) radius for the shape.

    Returns number

    Radius.

    Api

getRadius2

  • getRadius2(): number

  • Get the secondary radius for the shape.

    Returns number

    Radius2.

    Api

getRotateWithView

  • getRotateWithView(): boolean

  • Determine whether the symbolizer rotates with the map.

    Returns boolean

    Rotate with map.

    Api

getRotation

  • getRotation(): number

  • Get the symoblizer rotation.

    Returns number

    Rotation.

    Api

getScale

  • getScale(): number

  • Get the symbolizer scale.

    Returns number

    Scale.

    Api

getSize

  • getSize(): Size

  • Returns Size

    Inherit Doc

    Api

getSnapToPixel

  • getSnapToPixel(): boolean

  • Determine whether the symbolizer should be snapped to a pixel.

    Returns boolean

    The symbolizer should snap to a pixel.

    Api

getStroke

  • getStroke(): Stroke

  • Get the stroke style for the shape.

    Returns Stroke

    Stroke style.

    Api

setOpacity

  • setOpacity(opacity): void

  • Set the opacity.

    Parameters

    • opacity: number

      Opacity.

    Returns void

    Api

setRotation

  • setRotation(rotation): void

  • Set the rotation.

    Parameters

    • rotation: number

      Rotation.

    Returns void

    Api

setScale

  • setScale(scale): void

  • Set the scale.

    Parameters

    • scale: number

      Scale.

    Returns void

    Api

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc