# Class: VectorStyleItem

## vcs.vcm.util.style.VectorStyleItem

#### new vcs.vcm.util.style.VectorStyleItem(options)

  Name | Type | Description
  --- | --- | ---
  `options` | vcs.vcm.util.style.VectorStyleItem.Options |

### Extends

- vcs.vcm.util.style.StyleItem

### Members

#### cesiumFillColor{Cesium.Color}

  the current fill color as a cesium color

#### cesiumStyle{Cesium.Cesium3DTileStyle}

  The 3D representation of this style

#### exclude{vcs.vcm.util.style.VectorStyleItem.Exclusion}

#### fillColor{ol.Color} {null}

  the current fill color, not the pattern

#### image{ol.style.Icon} {ol.style.RegularShape}

#### label{string}

#### legend{Array.<vcs.vcm.util.style.StyleItem.LegendEntry>}

  Legend entries

#### name{string} {number}

  The name of the style

#### pattern{vcs.vcm.util.style.VectorStyleItem.Pattern}

#### stroke{ol.style.Stroke}

#### style{ol.style.Style} {ol.StyleFunction}

#### styleChanged{Cesium.Event}

  Fired on style updates

  TODO
    - this is not yet the case for all vector style properties

#### text{ol.style.Text}

### Methods

#### assign(result){vcs.vcm.util.style.VectorStyleItem}

  assigns the sections defined on this style to another style

  Name | Type | Description
  --- | --- | ---
  `result` | vcs.vcm.util.style.VectorStyleItem |

#### clone(result){vcs.vcm.util.style.VectorStyleItem}

  Clones this style

  Name | Type | Description
  --- | --- | ---
  `result` | vcs.vcm.util.style.VectorStyleItem |

#### getOptions(sections){vcs.vcm.util.style.VectorStyleItem.Options}

  Name | Type | Description
  --- | --- | ---
  `sections` | Object.<string, boolean> |

#### getReference(){vcs.vcm.util.style.Reference} inherited

  gets a reference to this style by its name. should only be used for static styles, aka styles already part of the config

#### unset(section)

  Exclude a section from this style. Excluded section are not returned and cannot be assigned via .assign. Setting the section over a property will remove it from the excluded sections.

  Name | Type | Description
  --- | --- | ---
  `section` | string | one of fill, stroke, image

### Type Definitions

#### vcs.vcm.util.style.VectorStyleItem.Exclusion{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `fill` | boolean |
  `stroke` | boolean |
  `image` | boolean |

#### vcs.vcm.util.style.VectorStyleItem.Fill{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `color` | ol.Color | ol.ColorLike |
  `pattern` | vcs.vcm.util.style.VectorStyleItem.Pattern | undefined |

#### vcs.vcm.util.style.VectorStyleItem.Image{Object}

  This is either olx.style.IconOptions or olx.style.CircleOptions

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `src` | string | undefined |
  `scale` | number | undefined |
  `opacity` | number | undefined |
  `color` | ol.Color | undefined |
  `fill` | olx.style.FillOptions | ol.style.Fill | undefined |
  `stroke` | olx.style.StrokeOptions | ol.style.Stroke | undefined |
  `radius` | number | undefined |
  `points` | number | undefined |
  `angle` | number | undefined |

#### vcs.vcm.util.style.VectorStyleItem.Options{vcs.vcm.util.style.StyleItem.Options}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `fill` | vcs.vcm.util.style.VectorStyleItem.Fill | false | undefined |
  `stroke` | olx.style.StrokeOptions | false | undefined |
  `image` | vcs.vcm.util.style.VectorStyleItem.Image | false | undefined |
  `text` | vcs.vcm.util.style.VectorStyleItem.Text | undefined |
  `label` | string | undefined |

#### vcs.vcm.util.style.VectorStyleItem.Pattern{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `type` | vcs.vcm.util.style.PatternType |
  `color` | ol.Color | ol.ColorLike |
  `width` | number |
  `size` | number |

#### vcs.vcm.util.style.VectorStyleItem.Text{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `text` | string | undefined |
  `font` | string | vcs.vcm.util.style.FontObject | undefined |
  `fill` | olx.style.FillOptions | ol.style.Fill | undefined |
  `stroke` | olx.style.StrokeOptions | ol.style.Stroke | undefined |
  `textBaseline` | string | undefined |
  `offsetX` | number | undefined |
  `offsetY` | number | undefined |