Ignite UI for Angular

すべて
  • パブリック
  • パブリック/保護
  • すべて

Class IgxIconService

Ignite UI for Angular Icon Service -

Ignite UI Icon Service は、カスタム SVG 画像を IgxIconComponent で使用できます。 指定した font-family に従って IgxIconComponent に適用されるカスタム クラスに関連付けするために使用できます。

例:

this.iconService.registerFamilyAlias('material', 'material-icons');
this.iconService.addSvgIcon('aruba', '/assets/svg/country_flags/aruba.svg', 'svg-flags');

コンストラクター

プロパティ

アクセサー

メソッド

コンストラクター

constructor

プロパティ

iconLoaded

iconLoaded: Observable<IgxIconLoadedEvent>

アイコンが HTTP 要求を介して正常に読み込まれたときに発生する Observable。

例

this.service.iconLoaded.subscribe((ev: IgxIconLoadedEvent) => ...);

アクセサー

defaultFamily

メソッド

addSvgIcon

  • addSvgIcon(name, url, family?, stripMeta?): void

  • キャッシュに SVG 画像を追加します。SVG ソースは url です。

      this.iconService.addSvgIcon('aruba', '/assets/svg/country_flags/aruba.svg', 'svg-flags');

    パラメーター

    • name: string
    • url: string
    • family: string = ...
    • stripMeta: boolean = false

    返却 void

addSvgIconFromText

  • addSvgIconFromText(name, iconText, family?, stripMeta?): void

  • キャッシュに SVG 画像を追加します。SVG ソースはテキストです。

      this.iconService.addSvgIconFromText('simple', '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 200 200">
      <path d="M74 74h54v54H74" /></svg>', 'svg-flags');

    パラメーター

    • name: string
    • iconText: string
    • family: string = ''
    • stripMeta: boolean = false

    返却 void

familyClassName

  • familyClassName(alias): string

  • 指定した font-family に関連するカスタム クラスがある場合は返します。

      const familyClass = this.iconService.familyClassName('material');

    パラメーター

    • alias: string

    返却 string

getSvgIcon

  • getSvgIcon(name, family?): SafeHtml

  • キャッシュされた SVG 画像を文字列として返します。

      const svgIcon = this.iconService.getSvgIcon('aruba', 'svg-flags');

    パラメーター

    • name: string
    • family: string = ''

    返却 SafeHtml

isSvgIconCached

  • isSvgIconCached(name, family?): boolean

  • 指定した SVG 画像がキャッシュに存在するかどうかを返します。

      const isSvgCached = this.iconService.isSvgIconCached('aruba', 'svg-flags');

    パラメーター

    • name: string
    • family: string = ''

    返却 boolean

registerFamilyAlias

  • registerFamilyAlias(alias, className?): this

  • 指定した font-family の IgxIconComponent に適用するカスタム クラスを登録します。

      this.iconService.registerFamilyAlias('material', 'material-icons');

    パラメーター

    • alias: string
    • className: string = alias

    返却 this