API Reference
ReaderVisual
Minimal visual fence model for ingestion (kind + original language + payload).
Inheritance
- Object
- ReaderVisual
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method DocumentReader.ExtractVisuals
- Method DocumentReader.ReadVisuals
- Method DocumentReader.ReadVisuals
- Property OfficeDocumentReadResult.Visuals
- Property ReaderChunk.Visuals
- Property ReaderVisualExportBundle.Visual
Accepted by parameters
- Method DocumentReader.ExportVisuals
- Extension method ReaderVisual.ToJson
- Method ReaderVisualExport.GetPayloadExtension
- Method ReaderVisualExport.ToJson
Constructors
public ReaderVisual() #Inherited Methods
Properties
public String Kind { get; set; } #Normalized visual kind (for example: "mermaid", "chart", or "network").
public String Language { get; set; } #Original fenced-code language label from markdown (for example: "ix-chart").
public String Content { get; set; } #Raw visual payload/content from inside the fenced block.
public String PayloadHash { get; set; } #Optional stable short hash derived from Content.
public ReaderLocation Location { get; set; } #Optional source location for the extracted visual.
public String SourceName { get; set; } #Optional source-specific visual name, for example a PDF image resource name.
public String MimeType { get; set; } #Optional MIME type when the visual source exposes one.
public Nullable<Double> Width { get; set; } #Intrinsic visual width in source units or pixels, when available.
public Nullable<Double> Height { get; set; } #Intrinsic visual height in source units or pixels, when available.
public Nullable<Double> X { get; set; } #Left or X coordinate of the placed visual in source units, when available.
public Nullable<Double> Y { get; set; } #Bottom or Y coordinate of the placed visual in source units, when available.
public Nullable<Double> PlacedWidth { get; set; } #Placed visual width in source units, when available.
public Nullable<Double> PlacedHeight { get; set; } #Placed visual height in source units, when available.
public Int32 PlacementCount { get; set; } #Number of detected placement instances represented by this visual.
public Boolean HasGeometry { get; set; } #True when source placement geometry was available.
public Nullable<Boolean> IsAxisAligned { get; set; } #True when source placement geometry was axis-aligned, when known.
Extension Methods
public static String ToJson(ReaderVisual visual, Boolean indented = false) #StringSerializes a reader visual as deterministic JSON.
Parameters
- visual OfficeIMO.Reader.ReaderVisual
- Visual to serialize.
- indented System.Boolean = false
- When true, writes indented JSON for diagnostics and fixtures.