PictureSource

Extends

• ImageSource

Extended by

• BackgroundSource

Properties

artDirectives

artDirectives: null | ArtDirectiveSource[] = null

Art directives

Inherited from

ImageSource.artDirectives

Defined in

src/api/ImageSource.ts:29

---

asBackground?

optional asBackground: boolean

Container mode

Inherited from

ImageSource.asBackground

Defined in

src/api/ImageSource.ts:33

---

blurredDataUrl?

optional blurredDataUrl: string

Data URL for blurred image

Inherited from

ImageSource.blurredDataUrl

Defined in

src/api/BaseSource.ts:88

---

buffer?

optional buffer: Buffer

Image file buffer

Inherited from

ImageSource.buffer

Defined in

src/api/BaseSource.ts:82

---

componentHash

componentHash: string

Component hash

Inherited from

ImageSource.componentHash

Defined in

src/api/ImageSource.ts:31

---

componentType

componentType: "img" | "picture" | "background"

Inherited from

ImageSource.componentType

Defined in

src/api/BaseSource.ts:49

---

ctx

ctx: ImgProcContext

For art directives

Defined in

src/api/PictureSource.ts:22

---

data

data: Partial<ImgProcFile>

Database record for the image

Inherited from

ImageSource.data

Defined in

src/api/BaseSource.ts:84

---

db

db: ImgProcDataAdapter

Cache database

Inherited from

ImageSource.db

Defined in

src/api/BaseSource.ts:55

---

dirs

dirs: ImgProcContextDirectories

Available directories

Inherited from

ImageSource.dirs

Defined in

src/api/BaseSource.ts:57

---

downloadPath?

optional downloadPath: string

Download path for remote file

Inherited from

ImageSource.downloadPath

Defined in

src/api/BaseSource.ts:79

---

formatOptions

formatOptions: ImgProcFormatOptions

Sharp output options

Inherited from

ImageSource.formatOptions

Defined in

src/api/BaseSource.ts:59

---

isArtDirective

isArtDirective: boolean = false

Art directive flag

Inherited from

ImageSource.isArtDirective

Defined in

src/api/BaseSource.ts:53

---

localSourcePath

localSourcePath: string

Resolved src to handle local file

Inherited from

ImageSource.localSourcePath

Defined in

src/api/BaseSource.ts:77

---

logger?

optional logger: AstroIntegrationLogger

Global logger

Inherited from

ImageSource.logger

Defined in

src/api/BaseSource.ts:63

---

options

options: Omit<ImgProcProcessorOptions, "width" | "height" | "formatOptions"> & object

Resolved component props

Type declaration

height?

optional height: number

src

src: string

width?

optional width: number

Inherited from

ImageSource.options

Defined in

src/api/BaseSource.ts:66

---

resolved

resolved: object = {}

densities?

optional densities: [number, ...number[]]

height?

optional height: number

sizes?

optional sizes: string

width?

optional width: number

widths?

optional widths: [number, ...number[]]

Inherited from

ImageSource.resolved

Defined in

src/api/BaseSource.ts:93

---

settings

settings: Omit<ImgProcSettings, "dataAdapter">

Integration settings (incl. default options)

Inherited from

ImageSource.settings

Defined in

src/api/BaseSource.ts:61

---

spinner

spinner: Ora

Inherited from

ImageSource.spinner

Defined in

src/api/BaseSource.ts:101

---

timeStart

timeStart: number

Inherited from

ImageSource.timeStart

Defined in

src/api/BaseSource.ts:102

---

type

type: "data" | "local" | "remote"

Inherited from

ImageSource.type

Defined in

src/api/BaseSource.ts:74

---

variants?

optional variants: ImgProcVariants

Variants

Inherited from

ImageSource.variants

Defined in

src/api/BaseSource.ts:90

Accessors

containerAttributes

get containerAttributes(): Record<string, unknown>

Returns

Record<string, unknown>

Inherited from

ImageSource.containerAttributes

Defined in

src/api/ImageSource.ts:318

---

containerClassList

get containerClassList(): string[]

Returns

string[]

Inherited from

ImageSource.containerClassList

Defined in

src/api/ImageSource.ts:293

---

css

get css(): string

Returns

string

Inherited from

ImageSource.css

Defined in

src/api/ImageSource.ts:265

---

cssObj

get cssObj(): undefined | ImgProcCssObj

Returns

undefined | ImgProcCssObj

Inherited from

ImageSource.cssObj

Defined in

src/api/ImageSource.ts:141

---

imageAttributes

get imageAttributes(): HTMLAttributes<"img">

Returns

HTMLAttributes<"img">

Inherited from

ImageSource.imageAttributes

Defined in

src/api/ImageSource.ts:86

---

imageClassList

get imageClassList(): string[]

Returns

string[]

Inherited from

ImageSource.imageClassList

Defined in

src/api/ImageSource.ts:61

---

link

get link(): null | HTMLAttributes<"link">

Returns

null | HTMLAttributes<"link">

Inherited from

ImageSource.link

Defined in

src/api/BaseSource.ts:377

---

links

get links(): null | HTMLAttributes<"link">[]

Returns

null | HTMLAttributes<"link">[]

Defined in

src/api/PictureSource.ts:157

---

pictureAttributes

get pictureAttributes(): HTMLAttributes<"picture">

Returns

HTMLAttributes<"picture">

Defined in

src/api/PictureSource.ts:96

---

pictureClassList

get pictureClassList(): string[]

Returns

string[]

Defined in

src/api/PictureSource.ts:70

---

profile

get profile(): undefined | string | Record<string, unknown> | Record<string, unknown>[]

Profile from profile string or processor

Returns

undefined | string | Record<string, unknown> | Record<string, unknown>[]

Inherited from

ImageSource.profile

Defined in

src/api/BaseSource.ts:330

---

sources

get sources(): HTMLAttributes<"source">[]

Returns

HTMLAttributes<"source">[]

Defined in

src/api/PictureSource.ts:108

Methods

getBuffer()

getBuffer(): Promise<Buffer>

Return buffer of the source image

Returns

Promise<Buffer>

Inherited from

ImageSource.getBuffer

Defined in

src/api/BaseSource.ts:282

---

main()

main(): Promise<void>

Returns

Promise<void>

Inherited from

ImageSource.main

Defined in

src/api/BaseSource.ts:173

---

factory()

static factory(args): Promise<PictureSource>

Async constructor

Parameters

• args: PictureSourceArgs

Returns

Promise<PictureSource>

Overrides

ImageSource.factory

Defined in

src/api/PictureSource.ts:43