# FontVariationAxis

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Ctors](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#pubctors)\|[Methods](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#inhmethods)  

# FontVariationAxis

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontVariationAxis "View this page in Kotlin")\|Java

`
public

final

class
FontVariationAxis
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.graphics.fonts.FontVariationAxis |

<br />

*** ** * ** ***

Class that holds information about single font variation axis.

## Summary

|                                                                                                                                  ### Public constructors                                                                                                                                   ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[FontVariationAxis](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#FontVariationAxis(java.lang.String,%20float))`(`[String](https://developer.android.com/reference/java/lang/String)` tagString, float styleValue) ` Construct FontVariationAxis. |

|                                                                                                                                                                                                                         ### Public methods                                                                                                                                                                                                                         ||
|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean`                                                                                                        | ` `[equals](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one.                                                                                   |
| ` static `[FontVariationAxis[]](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis) | ` `[fromFontVariationSettings](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#fromFontVariationSettings(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` settings) ` Construct FontVariationAxis array from font variation settings.                                  |
| ` float`                                                                                                          | ` `[getStyleValue](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#getStyleValue())`() ` Returns the style value associated to the given axis for this font.                                                                                                                                                   |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                             | ` `[getTag](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#getTag())`() ` Returns the variable font axis tag associated to this axis.                                                                                                                                                                         |
| ` int`                                                                                                            | ` `[hashCode](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                                                       |
| ` static `[String](https://developer.android.com/reference/java/lang/String)                                      | ` `[toFontVariationSettings](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#toFontVariationSettings(android.graphics.fonts.FontVariationAxis[]))`(`[FontVariationAxis[]](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis)` axes) ` Stringify the array of FontVariationAxis. |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                             | ` `[toString](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis#toString())`() ` Returns a valid font variation setting string for this object.                                                                                                                                                                  |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Public constructors

### FontVariationAxis

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public FontVariationAxis (String tagString, 
                float styleValue)
```

Construct FontVariationAxis. The axis tag must contain four ASCII characters. Tag string that are longer or shorter than four characters, or contains characters outside of U+0020..U+007E are invalid.

<br />

|                         Parameters                         ||
|--------------|----------------------------------------------|
| `tagString`  | `String`: This value cannot be`null`. <br /> |
| `styleValue` | `float` <br />                               |

|                                                                 Throws                                                                  ||
|--------------------------------------------------------------------------------------------------------|---------------------------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | If given tag string is invalid. |

## Public methods

### equals

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public boolean equals (Object o)
```

Indicates whether some other object is "equal to" this one.

The`equals`method implements an equivalence relation on non-null object references:

- It is*reflexive* : for any non-null reference value`x`,`x.equals(x)`should return`true`.
- It is*symmetric* : for any non-null reference values`x`and`y`,`x.equals(y)`should return`true`if and only if`y.equals(x)`returns`true`.
- It is*transitive* : for any non-null reference values`x`,`y`, and`z`, if`x.equals(y)`returns`true`and`y.equals(z)`returns`true`, then`x.equals(z)`should return`true`.
- It is*consistent* : for any non-null reference values`x`and`y`, multiple invocations of`x.equals(y)`consistently return`true`or consistently return`false`, provided no information used in`equals`comparisons on the objects is modified.
- For any non-null reference value`x`,`x.equals(null)`should return`false`.

An equivalence relation partitions the elements it operates on into*equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

<br />

|                   Parameters                   ||
|-----|-------------------------------------------|
| `o` | `Object`: This value may be`null`. <br /> |

|                                         Returns                                          ||
|-----------|-------------------------------------------------------------------------------|
| `boolean` | `true`if this object is the same as the obj argument;`false`otherwise. <br /> |

### fromFontVariationSettings

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static FontVariationAxis[] fromFontVariationSettings (String settings)
```

Construct FontVariationAxis array from font variation settings. The settings string is constructed from multiple pairs of axis tag and style values. The axis tag must contain four ASCII characters and must be wrapped with single quotes (U+0027) or double quotes (U+0022). Axis strings that are longer or shorter than four characters, or contain characters outside of U+0020..U+007E are invalid. If a specified axis name is not defined in the font, the settings will be ignored.  

```
   FontVariationAxis.fromFontVariationSettings("'wdth' 1.0");
   FontVariationAxis.fromFontVariationSettings("'AX  ' 1.0, 'FB  ' 2.0");
 
```

<br />

<br />

|                                   Parameters                                   ||
|------------|--------------------------------------------------------------------|
| `settings` | `String`: font variation settings. This value may be`null`. <br /> |

|                                                                                                             Returns                                                                                                             ||
|---------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| [FontVariationAxis[]](https://developer.android.com/reference/android/graphics/fonts/FontVariationAxis) | FontVariationAxis\[\] the array of parsed font variation axis.`null`if settings has no font variation settings. <br /> |

|                                                                                 Throws                                                                                 ||
|--------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | If given string is not a valid font variation settings format. |

### getStyleValue

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public float getStyleValue ()
```

Returns the style value associated to the given axis for this font.

<br />

|     Returns     ||
|---------|--------|
| `float` | <br /> |

### getTag

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String getTag ()
```

Returns the variable font axis tag associated to this axis.

<br />

|                                  Returns                                   ||
|--------------------------------------------------------------------|--------|
| [String](https://developer.android.com/reference/java/lang/String) | <br /> |

### hashCode

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int hashCode ()
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by[HashMap](https://developer.android.com/reference/java/util/HashMap).

The general contract of`hashCode`is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the`hashCode`method must consistently return the same integer, provided no information used in`equals`comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce the same integer result.
- It is*not* required that if two objects are unequal according to the[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))method, then calling the`hashCode`method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

|                     Returns                      ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object. <br /> |

### toFontVariationSettings

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static String toFontVariationSettings (FontVariationAxis[] axes)
```

Stringify the array of FontVariationAxis.

<br />

|                                         Parameters                                          ||
|--------|-------------------------------------------------------------------------------------|
| `axes` | `FontVariationAxis`: an array of FontVariationAxis. This value may be`null`. <br /> |

|                                                                        Returns                                                                        ||
|--------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | String a valid font variation settings string. This value cannot be`null`. <br /> |

### toString

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a valid font variation setting string for this object.

<br />

|                                                Returns                                                 ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`. <br /> |