Class Icon

Classdesc

Set icon style for vector features.

Param: opt_options

Options.

Api

Hierarchy

Constructors

constructor

Methods

getAnchor getImage getOpacity getOrigin getRotateWithView getRotation getScale getSize getSnapToPixel getSrc load setOpacity setRotation setScale

Constructors

constructor

  • new Icon(opt_options?): Icon

  • Parameters

    Returns Icon

    Classdesc

    Set icon style for vector features.

    Api

Methods

getAnchor

  • getAnchor(): number[]

  • Returns number[]

    Inherit Doc

    Api

getImage

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

  • Get the image icon.

    Parameters

    • pixelRatio: number

      Pixel ratio.

    Returns HTMLCanvasElement | ol.style.Image

    Image or Canvas element.

    Api

getOpacity

  • getOpacity(): number

  • Get the symbolizer opacity.

    Returns number

    Opacity.

    Api

getOrigin

  • getOrigin(): number[]

  • Returns number[]

    Inherit Doc

    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

getSrc

  • getSrc(): string

  • Get the image URL.

    Returns string

    Image src.

    Api

load

  • load(): void

  • Load not yet loaded URI. When rendering a feature with an icon style, the vector renderer will automatically call this method. However, you might want to call this method yourself for preloading or other purposes.

    Returns void

    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