Class FDL

File

index.ts

Brief

Public API for @asc-mitc/fdl — re-exports all facade classes, types, and utilities.

Hierarchy

OwnedHandle
- FDL

Constructors

constructor

new FDL(
    opts: {
        defaultFramingIntent?: string | null;
        fdlCreator?: string;
        uuid?: string | null;
        versionMajor?: number;
        versionMinor?: number;
    },
): FDL
Parameters
- opts: {
      defaultFramingIntent?: string | null;
      fdlCreator?: string;
      uuid?: string | null;
      versionMajor?: number;
      versionMinor?: number;
  }
Returns FDL
Overrides OwnedHandle.constructor
- Defined in src/fdl.ts:42

Properties

`Protected`_addon

_addon: NativeAddon

Cached addon reference.

`Protected`_docRef

_docRef: OwnedHandle | null

Strong reference to the owning document. Prevents GC of the document while this child handle lives. For OwnedHandle, this is this (self-referencing).

Accessors

canvasTemplates

get canvasTemplates(): CollectionWrapper<CanvasTemplate>
canvasTemplates collection

Returns CollectionWrapper<CanvasTemplate>
- Defined in src/fdl.ts:160

contexts

get contexts(): CollectionWrapper<Context>
contexts collection

Returns CollectionWrapper<Context>
- Defined in src/fdl.ts:131

customAttrs

get customAttrs(): Record<string, CustomAttrValue>
Returns Record<string, CustomAttrValue>
- Defined in src/fdl.ts:338

customAttrsCount

get customAttrsCount(): number
Returns number
- Defined in src/fdl.ts:333

defaultFramingIntent

get defaultFramingIntent(): string | null
defaultFramingIntent

Returns string | null
- Defined in src/fdl.ts:105
set defaultFramingIntent(value: string): void
Parameters
- value: string
Returns void
- Defined in src/fdl.ts:111

fdlCreator

get fdlCreator(): string | null
fdlCreator

Returns string | null
- Defined in src/fdl.ts:93
set fdlCreator(value: string): void
Parameters
- value: string
Returns void
- Defined in src/fdl.ts:99

framingIntents

get framingIntents(): CollectionWrapper<FramingIntent>
framingIntents collection

Returns CollectionWrapper<FramingIntent>
- Defined in src/fdl.ts:146

isClosed

get isClosed(): boolean
Whether this handle has been closed.

Returns boolean
Inherited from OwnedHandle.isClosed
- Defined in src/base.ts:118

uuid

get uuid(): string | null
uuid

Returns string | null
- Defined in src/fdl.ts:81
set uuid(value: string): void
Parameters
- value: string
Returns void
- Defined in src/fdl.ts:87

version

get version(): Version
Returns Version
- Defined in src/fdl.ts:307

versionMajor

get versionMajor(): number
versionMajor

Returns number
- Defined in src/fdl.ts:117

versionMinor

get versionMinor(): number
versionMinor

Returns number
- Defined in src/fdl.ts:124

Methods

`Protected`_checkHandle

_checkHandle(): void
Check that the handle is still valid. Throws if closed.

Returns void
Inherited from OwnedHandle._checkHandle
- Defined in src/base.ts:59

[dispose]

"[dispose]"(): void
Support using doc = FDL.parse(...) syntax (Symbol.dispose).

Returns void
Inherited from OwnedHandle.[dispose]
- Defined in src/base.ts:113

addCanvasTemplate

addCanvasTemplate(
    id: string,
    label: string,
    targetDimensions: DimensionsInt,
    targetAnamorphicSqueeze: number,
    fitSource: GeometryPath,
    fitMethod: FitMethod,
    alignmentMethodHorizontal: HAlign,
    alignmentMethodVertical: VAlign,
    round: RoundStrategy,
): CanvasTemplate
Add a canvas template to the document.
Parameters
- id: string
- label: string
- targetDimensions: DimensionsInt
- targetAnamorphicSqueeze: number
- fitSource: GeometryPath
- fitMethod: FitMethod
- alignmentMethodHorizontal: HAlign
- alignmentMethodVertical: VAlign
- round: RoundStrategy
Returns CanvasTemplate
- Defined in src/fdl.ts:224

