Skip to main content

FontCollection

Class

An ordered collection of Font and FontFamily assets, allowing a Text component to access multiple fonts and font families.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Index

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

Asset.name


uniqueIdentifier

readonly uniqueIdentifier: string

Since

Lens Scripting Version 176

Inherited from

Asset.uniqueIdentifier

Methods

create()

static create(): 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()

static getTypeName(): 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

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Asset.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

Asset.isSame

See also