Component:DocumentPageMetadata: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Document Page Metadata
|Name=Document Page Metadata
}}
}}
{{stub}}
The '''DocumentPageMetadata''' component is used to give Metadata about a particular page on a document (Usually a PDF)


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Document|{{RootFieldType|AssetRef`1|[[Type:Document|Document]]}}|TypeAdv0=true|
|Document|{{RootFieldType|AssetRef`1|[[Type:Document|Document]]}}|TypeAdv0=true| The document to get Metadata for.
|PageIndex|Int|
|PageIndex|Int| The page in <code>Document</code> to get metadata for.
|ReferenceSize|{{RootFieldType|RawOutput`1|[[Type:Double2|Double2]]}}|TypeAdv2=true|
|ReferenceSize|{{RootFieldType|RawOutput`1|[[Type:Double2|Double2]]}}|TypeAdv2=true| The size of the page.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Line 20: Line 21:
[[Category:Components:Assets:Utility{{#translation:}}|Document Page Metadata]]
[[Category:Components:Assets:Utility{{#translation:}}|Document Page Metadata]]
[[Category:Components{{#translation:}}|Document Page Metadata]]
[[Category:Components{{#translation:}}|Document Page Metadata]]
[[Category:ComponentStubs]]

Latest revision as of 02:18, 13 January 2025

Component image 
Document Page Metadata component as seen in the Scene Inspector

The DocumentPageMetadata component is used to give Metadata about a particular page on a document (Usually a PDF)

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
Document Document The document to get Metadata for.
PageIndex Int The page in Document to get metadata for.
ReferenceSize raw output of Double2 The size of the page.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

See Also