FilledAreaUtil

implementation of FilledAreaUtil

• create default hatching, pattern, filling, face style, bitmap
• add hatching, pattern, filling, face style properties to the corresponding dictionary
• get hatching, pattern, filling, face style properties from the corresponding dictionary

FilledAreaUtil

Canonical path: Utils.General.FilledAreaUtil.FilledAreaUtil

implementation of FilledAreaUtil

__init__

__init__()

initialization

add_face_style

add_face_style(face_style_id: str, face_style_prop: FaceStyleProperties)

add a face style

Parameters:

• face_style_id (str) –

  face style ID

• face_style_prop (FaceStyleProperties) –

  face style properties

add_filling

add_filling(filling_id: str, filling_prop: FillingProperties)

add a filling

Parameters:

• filling_id (str) –

  filling ID

• filling_prop (FillingProperties) –

  filling properties

add_hatching

add_hatching(hatching_id: str, hatching_prop: HatchingProperties)

add a hatching

Parameters:

• hatching_id (str) –

  hatching ID

• hatching_prop (HatchingProperties) –

  hatching properties

add_no_transition_filling

add_no_transition_filling(filling_id: str, color: ARGB | int, alpha: int = 0)

create a no transition filling and add it to the filling dictionary

Parameters:

• filling_id (str) –

  filling ID

• color (ARGB | int) –

  color object or color ID

• alpha (int, default: 0 ) –

  alpha

add_pattern

add_pattern(pattern_id: str, pattern_prop: PatternProperties)

add a pattern

Parameters:

• pattern_id (str) –

  pattern ID

• pattern_prop (PatternProperties) –

  pattern properties

create_default_bitmap staticmethod

create_default_bitmap(bitmap_name: str) -> BitmapAreaProperties

create a default bitmap

Parameters:

• bitmap_name (str) –

  name of the bitmap file

Returns:

• BitmapAreaProperties –

  bitmap properties with default values

create_default_face_style staticmethod

create_default_face_style(face_style_id: int) -> FaceStyleProperties

create a default face style

Parameters:

• face_style_id (int) –

  face style ID

Returns:

• FaceStyleProperties –

  face style properties with default values

create_default_hatching staticmethod

create_default_hatching(
    hatching_id: int, bg_color: ARGB | int | None = None
) -> HatchingProperties

create a default hatching

Parameters:

• hatching_id (int) –

  hatching ID

• bg_color (ARGB | int | None, default: None ) –

  background color object or color ID

Returns:

• HatchingProperties –

  hatching properties with default values

create_default_pattern staticmethod

create_default_pattern(
    pattern_id: int, bg_color: ARGB | int | None = None
) -> PatternProperties

create a default pattern

Parameters:

• pattern_id (int) –

  pattern ID

• bg_color (ARGB | int | None, default: None ) –

  background color object or color ID

Returns:

• PatternProperties –

  pattern properties with default values

create_no_transition_filling staticmethod

create_no_transition_filling(
    color: ARGB | int, alpha: int = 0
) -> FillingProperties

create a no transition filling

Parameters:

• color (ARGB | int) –

  color object or color ID

• alpha (int, default: 0 ) –

  alpha

Returns:

• FillingProperties –

  filling properties with no transition

get_face_style

get_face_style(face_style_id: str) -> FaceStyleProperties | None

get a face style

Parameters:

• face_style_id (str) –

  face style ID

Returns:

• FaceStyleProperties | None –

  face style properties or None

get_filling

get_filling(filling_id: str) -> FillingProperties | None

get a filling

Parameters:

• filling_id (str) –

  filling ID

Returns:

• FillingProperties | None –

  filling properties or None

get_hatching

get_hatching(hatching_id: str) -> HatchingProperties | None

get a hatching

Parameters:

• hatching_id (str) –

  hatching ID

Returns:

• HatchingProperties | None –

  hatching properties or None

get_pattern

get_pattern(pattern_id: str) -> PatternProperties | None

get a pattern

Parameters:

• pattern_id (str) –

  pattern ID

Returns:

• PatternProperties | None –

  pattern properties or None

Placeholder