LayerGroup Class

Summary: Group layer class

Module: aspose.psd.fileformats.psd.layers

Full Name: aspose.psd.fileformats.psd.layers.LayerGroup

Inheritance: IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader, Layer

Aspose.PSD Version: 24.9.0

Properties

Name	Type	Access	Description
BLEND_SIGNATURE [static]	int	r
LAYER_HEADER_SIZE [static]	int	r
auto_adjust_palette	bool	r/w
background_color	Color	r/w
bits_per_pixel	int	r
blend_clipped_elements	bool	r/w
blend_mode_key	BlendMode	r/w	Gets or sets the blend mode key.
blend_mode_signature	int	r
blending_options	BlendingOptions	r
bottom	int	r/w
bounds	Rectangle	r	Gets the object bounds.
buffer_size_hint	int	r/w
channel_information	ChannelInformation[]	r/w
channels_count	ushort	r
clipping	byte	r/w
container	Image	r
data_stream_container	StreamContainer	r
display_name	string	r/w
disposed	bool	r
extra_length	int	r
file_format	FileFormat	r
fill_opacity	int	r/w
filler	byte	r/w
flags	LayerFlags	r/w
has_alpha	bool	r
has_background_color	bool	r/w
has_transparent_color	bool	r/w
height	int	r	Gets height of the layers group.
horizontal_resolution	double	r/w
image_opacity	float	r
interrupt_monitor	InterruptMonitor	r/w
is_cached	bool	r
is_open	bool	r/w	Gets or sets is folder opened if set to true than group will be in open state on start up, otherwise in minimized state.
is_raw_data_available	bool	r	Gets a value indicating whether raw data loading is supported.
is_visible	bool	r/w
is_visible_in_group	bool	r
layer_blending_ranges_data	LayerBlendingRangesData	r/w
layer_creation_date_time	datetime	r/w
layer_lock	LayerLockType	r/w
layer_mask_data	LayerMaskData	r/w
layer_options	PsdOptions	r
layers	Layer[]	r	Gets the layers in layer group
left	int	r/w
length	int	r
name	string	r/w	Gets or sets the name of the text layer.
opacity	byte	r/w
palette	IColorPalette	r/w
premultiply_components	bool	r/w
raw_custom_color_converter	IColorConverter	r/w
raw_data_format	PixelDataFormat	r
raw_data_settings	RawDataSettings	r	Gets the current raw data settings. Note when using these settings the data loads without conversion.
raw_fallback_index	int	r/w
raw_indexed_color_converter	IIndexedColorConverter	r/w
raw_line_size	int	r
resources	LayerResource[]	r/w
right	int	r/w
sheet_color_highlight	SheetColorHighlightEnum	r/w
size	Size	r	Gets the object size.
top	int	r/w
transparent_color	Color	r/w
update_xmp_data	bool	r/w
use_palette	bool	r
use_raw_data	bool	r/w
vertical_resolution	double	r/w
width	int	r	Gets width of the layers group.
xmp_data	XmpPacketWrapper	r/w

Methods

