Attribute.yml

---
name: Titanium.UI.iOS.Attribute
deprecated:
    since: "3.6.0"
    notes: use <Titanium.UI.Attribute> instead.
summary: An abstract datatype for specifying an attributed string attribute.
description: |
    Attributes are added to the <Titanium.UI.iOS.AttributedString> object to create
    styled text. The attribute is a JavaScript Object containing three properties:
    `type`, `value` and `range`.

    For examples of using Attributed Strings, see the
    [Attributed Strings guide](http://docs.appcelerator.com/titanium/latest/#!/api/Titanium.UI.iOS.AttributedString).
platforms: [iphone, ipad]
extends: Titanium.Proxy
since: "3.2"

properties:
  - name: type
    summary: Attribute to apply to the text.
    type: Number
    constants: [ Titanium.UI.iOS.ATTRIBUTE_FONT, Titanium.UI.iOS.ATTRIBUTE_FOREGROUND_COLOR,
                 Titanium.UI.iOS.ATTRIBUTE_BACKGROUND_COLOR, Titanium.UI.iOS.ATTRIBUTE_LIGATURE,
                 Titanium.UI.iOS.ATTRIBUTE_KERN, Titanium.UI.iOS.ATTRIBUTE_STRIKETHROUGH_STYLE,
                 Titanium.UI.iOS.ATTRIBUTE_UNDERLINES_STYLE, Titanium.UI.iOS.ATTRIBUTE_STROKE_COLOR,
                 Titanium.UI.iOS.ATTRIBUTE_STROKE_WIDTH, Titanium.UI.iOS.ATTRIBUTE_SHADOW,
                 Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION, Titanium.UI.iOS.ATTRIBUTE_TEXT_EFFECT,
                 Titanium.UI.iOS.ATTRIBUTE_LINK, Titanium.UI.iOS.ATTRIBUTE_BASELINE_OFFSET,
                 Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_COLOR, Titanium.UI.iOS.ATTRIBUTE_STRIKETHROUGH_COLOR,
                 Titanium.UI.iOS.ATTRIBUTE_OBLIQUENESS, Titanium.UI.iOS.ATTRIBUTE_EXPANSION ]
    optional: false
  - name: value
    summary: Attribute value.
    description: |
        The `value` parameter depends on the `type` parameter. For example, to
        use the foreground color on the text you would use <Titanium.UI.iOS.ATTRIBUTE_FOREGROUND_COLOR>
        for the `type` and a color value for the `value`:

            {
                type: Titanium.UI.iOS.ATTRIBUTE_FOREGROUND_COLOR,
                value: '#DDD',
                range: [0, 100]
            }

        If you use <Titanium.UI.iOS.ATTRIBUTE_UNDERLINES_STYLE> or <Titanium.UI.iOS.ATTRIBUTE_STRIKETHROUGH_COLOR>,
        you must use one or more of these constants:

          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_NONE>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_SINGLE>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_THICK>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_DOUBLE>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_SOLID>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_DOT>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_DASH>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_DASH_DOT_DOT>
          * <Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_BY_WORD>

        These can be combined:

            {
                type: Titanium.UI.iOS.ATTRIBUTE_UNDERLINES_STYLE,
                value: Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_SINGLE | Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_PATTERN_DASH,
                range: [0, 100]
            }

        If you use the <Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION>, you must use one or more of
        these constants:

          * <Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION_EMBEDDING>
          * <Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION_OVERRIDE>
          * <Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION_NATURAL>
          * <Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION_LEFT_TO_RIGHT>
          * <Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION_RIGHT_TO_LEFT>

        These can also be combined the same way as the underline styles.

        If you use the <Titanium.UI.iOS.ATTRIBUTE_SHADOW>, the `value` must be a JavaScript object containing
        any of the `offset`, `blurRadius` or `color` properties:

            {
                offset: {
                    width: 10,
                    height: 10
                },
                blurRadius: 10,
                color: 'red'
            }

        If you use the <Titanium.UI.iOS.ATTRIBUTE_TEXT_EFFECT>, you must use the only supported iOS 7 constant
        <Titanium.UI.iOS.ATTRIBUTE_LETTERPRESS_STYLE>.

    type: Number
    constants: [ Titanium.UI.iOS.ATTRIBUTE_UNDERLINE_STYLE_*,
                 Titanium.UI.iOS.ATTRIBUTE_WRITING_DIRECTION_*,
                 Titanium.UI.iOS.ATTRIBUTE_LETTERPRESS_STYLE ]
    optional: false
  - name: range
    summary: Attribute range. 
    description: |
        This specifies the range of text to apply the property to, as an array of two numbers: `[from, length]`.
    type: Array<Number>
    optional: false