Class Context

Hierarchy

HandleWrapper
- Context

Index

Constructors

Properties

Accessors

canvases clipId contextCreator customAttrs customAttrsCount label

Methods

_checkHandle addCanvas asDict asJson equals getCustomAttr hasCustomAttr removeCustomAttr resolveCanvasForDimensions setCustomAttr toJSON

Constructors

constructor

new Context(
    opts: {
        canvases?: object;
        contextCreator?: string | null;
        label: string;
    },
): Context
Parameters
- opts: { canvases?: object; contextCreator?: string | null; label: string }
Returns Context
Overrides HandleWrapper.constructor
- Defined in src/context.ts:40

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

canvases

get canvases(): CollectionWrapper<Canvas>
canvases collection

Returns CollectionWrapper<Canvas>
- Defined in src/context.ts:114

clipId

get clipId(): ClipID | null
clipId

Returns ClipID | null
- Defined in src/context.ts:87
set clipId(value: Record<string, unknown> | ClipID | null): void
Parameters
- value: Record<string, unknown> | ClipID | null
Returns void
- Defined in src/context.ts:95

contextCreator

get contextCreator(): string | null
contextCreator

Returns string | null
- Defined in src/context.ts:80

customAttrs

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

customAttrsCount

get customAttrsCount(): number
Returns number
- Defined in src/context.ts:224

label

get label(): string
label

Returns string
- Defined in src/context.ts:73

Methods

`Protected`_checkHandle

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

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

addCanvas

addCanvas(
    id: string,
    label: string,
    sourceCanvasId: string,
    dimensions: DimensionsInt,
    anamorphicSqueeze: number,
): Canvas
Add a canvas to this context.
Parameters
- id: string
- label: string
- sourceCanvasId: string
- dimensions: DimensionsInt
- anamorphicSqueeze: number
Returns Canvas
- Defined in src/context.ts:151

asDict

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

asJson

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

equals

equals(other: string | Context): boolean
Parameters
- other: string | Context
Returns boolean
- Defined in src/context.ts:127

getCustomAttr

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

hasCustomAttr

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

removeCustomAttr

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

resolveCanvasForDimensions

resolveCanvasForDimensions(
    inputDims: DimensionsFloat,
    canvas: Canvas,
    framing: FramingDecision,
): ResolveCanvasResult
Find matching canvas when input dimensions differ from selected canvas.
Parameters
- inputDims: DimensionsFloat
- canvas: Canvas
- framing: FramingDecision
Returns ResolveCanvasResult
- Defined in src/context.ts:173

setCustomAttr

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

toJSON

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