Name	Description
add_layer(layer)	Adds the layer to the layer group.
add_layer_group(group_name, index)	Adds the layer group.
add_layer_mask(layer_mask)
adjust_brightness(brightness)
adjust_contrast(contrast)
adjust_gamma(gamma)
adjust_gamma(gamma_red, gamma_green, gamma_blue)
binarize_bradley(brightness_difference)
binarize_bradley(brightness_difference, window_size)
binarize_fixed(threshold)
binarize_otsu()
cache_data()
can_load(file_path)
can_load(file_path, load_options)
can_load(stream)
can_load(stream, load_options)
can_save(options)
create(image_options, width, height)
crop(left_shift, right_shift, top_shift, bottom_shift)
crop(rectangle)
dither(dithering_method, bits_count)
dither(dithering_method, bits_count, custom_palette)
draw_image(location, image)
filter(rectangle, options)
get_argb_32_pixel(x, y)
get_default_argb_32_pixels(rectangle)
get_default_options(args)
get_default_pixels(rectangle, partial_pixel_loader)
get_default_raw_data(rectangle, partial_raw_data_loader, raw_data_settings)
get_default_raw_data(rectangle, raw_data_settings)
get_file_format(file_path)
get_file_format(stream)
get_fitting_rectangle(rectangle, pixels, width, height)
get_fitting_rectangle(rectangle, width, height)
get_modify_date(use_default)
get_original_options()
get_pixel(x, y)
get_proportional_height(width, height, new_width)
get_proportional_width(width, height, new_height)
get_skew_angle()
grayscale()
load(file_path)
load(file_path, load_options)
load(stream)
load(stream, load_options)
load_argb_32_pixels(rectangle)
load_argb_64_pixels(rectangle)
load_cmyk_32_pixels(rectangle)
load_cmyk_pixels(rectangle)
load_partial_argb_32_pixels(rectangle, partial_pixel_loader)	Loads 32-bit ARGB pixels partially (by blocks).
load_partial_pixels(desired_rectangle, pixel_loader)
load_pixels(rectangle)
load_raw_data(rectangle, dest_image_bounds, raw_data_settings, raw_data_loader)
load_raw_data(rectangle, raw_data_settings, raw_data_loader)	Loads raw data.
merge_layer_to(layer_to_merge_into)
normalize_angle()
normalize_angle(resize_proportionally, background_color)
read_argb_32_scan_line(scan_line_index)
read_scan_line(scan_line_index)
replace_color(old_color, old_color_diff, new_color)
replace_color(old_color_argb, old_color_diff, new_color_argb)
replace_non_transparent_colors(new_color)
replace_non_transparent_colors(new_color_argb)
resize(new_width, new_height)
resize(new_width, new_height, resize_type)
resize(new_width, new_height, settings)
resize_height_proportionally(new_height)
resize_height_proportionally(new_height, resize_type)
resize_height_proportionally(new_height, settings)
resize_width_proportionally(new_width)
resize_width_proportionally(new_width, resize_type)
resize_width_proportionally(new_width, settings)
rotate(angle)
rotate(angle, resize_proportionally, background_color)
rotate_flip(rotate_flip_type)
save()
save(file_path)
save(file_path, options)
save(file_path, options, bounds_rectangle)
save(file_path, over_write)
save(stream)
save(stream, options_base)
save(stream, options_base, bounds_rectangle)
save_argb_32_pixels(rectangle, pixels)
save_cmyk_32_pixels(rectangle, pixels)
save_cmyk_pixels(rectangle, pixels)
save_pixels(rectangle, pixels)
save_raw_data(data, data_offset, rectangle, raw_data_settings)
set_argb_32_pixel(x, y, argb_32_color)
set_palette(palette, update_colors)
set_pixel(x, y, color)
set_resolution(dpi_x, dpi_y)
shallow_copy()
to_bitmap()
write_argb_32_scan_line(scan_line_index, argb_32_pixels)
write_scan_line(scan_line_index, pixels)

Method: add_layer(layer)

 add_layer(layer) 

Adds the layer to the layer group.

Parameters:

Parameter	Type	Description
layer	Layer	The layer.

Method: add_layer_group(group_name, index)

 add_layer_group(group_name, index) 

Adds the layer group.

Parameters:

Parameter	Type	Description
group_name	string	Name of the group.
index	int	The index of the layer to insert after.

Returns

Type	Description
LayerGroup	Opening group layer

Method: can_load(file_path) [static]

 can_load(file_path) 

Parameters:

Parameter	Type	Description
file_path	string

Returns

Type	Description
bool

Method: can_load(file_path, load_options) [static]

 can_load(file_path, load_options) 

Parameters:

Parameter	Type	Description
file_path	string
load_options	LoadOptions

Returns

Type	Description
bool

Method: can_load(stream) [static]

 can_load(stream) 

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom

Returns

Type	Description
bool

Method: can_load(stream, load_options) [static]

 can_load(stream, load_options) 

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom
load_options	LoadOptions

Returns

Type	Description
bool

Method: can_save(options)

 can_save(options) 

Parameters:

Parameter	Type	Description
options	ImageOptionsBase

Returns

Type	Description
bool

Method: create(image_options, width, height) [static]

 create(image_options, width, height) 

Parameters:

Parameter	Type	Description
image_options	ImageOptionsBase
width	int
height	int

Returns

Type	Description
Image

Method: get_argb_32_pixel(x, y)

 get_argb_32_pixel(x, y) 

Parameters:

Parameter	Type	Description
x	int
y	int

Returns

Type	Description
int

Method: get_default_argb_32_pixels(rectangle)

 get_default_argb_32_pixels(rectangle) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle

Returns

Type	Description
int

Method: get_default_options(args)

 get_default_options(args) 

Parameters:

Parameter	Type	Description
args	object

Returns

Type	Description
ImageOptionsBase

Method: get_default_raw_data(rectangle, raw_data_settings)

 get_default_raw_data(rectangle, raw_data_settings) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle
