PictureSource

このコンテンツはまだ日本語訳がありません。

Defined in: api/PictureSource.ts:20

Extends

ImageSource

Extended by

BackgroundSource

Properties

artDirectives

artDirectives: null | ArtDirectiveSource[] = null

Defined in: api/ImageSource.ts:29

Art directives

Inherited from

ImageSource.artDirectives

asBackground?

optional asBackground: boolean

Defined in: api/ImageSource.ts:33

Container mode

Inherited from

ImageSource.asBackground

blurredDataUrl?

optional blurredDataUrl: string

Defined in: api/BaseSource.ts:88

Data URL for blurred image

Inherited from

ImageSource.blurredDataUrl

buffer?

optional buffer: Buffer<ArrayBufferLike>

Defined in: api/BaseSource.ts:82

Image file buffer

Inherited from

ImageSource.buffer

componentHash

componentHash: string

Defined in: api/ImageSource.ts:31

Component hash

Inherited from

ImageSource.componentHash

componentType

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

Defined in: api/BaseSource.ts:49

Inherited from

ImageSource.componentType

ctx

ctx: ImgProcContext

Defined in: api/PictureSource.ts:22

For art directives

data

data: Partial<ImgProcFile>

Defined in: api/BaseSource.ts:84

Database record for the image

Inherited from

ImageSource.data

db

db: ImgProcDataAdapter

Defined in: api/BaseSource.ts:55

Cache database

Inherited from

ImageSource.db

dirs

dirs: ImgProcContextDirectories

Defined in: api/BaseSource.ts:57

Available directories

Inherited from

ImageSource.dirs

downloadPath?

optional downloadPath: string

Defined in: api/BaseSource.ts:79

Download path for remote file

Inherited from

ImageSource.downloadPath

formatOptions

formatOptions: ImgProcFormatOptions

Defined in: api/BaseSource.ts:59

Sharp output options

Inherited from

ImageSource.formatOptions

isArtDirective

isArtDirective: boolean = false

Defined in: api/BaseSource.ts:53

Art directive flag

Inherited from

ImageSource.isArtDirective

localSourcePath

localSourcePath: string

Defined in: api/BaseSource.ts:77

Resolved src to handle local file

Inherited from

ImageSource.localSourcePath

logger?

optional logger: AstroIntegrationLogger

Defined in: api/BaseSource.ts:63

Global logger

Inherited from

ImageSource.logger

options

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

Defined in: api/BaseSource.ts:66

Resolved component props

Type declaration

height?

optional height: number

src

src: string

width?

optional width: number

Inherited from

ImageSource.options

resolved

resolved: object = {}

Defined in: api/BaseSource.ts:93

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

settings

settings: Omit<ImgProcSettings, "dataAdapter">

Defined in: api/BaseSource.ts:61

Integration settings (incl. default options)

Inherited from

ImageSource.settings

spinner

spinner: Ora

Defined in: api/BaseSource.ts:101

Inherited from

ImageSource.spinner

timeStart

timeStart: number

Defined in: api/BaseSource.ts:102

Inherited from

ImageSource.timeStart

type

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

Defined in: api/BaseSource.ts:74

Inherited from

ImageSource.type

variants?

optional variants: ImgProcVariants

Defined in: api/BaseSource.ts:90

Variants

Inherited from

ImageSource.variants

Accessors

containerAttributes

Get Signature

get containerAttributes(): Record<string, unknown>

Defined in: api/ImageSource.ts:323

Returns

Record<string, unknown>

Inherited from

ImageSource.containerAttributes

containerClassList

Get Signature

get containerClassList(): string[]

Defined in: api/ImageSource.ts:298

Returns

string[]

Inherited from

ImageSource.containerClassList

css

Get Signature

get css(): string

Defined in: api/ImageSource.ts:270

Returns

string

Inherited from

ImageSource.css

cssObj

Get Signature

get cssObj(): undefined | ImgProcCssObj

Defined in: api/ImageSource.ts:146

Returns

undefined | ImgProcCssObj

Inherited from

ImageSource.cssObj

imageAttributes

Get Signature

get imageAttributes(): HTMLAttributes<"img">

Defined in: api/ImageSource.ts:91

Returns

HTMLAttributes<"img">

Inherited from

ImageSource.imageAttributes

imageClassList

Get Signature

get imageClassList(): string[]

Defined in: api/ImageSource.ts:66

Returns

string[]

Inherited from

ImageSource.imageClassList

link

Get Signature

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

Defined in: api/BaseSource.ts:382

Returns

null | HTMLAttributes<"link">

Inherited from

ImageSource.link

pictureAttributes

Get Signature

get pictureAttributes(): HTMLAttributes<"picture">

Defined in: api/PictureSource.ts:101

Returns

HTMLAttributes<"picture">

pictureClassList

Get Signature

get pictureClassList(): string[]

Defined in: api/PictureSource.ts:75

Returns

string[]

profile

Get Signature

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

Defined in: api/BaseSource.ts:335

Profile from profile string or processor

Returns

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

Inherited from

ImageSource.profile

sources

Get Signature

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

Defined in: api/PictureSource.ts:113

Returns

HTMLAttributes<"source">[]

Methods

getBuffer()

getBuffer(): Promise<Buffer<ArrayBufferLike>>

Defined in: api/BaseSource.ts:287

Return buffer of the source image

Returns

Promise<Buffer<ArrayBufferLike>>

Inherited from

ImageSource.getBuffer

main()

main(): Promise<void>

Defined in: api/BaseSource.ts:178

Returns

Promise<void>

Inherited from

ImageSource.main

factory()

static factory(args): Promise<PictureSource>

Defined in: api/PictureSource.ts:43

Async constructor

Parameters

args

PictureSourceArgs

Returns

Promise<PictureSource>

Overrides

ImageSource.factory