Options
All
  • Public
  • Public/Protected
  • All
Menu

PhotoEditorSDK

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Type aliases

AdjustmentIdentifierKeys

AdjustmentIdentifierKeys: Record<AdjustmentIdentifier, boolean>

AlignmentType

AlignmentType: "left" | "center" | "right"

AssetCategory

AssetCategory: "filter" | "overlay" | "font" | "sticker" | "textdesign" | "frame"

Color

Color: [number, number, number, number]

color is represented as a number array which encodes as a single gray value or a RGB(A) tuple of floating point values where each channel is defined in the range of `[0, 1]

ConfigurationProps

ConfigurationProps: Omit<Configuration, "container">

CrossOriginType

CrossOriginType: "anonymous" | "use-credentials" | ""

CustomAdvancedToolbarItem

CustomAdvancedToolbarItem: React.ComponentType<CustomToolbarItemProps>

CustomButton

CustomButton: React.ComponentType<CustomButtonProps>

CustomCard

CustomCard: React.ComponentType<CustomCardProps>

CustomCheckbox

CustomCheckbox: React.ComponentType<CustomCheckboxProps>

CustomColorItem

CustomColorItem: React.ComponentType<CustomColorItemProps>

CustomDialog

CustomDialog: React.ComponentType<CustomDialogProps>

CustomItemCard

CustomItemCard<T>: React.ComponentType<CustomItemCardProps<T>>

Type parameters

CustomItemCardProps

CustomItemCardProps<T>: AdvancedItemCardProps[T]

Type parameters

CustomMeasurements

CustomMeasurements: { advancedUIToolControlBar?: { marginBottom?: number; width?: number }; advancedUIToolbar?: { marginBottom?: number; width?: number }; basicUIToolbar?: { closeHeight?: number; openHeight?: number }; canvas?: { marginTop?: number }; colorItem?: { size?: number }; fontSystem?: FontSystemInterface; mainCanvasActionBar?: { height?: number } }

The values will accept the pixel amount as a number

Type declaration

  • Optional advancedUIToolControlBar?: { marginBottom?: number; width?: number }
    • Optional marginBottom?: number
    • Optional width?: number
  • Optional advancedUIToolbar?: { marginBottom?: number; width?: number }
    • Optional marginBottom?: number
    • Optional width?: number
  • Optional basicUIToolbar?: { closeHeight?: number; openHeight?: number }
    • Optional closeHeight?: number
    • Optional openHeight?: number
  • Optional canvas?: { marginTop?: number }
    • Optional marginTop?: number

      This value can be used in combination with an opaque mainCanvasActionBar.background color to prevent canvas elements to be hidden behind the mainCanvasActionBar

  • Optional colorItem?: { size?: number }
    • Optional size?: number
  • Optional fontSystem?: FontSystemInterface
  • Optional mainCanvasActionBar?: { height?: number }
    • Optional height?: number

CustomTextAlignmentButton

CustomTextAlignmentButton: React.ComponentType<CustomTextAlignmentButtonProps>

CustomToolControlBarPrimaryButton

CustomToolControlBarPrimaryButton: React.ComponentType<CustomToolControlBarButtonProps>

CustomToolbar

CustomToolbar: React.ElementType<CustomToolProps>

DeserializeErrors

DeserializeErrors: "unsupportedVersion"

ExistingAdjustmentCategory

ExistingAdjustmentCategory: Omit<AdjustmentCategory, "name">

ExistingFilterCategory

ExistingLanguage

ExistingLanguage: "en" | "de"

ExistingStickerCategory

ExistingStickerCategory: ExistingCategory<StickerAsset>

ExistingTheme

ExistingTheme: "light" | "dark"

ExistingTransformCategory

ExistingTransformCategory: ExistingCategory<CropRatio>

ExportData

ExportData: string | HTMLImageElement | Blob

The return value of an export operation.

FocusOptions

FontAsset

FontType

FontType: "uppercase" | "capitalize" | "lowercase" | "none"

FontWeight

FontWeight: 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 | "normal" | "bold" | "lighter" | "bolder" | "inherit" | "initial" | "unset"

FrameLayoutMode

FrameLayoutMode: "horizontal-inside" | "vertical-inside"

FrameRenderMode

FrameRenderMode: "repeat" | "stretch"

LayoutType

LayoutType: "basic" | "advanced"

Listener

Listener: (...args: any[]) => void

Type declaration

    • (...args: any[]): void
    • Parameters

      • Rest ...args: any[]

      Returns void

ModalIdentifier

ModalIdentifier: keyof ErrorLocale | keyof WarningLocale | keyof InfoLocale | "inputText"

NormalizedNumber

NormalizedNumber: number

Operation

PatchImage

PatchImage: string | HTMLImageElement

PositiveNumber

PositiveNumber: number

ResizeMode

ResizeMode: "keepAspect" | "unrestricted"

SerializableColor

SerializableColor: [number, number, number, number]

SpriteOptions

SpriteType

SpriteType: STICKER | TEXT | TEXT_DESIGN

TintMode

TintMode: "none" | "solid" | "colorized"

Variables

Const AdjustmentIdentifierKeys

AdjustmentIdentifierKeys: {} = Object.values(AdjustmentIdentifier,).reduce((acc: AdjustmentIdentifierKeys, key) => {acc[key] = true;return acc;}, {} as AdjustmentIdentifierKeys)

Type declaration

Const PhotoEditorSDKUI

PhotoEditorSDKUI: { init: (config: Configuration) => Promise<EditorApi> }

The UI of PhotoEditor SDK

Type declaration

Const useIsLayoutAdvanced

useIsLayoutAdvanced: () => boolean

Type declaration

    • (): boolean
    • Returns boolean

Const useSetImage

useSetImage: () => (image: string | HTMLImageElement) => void

Type declaration

    • (): (image: string | HTMLImageElement) => void
    • Returns (image: string | HTMLImageElement) => void

        • (image: string | HTMLImageElement): void
        • Parameters

          • image: string | HTMLImageElement

          Returns void