raw_data_settings	RawDataSettings

Returns

Type	Description
byte

Method: get_file_format(file_path) [static]

 get_file_format(file_path) 

Parameters:

Parameter	Type	Description
file_path	string

Returns

Type	Description
FileFormat

Method: get_file_format(stream) [static]

 get_file_format(stream) 

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom

Returns

Type	Description
FileFormat

Method: get_fitting_rectangle(rectangle, pixels, width, height) [static]

 get_fitting_rectangle(rectangle, pixels, width, height) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle
pixels	int
width	int
height	int

Returns

Type	Description
Rectangle

Method: get_fitting_rectangle(rectangle, width, height) [static]

 get_fitting_rectangle(rectangle, width, height) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle
width	int
height	int

Returns

Type	Description
Rectangle

Method: get_modify_date(use_default)

 get_modify_date(use_default) 

Parameters:

Parameter	Type	Description
use_default	bool

Returns

Type	Description
datetime

Method: get_original_options()

 get_original_options() 

Returns

Type	Description
ImageOptionsBase

Method: get_pixel(x, y)

 get_pixel(x, y) 

Parameters:

Parameter	Type	Description
x	int
y	int

Returns

Type	Description
Color

Method: get_proportional_height(width, height, new_width) [static]

 get_proportional_height(width, height, new_width) 

Parameters:

Parameter	Type	Description
width	int
height	int
new_width	int

Returns

Type	Description
int

Method: get_proportional_width(width, height, new_height) [static]

 get_proportional_width(width, height, new_height) 

Parameters:

Parameter	Type	Description
width	int
height	int
new_height	int

Returns

Type	Description
int

Method: get_skew_angle()

 get_skew_angle() 

Returns

Type	Description
float

Method: load(file_path) [static]

 load(file_path) 

Parameters:

Parameter	Type	Description
file_path	string

Returns

Type	Description
Image

Method: load(file_path, load_options) [static]

 load(file_path, load_options) 

Parameters:

Parameter	Type	Description
file_path	string
load_options	LoadOptions

Returns

Type	Description
Image

Method: load(stream) [static]

 load(stream) 

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom

Returns

Type	Description
Image

Method: load(stream, load_options) [static]

 load(stream, load_options) 

Parameters:

Parameter	Type	Description
stream	_io.BufferedRandom
load_options	LoadOptions

Returns

Type	Description
Image

Method: load_argb_32_pixels(rectangle)

 load_argb_32_pixels(rectangle) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle

Returns

Type	Description
int

Method: load_argb_64_pixels(rectangle)

 load_argb_64_pixels(rectangle) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle

Returns

Type	Description
long

Method: load_cmyk_32_pixels(rectangle)

 load_cmyk_32_pixels(rectangle) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle

Returns

Type	Description
int

Method: load_cmyk_pixels(rectangle)

 load_cmyk_pixels(rectangle) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle

Returns

Type	Description
CmykColor[]

Method: load_partial_argb_32_pixels(rectangle, partial_pixel_loader)

 load_partial_argb_32_pixels(rectangle, partial_pixel_loader) 

Loads 32-bit ARGB pixels partially (by blocks).

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load pixels from.
partial_pixel_loader	IPartialArgb32PixelLoader	The partial pixel loader.

Method: load_pixels(rectangle)

 load_pixels(rectangle) 

Parameters:

Parameter	Type	Description
rectangle	Rectangle

Returns

Type	Description
Color[]

Method: load_raw_data(rectangle, raw_data_settings, raw_data_loader)

 load_raw_data(rectangle, raw_data_settings, raw_data_loader) 

Loads raw data.

Parameters:

Parameter	Type	Description
rectangle	Rectangle	The rectangle to load raw data from.
raw_data_settings	RawDataSettings	The raw data settings to use for loaded data. Note if data is not in the format specified then data conversion will be performed.
raw_data_loader	IPartialRawDataLoader	The raw data loader.

Method: read_argb_32_scan_line(scan_line_index)

 read_argb_32_scan_line(scan_line_index) 

Parameters:

Parameter	Type	Description
scan_line_index	int

Returns

Type	Description
int

Method: read_scan_line(scan_line_index)

 read_scan_line(scan_line_index) 

Parameters:

Parameter	Type	Description
scan_line_index	int

Returns

Type	Description
Color[]

Method: shallow_copy()

 shallow_copy() 

Returns

Type	Description
Layer

Method: to_bitmap()

 to_bitmap() 

Returns

Type	Description
aspose.pydrawing.Bitmap