Type alias OptionalContentGroup

Type declaration

• Optional creatorInfo?: { Creator: string; Subtype: string }

  A dictionary used by the creating application to store application-specific data associated with this optional content group.

  • Creator: string

    A text string specifying the application that created the group.

  • Subtype: string

    A name defining the type of content controlled by the group. Suggested values include but shall not be limited to Artwork, for graphic-design or publishing applications, and Technical, for technical designs such as building plans or schematics.

• Optional exportState?: "ON" | "OFF"

  Export state.

• id: string

  Group id.

• Optional intent?: "View" | "Design"

  A single name or an array of names that represent the intended use of the graphics in the group. The values View and Design, or any second class name may be used. A PDF processor may choose to use only groups that have a specific intent and ignore others. Default value: View. If an Optional Content Group Dictionary Intent entry contains Design then a CreatorInfo entry should be included.

• name: string

  Group name.

• Optional printState?: "ON" | "OFF"

  Print state.

• type: "OCG" | string

  Group type.

• Optional viewState?: "ON" | "OFF"

  View state.

• visible: boolean

  Visibility flag.

• Optional zoom?: { max?: number; min?: number }

  A dictionary specifying a range of magnifications at which the content in this optional content group is best viewed. It shall contain one or both of the following entries: min - The minimum recommended magnification factor at which the group shall be ON. Default value: 0. max - The magnification factor below which the group shall be ON. Default value: infinity.

  • Optional max?: number

    The magnification factor below which the group shall be ON. Default value: infinity.

  • Optional min?: number

    The minimum recommended magnification factor at which the group shall be ON. Default value: 0.