Class FontMetadata

Font metadata required for rendering.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- FontMetadata

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor FamilyName FontStyleFlags Size Unit WithSize WithStyle

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

constructor

new FontMetadata(
    familyName: string | String,
    size: number | Single,
    fontStyleFlags?: FontStyleFlags,
    unit?: FontUnit,
): FontMetadata
Initializes a new instance of the Spotfire.Dxp.Framework.Styles.FontMetadata class.
Parameters
- familyName: string | String
  The font family name.
- size: number | Single
  The rendering size in units specified by unit.
- OptionalfontStyleFlags: FontStyleFlags
  The font's styling.
- Optionalunit: FontUnit
  The unit to use when interpreting size.
Returns FontMetadata
Since
2.0

Overrides Object.constructor

FamilyName

get FamilyName(): string
Gets the family name of the font.

Returns string
Since
2.0

FontStyleFlags

get FontStyleFlags(): FontStyleFlags
Gets the style of the font.

Returns FontStyleFlags
Since
2.0

Size

get Size(): number
Gets the rendering size of the font.

Returns number
Since
2.0

Unit

get Unit(): FontUnit
Gets the rendering unit of the font.

Returns FontUnit
Since
2.0

WithSize

WithSize(size: number | Single, unit: FontUnit): FontMetadata
Creates a new Spotfire.Dxp.Framework.Styles.FontMetadata instance with a different size.
Parameters
- size: number | Single
  The size in units specified by unit.
- unit: FontUnit
  The unit of the font size.
Returns FontMetadata
A new instance with a different size.

Since
2.0

WithStyle

WithStyle(flags: FontStyleFlags): FontMetadata
Creates a new Spotfire.Dxp.Framework.Styles.FontMetadata instance with FontStyleFlags set to flags.
Parameters
- flags: FontStyleFlags
  The new Spotfire.Dxp.Framework.Styles.FontMetadata.FontStyleFlags.
Returns FontMetadata
A new instance with FontStyleFlags set to flags.

Since
2.0

Class FontMetadata

Since

Hierarchy (View Summary)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Parameters

Returns FontMetadata

Since

FamilyName

Returns string

Since

FontStyleFlags

Returns FontStyleFlags

Since

Size

Returns number

Since

Unit

Returns FontUnit

Since

WithSize

Parameters

Returns FontMetadata

Since

WithStyle

Parameters

Returns FontMetadata

Since

Settings

On This Page

`Static`Equals