Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FontZipLoader

Hierarchy

Index

Constructors

constructor

constructor

Properties

crossOrigin

crossOrigin: string

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is anonymous.

default

'anonymous'

manager

The loadingManager the loader is using. Default is DefaultLoadingManager.

path

path: string

The base path from which the asset will be loaded. Default is the empty string.

default

''

requestHeader

requestHeader: {}

The request header used in HTTP request. See .setRequestHeader. Default is empty object.

default

{}

Type declaration

  • [header: string]: string

resourcePath

resourcePath: string

The base path from which additional resources like textures will be loaded. Default is the empty string.

default

''

withCredentials

withCredentials: boolean

Whether the XMLHttpRequest uses credentials. See .setWithCredentials. Default is false.

default:

false

Static crossOrigin

crossOrigin: string

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is anonymous.

default

'anonymous'

Static manager

The loadingManager the loader is using. Default is DefaultLoadingManager.

Static path

path: string

The base path from which the asset will be loaded. Default is the empty string.

default

''

Static requestHeader

requestHeader: {}

The request header used in HTTP request. See .setRequestHeader. Default is empty object.

default

{}

Type declaration

  • [header: string]: string

Static resourcePath

resourcePath: string

The base path from which additional resources like textures will be loaded. Default is the empty string.

default

''

Static withCredentials

withCredentials: boolean

Whether the XMLHttpRequest uses credentials. See .setWithCredentials. Default is false.

default:

false

Methods

load

  • load(url: string, onLoad?: (responseFont: I3JS.Font) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void
  • Parameters

    • url: string
    • Optional onLoad: (responseFont: I3JS.Font) => void
    • Optional onProgress: (event: ProgressEvent<EventTarget>) => void
        • (event: ProgressEvent<EventTarget>): void
        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • Optional onError: (event: ErrorEvent) => void
        • (event: ErrorEvent): void
        • Parameters

          • event: ErrorEvent

          Returns void

    Returns void

loadAsync

  • loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<I3JS.Font>
  • Begin loading from url.

    Parameters

    • url: string

      The path or URL to the file.

    • Optional onProgress: (event: ProgressEvent<EventTarget>) => void

      Will be called while load progresses.

        • (event: ProgressEvent<EventTarget>): void
        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<I3JS.Font>

parse

setCrossOrigin

setPath

setRequestHeader

setResourcePath

setWithCredentials

Static load

  • load(url: string, onLoad?: (responseFont: I3JS.Font) => void, onProgress?: (event: ProgressEvent<EventTarget>) => void, onError?: (event: ErrorEvent) => void): void
  • Begin loading from url.

    Parameters

    • url: string

      The path or URL to the file.

    • Optional onLoad: (responseFont: I3JS.Font) => void

      Will be called when load completes.

    • Optional onProgress: (event: ProgressEvent<EventTarget>) => void

      Will be called while load progresses.

        • (event: ProgressEvent<EventTarget>): void
        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • Optional onError: (event: ErrorEvent) => void

      Will be called when load errors.

        • (event: ErrorEvent): void
        • Parameters

          • event: ErrorEvent

          Returns void

    Returns void

Static loadAsync

  • loadAsync(url: string, onProgress?: (event: ProgressEvent<EventTarget>) => void): Promise<I3JS.Font>
  • Begin loading from url.

    Parameters

    • url: string

      The path or URL to the file.

    • Optional onProgress: (event: ProgressEvent<EventTarget>) => void

      Will be called while load progresses.

        • (event: ProgressEvent<EventTarget>): void
        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<I3JS.Font>

Static parse

Static setCrossOrigin

Static setPath

Static setRequestHeader

Static setResourcePath

Static setWithCredentials

Generated using TypeDoc