Class Canvas

Hierarchy

HandleWrapper
- Canvas

Constructors

constructor

new Canvas(
    opts: {
        anamorphicSqueeze?: number;
        dimensions: DimensionsInt;
        effectiveAnchorPoint?: PointFloat | null;
        effectiveDimensions?: DimensionsInt | null;
        framingDecisions?: object;
        id: string;
        label?: string;
        photositeDimensions?: DimensionsInt | null;
        physicalDimensions?: DimensionsFloat | null;
        sourceCanvasId: string;
    },
): Canvas
Parameters
- opts: {
      anamorphicSqueeze?: number;
      dimensions: DimensionsInt;
      effectiveAnchorPoint?: PointFloat | null;
      effectiveDimensions?: DimensionsInt | null;
      framingDecisions?: object;
      id: string;
      label?: string;
      photositeDimensions?: DimensionsInt | null;
      physicalDimensions?: DimensionsFloat | null;
      sourceCanvasId: string;
  }
Returns Canvas
Overrides HandleWrapper.constructor
- Defined in src/canvas.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

anamorphicSqueeze

get anamorphicSqueeze(): number
anamorphicSqueeze

Returns number
- Defined in src/canvas.ts:155
set anamorphicSqueeze(value: number): void
Parameters
- value: number
Returns void
- Defined in src/canvas.ts:161

customAttrs

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

customAttrsCount

get customAttrsCount(): number
Returns number
- Defined in src/canvas.ts:338

dimensions

get dimensions(): DimensionsInt
dimensions

Returns DimensionsInt
- Defined in src/canvas.ts:143
set dimensions(value: DimensionsInt): void
Parameters
- value: DimensionsInt
Returns void
- Defined in src/canvas.ts:149

effectiveAnchorPoint

get effectiveAnchorPoint(): PointFloat | null
effectiveAnchorPoint

Returns PointFloat | null
- Defined in src/canvas.ts:188

effectiveDimensions

get effectiveDimensions(): DimensionsInt | null
effectiveDimensions

Returns DimensionsInt | null
- Defined in src/canvas.ts:167
set effectiveDimensions(value: DimensionsInt | null): void
Parameters
- value: DimensionsInt | null
Returns void
- Defined in src/canvas.ts:175

framingDecisions

get framingDecisions(): CollectionWrapper<FramingDecision>
framingDecisions collection

Returns CollectionWrapper<FramingDecision>
- Defined in src/canvas.ts:231

id

get id(): string
id

Returns string
- Defined in src/canvas.ts:122

label

get label(): string
label

Returns string
- Defined in src/canvas.ts:129

photositeDimensions

get photositeDimensions(): DimensionsInt | null
photositeDimensions

Returns DimensionsInt | null
- Defined in src/canvas.ts:197
set photositeDimensions(value: DimensionsInt): void
Parameters
- value: DimensionsInt
Returns void
- Defined in src/canvas.ts:205

physicalDimensions

get physicalDimensions(): DimensionsFloat | null
physicalDimensions

Returns DimensionsFloat | null
- Defined in src/canvas.ts:214
set physicalDimensions(value: DimensionsFloat): void
Parameters
- value: DimensionsFloat
Returns void
- Defined in src/canvas.ts:222

sourceCanvasId

get sourceCanvasId(): string
sourceCanvasId

Returns string
- Defined in src/canvas.ts:136

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

addFramingDecision

addFramingDecision(
    id: string,
    label: string,
    framingIntentId: string,
    dimensions: DimensionsFloat,
    anchorPoint: PointFloat,
): FramingDecision
Add a framing decision to this canvas.
Parameters
- id: string
- label: string
- framingIntentId: string
- dimensions: DimensionsFloat
- anchorPoint: PointFloat
Returns FramingDecision
- Defined in src/canvas.ts:268

asDict

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

asJson

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

equals

equals(other: string | Canvas): boolean
Parameters
- other: string | Canvas
Returns boolean
- Defined in src/canvas.ts:244

getCustomAttr

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

getEffectiveRect

getEffectiveRect(): Rect | null
Get effective rect or None if not defined.

Returns Rect | null
- Defined in src/canvas.ts:309

getRect

getRect(): Rect
Get canvas rect as (0, 0, width, height).

Returns Rect
- Defined in src/canvas.ts:302

hasCustomAttr

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

removeCustomAttr

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

setCustomAttr

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

setEffective

setEffective(dims: DimensionsInt, anchor: PointFloat): void
Set effective dimensions and anchor point on this canvas.
Parameters
- dims: DimensionsInt
- anchor: PointFloat
Returns void
- Defined in src/canvas.ts:292

toJSON

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

Class Canvas

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Canvas

Properties

Protected_addon

Protected_docRef

Accessors

anamorphicSqueeze

Returns number

Parameters

Returns void

customAttrs

Returns Record<string, CustomAttrValue>

customAttrsCount

Returns number

dimensions

Returns DimensionsInt

Parameters

Returns void

effectiveAnchorPoint

Returns PointFloat | null

effectiveDimensions

Returns DimensionsInt | null

Parameters

Returns void

framingDecisions

Returns CollectionWrapper<FramingDecision>

id

Returns string

label

Returns string

photositeDimensions

Returns DimensionsInt | null

Parameters

Returns void

physicalDimensions

Returns DimensionsFloat | null

Parameters

Returns void

sourceCanvasId

Returns string

Methods

Protected_checkHandle

Returns void

addFramingDecision

Parameters

Returns FramingDecision

asDict

Returns Record<string, unknown>

asJson

Parameters

Returns string

equals

Parameters

Returns boolean

getCustomAttr

Parameters

Returns CustomAttrValue | null

getEffectiveRect

Returns Rect | null

getRect

Returns Rect

hasCustomAttr

Parameters

Returns boolean

removeCustomAttr

Parameters

Returns boolean

setCustomAttr

Parameters

Returns void

setEffective

`Protected`_addon

`Protected`_docRef

`Protected`_checkHandle