# Symbol Override
```javascript
var overrides = symbolInstance.overrides
```

A [Symbol](https://sketch.com/docs/symbols/) override. This component is not exposed, it is only returned when accessing the `overrides` of a [Symbol Instance](#symbol-instance) or [Symbol Source](#symbol-source). The overrides are not available until after the instance is injected into the document.

| Properties |  |
| --- | --- |
| path<span class="arg-type">string</span> | The path to the override. It's formed by the symbolId of the nested symbols separated by a `/`. |
| property<span class="arg-type">string</span> | The property that this override controls. See below for what properties are available. |
| id<span class="arg-type">string</span> | The unique ID of the override (`${path}_${property}`). |
| symbolOverride<span class="arg-type">boolean</span> | If the override is a nested Symbol override. |
| colorOverride<span class="arg-type">boolean</span> | If the override is a color override. |
| textOverride<span class="arg-type">boolean</span> | If the override is a text override. |
| imageOverride<span class="arg-type">boolean</span> | If the override is an image override. |
| value<span class="arg-type">string / [ImageData](#imagedata)</span> | The value of the override which can be changed. |
| isDefault<span class="arg-type">boolean</span> | If the override hasn't been changed and is the default value. |
| defaultValue<span class="arg-type">string / [ImageData](#imagedata)</span> | The default value for the override. |
| affectedLayer<span class="arg-type">[Layer](#layer) / [Text](#text) / [Image](#image) / [Symbol Instance](#symbolinstance)</span> | The layer the override applies to. It will be an immutable version of the layer. |
| editable<span class="arg-type">boolean</span> | If the value of the override can be changed. |
| selected<span class="arg-type">boolean / undefined</span> | If the override is selected (or `undefined` if it's the override of a Symbol Source). |

| Methods   |                                          |
| --------- | ---------------------------------------- |
| `reset()` | Reset the override to its default value. |

## Text Overrides

```js
if (override.property === 'stringValue') {
  override.value = 'an overridden text'
}

if (override.property === 'textStyle') {
  override.value = someTextStyle.id
}

if (override.property === 'textSize') {
  override.value = String(32)
}

if (override.property === 'textColor') {
  override.value = '#FF00FF'
}

if (override.property === 'textDecoration') {
  // 'none', 'underline', or 'strikethrough'
  override.value = 'underline'
}

if (override.property === 'textHAlign') {
  const { Text } = require('sketch/dom')
  override.value = Text.Alignment.right
}
```

| `Override.property` | `Override.value` |
| --- | --- |
| `stringValue` | Text contents <span class="arg-type">string</span> |
| `textStyle` | Text style identifier <span class="arg-type">string</span> |
| `textSize` | Font size <span class="arg-type">string</span> |
| `textColor` | Text color <span class="arg-type">string</span> |
| `textDecoration` | Text decoration <span class="arg-type">string</span> |
| `textHAlign` | Text horizontal alignment <span class="arg-type">string / number</span> |

## Symbol Overrides

```js
if (override.symbolOverride) { ... }

if (override.property === 'symbolID') {
  override.value = someOtherSymbol.id
}
```

| `Override.property` | `Override.value` |
| --- | --- |
| `symbolID` | A symbol identifier for a nested instance <span class="arg-type">string</span> |

## Image Overrides

```js
if (override.property === 'image') {
  // Value could be one of:
  // - an `ImageData`
  // - a `Buffer`
  // - a native `NSImage`
  // - a native `NSURL`
  // - a native `MSImageData`
  // - a string: path to an image file
  // - an object with a `path` property: path to an image file
  // - an object with a `base64` string: a base64 encoded image
  override.value = ImageData.from(...)

  override.value = {
    base64: "..."
  }
  // etc
}

if (override.property === 'imageResizeBehavior') {
  const ResizeBehavior = Object.freeze({
    Stretch: 0,
    Original: 1,
    Fit: 2,
    Fill: 3
  })
  const currentValue = Object.keys(ResizeBehavior).find((k) => {
    return String(ResizeBehavior[k]) === override.value
  })
  if (currentValue === 'Original') {
    override.value = ResizeBehavior.Stretch
  }
}
```

| `Override.property` | `Override.value` |
| --- | --- |
| `image` | A nested image <span class="arg-type">[ImageData](#imagedata)</span> |
| `imageResizeBehavior` | A nested image sizing <span class="arg-type">string / number</span> |

## Color Overrides

```js
if (override.colorOverride) { ... }

if (override.property === 'color:fill-0') {
  override.value = '#aa7080'

  console.log(
    `First fill color for "${override.affectedLayer.name}": ${override.value}`,
  )
  // 👉 First fill color for "Rectangle": #aa7080
}
```

| `Override.property` | `Override.value` |
| --- | --- |
| `textColor` | Text color <span class="arg-type">string</span> |
| `fillColor` | Group tint color <span class="arg-type">string</span> |
| `color:fill-N` | N-th fill color <span class="arg-type">string</span> |
| `color:border-N` | N-th border color <span class="arg-type">string</span> |
| `color:shadow-N` | N-th shadow color <span class="arg-type">string</span> |
| `color:innershadow-N` | N-th inner shadow color <span class="arg-type">string</span> |
| `swatchValue` | Color Variable value <span class="arg-type">[Swatch](#swatch) / undefined</span> |
| `defaultSwatchValue` | A default Color Variable value <span class="arg-type">[Swatch](#swatch) / undefined</span> |
| `blendMode:fill-N` | The blend mode for the N-th fill color |
| `opacity:fill-N` | The opacity value for the N-th fill color |

## Layer Overrides

```js
if (override.property === 'layerStyle') {
  override.value = someLayerStyle.id
}

if (override.property === 'flowDestination') {
  override.value = someHotspotLayer.id
}

if (override.property === 'isVisible') {
  override.value = false
}

if (override.property === 'horizontalSizing') {
  const { FlexSizing } = require('sketch/dom')
  const currentValue = Object.keys(FlexSizing).find((k) => {
    return String(FlexSizing[k]) === override.value
  })
  if (currentValue === 'Fixed') {
    override.value = FlexSizing.Fill
  }
}
```

| `Override.property` | `Override.value` |
| --- | --- |
| `layerStyle` | A shared layer style identifier <span class="arg-type">string</span> |
| `flowDestination` | A hotspot target identifier <span class="arg-type">string</span> |
| `isVisible` | A layer visibility flag <span class="arg-type">boolean</span> |
| `horizontalSizing` | Layer sizing options <span class="arg-type">[FlexSizing](#flexsizing)</span> |
| `verticalSizing` | Layer sizing options <span class="arg-type">[FlexSizing](#flexsizing)</span> |

## Get the frame of an Override

```javascript
var frame = override.getFrame()
```

The frame of an override can be different than the frame of its affected Layer in case where the Symbol Instance has been scaled for example.

### Returns

A [Rectangle](#rectangle) describing the frame of the affected layer in the Symbol Instance's coordinates.