Class FramingIntent

Hierarchy

HandleWrapper
- FramingIntent

Index

Constructors

Properties

Accessors

aspectRatio customAttrs customAttrsCount id label protection

Methods

_checkHandle asDict asJson equals getCustomAttr hasCustomAttr removeCustomAttr setCustomAttr toJSON

Constructors

constructor

new FramingIntent(
    opts: {
        aspectRatio: DimensionsInt;
        id: string;
        label?: string;
        protection?: number;
    },
): FramingIntent
Parameters
- opts: { aspectRatio: DimensionsInt; id: string; label?: string; protection?: number }
Returns FramingIntent
Overrides HandleWrapper.constructor
- Defined in src/framing-intent.ts:30

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

aspectRatio

get aspectRatio(): DimensionsInt
aspectRatio

Returns DimensionsInt
- Defined in src/framing-intent.ts:87
set aspectRatio(value: DimensionsInt): void
Parameters
- value: DimensionsInt
Returns void
- Defined in src/framing-intent.ts:93

customAttrs

get customAttrs(): Record<string, CustomAttrValue>
Returns Record<string, CustomAttrValue>
- Defined in src/framing-intent.ts:163

customAttrsCount

get customAttrsCount(): number
Returns number
- Defined in src/framing-intent.ts:158

id

get id(): string
id

Returns string
- Defined in src/framing-intent.ts:73

label

get label(): string
label

Returns string
- Defined in src/framing-intent.ts:80

protection

get protection(): number
protection

Returns number
- Defined in src/framing-intent.ts:102
set protection(value: number): void
Parameters
- value: number
Returns void
- Defined in src/framing-intent.ts:108

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

asDict

asDict(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/framing-intent.ts:118

asJson

asJson(indent?: number): string
Parameters
- indent: number = 0
Returns string
- Defined in src/framing-intent.ts:125

equals

equals(other: string | FramingIntent): boolean
Parameters
- other: string | FramingIntent
Returns boolean
- Defined in src/framing-intent.ts:113

getCustomAttr

getCustomAttr(name: string): CustomAttrValue | null
Parameters
- name: string
Returns CustomAttrValue | null
- Defined in src/framing-intent.ts:143

hasCustomAttr

hasCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/framing-intent.ts:148

removeCustomAttr

removeCustomAttr(name: string): boolean
Parameters
- name: string
Returns boolean
- Defined in src/framing-intent.ts:153

setCustomAttr

setCustomAttr(name: string, value: CustomAttrValue): void
Parameters
- name: string
- value: CustomAttrValue
Returns void
- Defined in src/framing-intent.ts:138

toJSON

toJSON(): Record<string, unknown>
Returns Record<string, unknown>
- Defined in src/framing-intent.ts:132