@haxall/haxall
    Preparing search index...

    Class Font

    Font models font-family, font-size, and font-style, and font-weight. Metrics are available for a predefined set of fonts.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Parameters

      Returns void

    • Parameters

      • it: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Equality is based on all fields.

      Parameters

      Returns boolean

    • Return hash of all fields

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • First family name in names

      Returns string

    • List of prioritized family names

      Returns List<string>

    • Size of font in points.

      Returns number

    • Style as normal, italic, or oblique

      Returns FontStyle

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Get CSS style properties for this font. Also see fromProps

      Returns Map<string, string>

    • Return this font with different point size.

      Parameters

      • size: number

      Returns Font

    • Format as "[style] [weight] <size>pt <names>"

      Returns string

    • Return this font with different style

      Parameters

      Returns Font

    • Return this font with different weight.

      Parameters

      Returns Font

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Weight as number from 100 to 900

      Returns FontWeight

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Construct from a map of CSS props such as font-family, font-size. Also see toProps.

      Parameters

      • props: Map<string, string>
      • ...args: unknown[]

      Returns Font

    • Parse font from string using CSS shorthand format for supported properties:

      [<style>] [<weight>] <size> <names>
      

      Examples:

      Font.fromStr("12pt Arial")
      Font.fromStr("bold 10pt Courier")
      Font.fromStr("italic bold 8pt Times")
      Font.fromStr("italic 300 10pt sans-serif")

      Parameters

      • s: string
      • Optionalchecked: boolean
      • ...args: unknown[]

      Returns Font

    • Construct with it-block

      Parameters

      • f: (arg0: Font) => void
      • ...args: unknown[]

      Returns Font