Method to_stroke

pdf2docx/shape/Shape.py:273–292

Convert to Stroke instance based on width criterion. Args: max_border_width (float): Stroke width must less than this value. Returns: Stroke: Stroke instance. .. note:: A Fill from shape point of view may be a Stroke from content

(self, max_border_width:float)

    '''

    def to_stroke(self, max_border_width:float):
        '''Convert to Stroke instance based on width criterion.

        Args:
            max_border_width (float): Stroke width must less than this value.

        Returns:
            Stroke: Stroke instance.
        
        .. note::
            A Fill from shape point of view may be a Stroke from content point of view.
            The criterion here is whether the width is smaller than defined ``max_border_width``.
        '''
        w = min(self.bbox.width, self.bbox.height)

        # not a stroke if exceed max border width
        if w > max_border_width:
            return None
        else:
            return Stroke({'width': w, 'color': self.color}).update_bbox(self.bbox)
    

    @property