OptionalContentConfig 型の別名

型宣言

• creator: null | string

  この構成を作成したアプリケーションまたはプロセスの名前。指定されていない場合は null になります。

• getGroup:function

  • getGroup(id: string): OptionalContentGroup

  • 一意の識別子によってオプション コンテンツ グループ (OCG) を取得します。

    戻り値

    対応する OptionalContentGroup。見つからない場合はエラーをスローします。

    パラメータ

    • id: string

      コンテンツ グループの ID。

    戻り値 OptionalContentGroup

• getGroups:function

  • getGroups(): { [id: string]: OptionalContentGroup }

  • ドキュメントで定義されているすべてのオプション コンテンツ グループ (OCG) を取得します。

    戻り値

    キーがグループ ID で、値が OptionalContentGroup インスタンスであるオブジェクト。

    戻り値 { [id: string]: OptionalContentGroup }

    • [id: string]: OptionalContentGroup

• getOrder:function

  • getOrder(): (string | { name: string | null; order: string[] })[]

  • オプションのコンテンツ グループをレイヤー パネルに表示する順序を取得します。

    これには次のものが含まれます:

    • グループの単純な順序付きリストを表す文字列 ID の配列。
    • nameとorderを含むオブジェクトの配列。order はグループ化されたレイヤーのリストです。

    戻り値

    グループに設定された表示順序。

    戻り値 (string | { name: string | null; order: string[] })[]

• isVisible:function

  • isVisible(groupOrId: string | OptionalContentGroup): boolean

  • オプション コンテンツ グループ (OCG) が現在表示されているかどうかを確認します。

    戻り値

    グループが表示されている場合は true、そうでない場合は false。

    パラメータ

    • groupOrId: string | OptionalContentGroup

      グループ インスタンスまたはその ID。

    戻り値 boolean

• name: null | string

  この構成のユーザーフレンドリな名前。名前がない場合は null になります。

• setVisibility:function

  • setVisibility(id: string, visible: boolean): void

  • オプションのコンテンツ グループ (OCG) の表示状態を設定します。

    パラメータ

    • id: string

      コンテンツ グループの ID。

    • visible: boolean

      グループを表示するには true、非表示にするには false です。

    戻り値 void

• viewScale: number

  オプションのコンテンツを表示するときに適用されるスケーリング係数を定義します。これは、ズーム レベルに基づいて OCG の有効な表示を決定するために使用されます。