跳到主要内容
版本:0.2.1

Scale

类型源码

Scale(
scale: float,
offset_x: float,
offset_y: float,
timestamp: int,
)

ScaleTypedDict

图片的初始比例尺。该值只能由用户设置。鼠标滚轮对比例尺的影响不会反映到该值。须知,要令该值起效,需要每次更新该值时、提供一个不同于上一次使用的值。

若该值设置为一个标量,则该值会被用在属性scale上。

属性offset_xoffset_y的默认值是0.5

时间戳是可选属性。它主要用来让组件确认当前给定的Scale是最新的版本。

注意

强烈建议透过dpa.utilities.sanitize_scale() 来设置该值,亦即是设置init_scale属性。

别名

该类型可以按以下方式之一获取

import dash_picture_annotation as dpa


dpa.Scale
dpa.typehints.Scale

关键字

关键字类型必选
说明
scalefloat相对于标记图片的初始比例尺的相对尺寸。若未设置,则使用1.0
offset_xfloat相对 X 轴偏移。若未设置,则使用0.5(沿宽度正中)。
offset_yfloat相对 Y 轴偏移。若未设置,则使用0.5(沿高度正中)。
timestampint可选的时间戳值。该值不会实际使用到。若设置该值,该值可令组件确认比例尺需要更新。