addContext

addContext(label: string, contextCreator?: string | null): Context
Add a context to the document.
Parameters
- label: string
- contextCreator: string | null = null
Returns Context
- Defined in src/fdl.ts:212

addFramingIntent

addFramingIntent(
    id: string,
    label: string,
    aspectRatio: DimensionsInt,
    protection: number,
): FramingIntent
Add a framing intent to the document.
Parameters
- id: string
- label: string
- aspectRatio: DimensionsInt
- protection: number
Returns FramingIntent
- Defined in src/fdl.ts:192

asDict

asDict(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/fdl.ts:173

asJson

asJson(indent?: number): string
Parameters
- indent: number = 0
Returns string
- Defined in src/fdl.ts:180

close

close(): void
Release the underlying C handle. Safe to call multiple times.

Returns void
Inherited from OwnedHandle.close
- Defined in src/base.ts:103

getCustomAttr

getCustomAttr(name: string): CustomAttrValue | null
Parameters
- name: string
Returns CustomAttrValue | null
- Defined in src/fdl.ts:318

hasCustomAttr

hasCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/fdl.ts:323

removeCustomAttr

removeCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/fdl.ts:328

setCustomAttr

setCustomAttr(name: string, value: CustomAttrValue): void
Parameters
- name: string
- value: CustomAttrValue
Returns void
- Defined in src/fdl.ts:313

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/fdl.ts:187

validate

validate(): void
Run C-core schema + semantic validation.

Returns void
- Defined in src/fdl.ts:287

`Static`create

create(
    uuid: string,
    versionMajor?: number,
    versionMinor?: number,
    fdlCreator?: string,
    defaultFramingIntent?: string | null,
): FDL
Create a new empty FDL document with header fields.
Parameters
- uuid: string
- versionMajor: number = 2
- versionMinor: number = 0
- fdlCreator: string = ""
- defaultFramingIntent: string | null = null
Returns FDL
- Defined in src/fdl.ts:267

`Static`parse

parse(jsonBytes: string | Buffer<ArrayBufferLike>): FDL
Parse JSON bytes into a facade FDL document.
Parameters
- jsonBytes: string | Buffer<ArrayBufferLike>
Returns FDL
- Defined in src/fdl.ts:254

Class FDL

File

Brief

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FDL

Properties

Protected_addon

Protected_docRef

Accessors

canvasTemplates

Returns CollectionWrapper<CanvasTemplate>

contexts

Returns CollectionWrapper<Context>

customAttrs

Returns Record<string, CustomAttrValue>

customAttrsCount

Returns number

defaultFramingIntent

Returns string | null

Parameters

Returns void

fdlCreator

Returns string | null

Parameters

Returns void

framingIntents

Returns CollectionWrapper<FramingIntent>

isClosed

Returns boolean

uuid

Returns string | null

Parameters

Returns void

version

Returns Version

versionMajor

Returns number

versionMinor

Returns number

Methods

Protected_checkHandle

Returns void

[dispose]

Returns void

addCanvasTemplate

Parameters

Returns CanvasTemplate

addContext

Parameters

Returns Context

addFramingIntent

Parameters

Returns FramingIntent

asDict

Returns Record<string, unknown>

asJson

Parameters

Returns string

close

Returns void

getCustomAttr

Parameters

Returns CustomAttrValue | null

hasCustomAttr

Parameters

Returns boolean

removeCustomAttr

Parameters

Returns boolean

setCustomAttr

Parameters

Returns void

`Protected`_addon

`Protected`_docRef

`Protected`_checkHandle

`Static`create

`Static`parse