FontCollection
ClassAn ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families.
- Available on all platforms
Index
Properties
Methods
Extends
Properties
entries
entries:
FontCollectionEntry[]
The full list of entries in this collection. Setting this property replaces all entries.
Default Value
[]
name
name:
string
The name of the Asset in Lens Studio.
Default Value
""
Inherited from
uniqueIdentifier
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
Methods
create()
staticcreate():FontCollection
Creates a new, empty FontCollection asset.
Returns
FontCollection
Since
Lens Scripting Version 356
Example
//@input Asset.Font fontRegular
//@input Asset.Font fontBold
//@input Asset.FontFamily myFamily
var collection = FontCollection.create();
var familyEntry = FontCollectionEntry.create();
familyEntry.asset = script.myFamily;
var regularEntry = FontCollectionEntry.create();
regularEntry.asset = script.fontRegular;
regularEntry.weight = 400;
var boldEntry = FontCollectionEntry.create();
boldEntry.asset = script.fontBold;
boldEntry.weight = 700;
collection.entries = [familyEntry, regularEntry, boldEntry];
getTypeName()
staticgetTypeName():TypeName<FontCollection>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<FontCollection>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
See also
- Text.
- Font.
- FontFamily.