@ezuikit/control-time-line - v1.0.0
    Preparing search index...

    Interface TimeLineOptions

    时间轴配置项

    interface TimeLineOptions {
        className?: string;
        coverQuery?: string;
        current?: Date;
        currentTimeBgColor?: string;
        currentTimeColor?: string;
        dpr?: number;
        height?: string | number;
        language?: "zh" | "en";
        locales?: I18nTranslation;
        onChange?: (time: string | Date) => void;
        onDestroy?: () => void;
        onDragEnd?: (time: string | Date, isOver?: boolean) => void;
        onDragging?: (time: string | Date) => void;
        onDragStart?: (time: string | Date) => void;
        readOnly?: boolean;
        scaleOffsetTop?: number;
        showYearMonthDay?: boolean;
        timeAxisBgColor?: string | CanvasGradient | CanvasPattern;
        timePointColor?: string | CanvasGradient | CanvasPattern;
        timeScaleColor?: string | CanvasGradient | CanvasPattern;
        timeSectionColor?: string | CanvasGradient | CanvasPattern;
        timeSections?: TimeLineTimeSection[];
        timeTextColor?: string | CanvasGradient | CanvasPattern;
        timeWidth?: number;
        width?: string | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    className? coverQuery? current? currentTimeBgColor? currentTimeColor? dpr? height? language? locales? onChange? onDestroy? onDragEnd? onDragging? onDragStart? readOnly? scaleOffsetTop? showYearMonthDay? timeAxisBgColor? timePointColor? timeScaleColor? timeSectionColor? timeSections? timeTextColor? timeWidth? width?

    Properties

    className?: string

    容器类名

    coverQuery?: string

    封面图片的额外参数， 默认空字符串

    current?: Date

    默认当天 00:00:00

    currentTimeBgColor?: string

    当前时间背景颜色

    currentTimeColor?: string

    当前时间颜色

    dpr?: number

    屏幕分辨率，默认 window.devicePixelRatio, 需要大于等于1

    height?: string | number

    画布高度

    language?: "zh" | "en"

    语言, 默认 zh

    locales?: I18nTranslation

    多语言

    onChange?: (time: string | Date) => void

    拖动最终结束回调（PC 端移出轴外不触发）

    Type declaration

      • (time: string | Date): void

      • Parameters

        • time: string | Date

          时间（移动端是 HH:mm:ss）

        Returns void

    onDestroy?: () => void

    销毁

    onDragEnd?: (time: string | Date, isOver?: boolean) => void

    拖动结束回调

    Type declaration

      • (time: string | Date, isOver?: boolean): void

      • Parameters

        • time: string | Date

          时间 （移动端是 HH:mm:ss）

        • OptionalisOver: boolean

          鼠标是否在轴上（PC 有效）

        Returns void

    onDragging?: (time: string | Date) => void

    拖动中回调

    Type declaration

      • (time: string | Date): void

      • Parameters

        • time: string | Date

          时间 （移动端是 HH:mm:ss）

        Returns void

    onDragStart?: (time: string | Date) => void

    拖动开始回调

    Type declaration

      • (time: string | Date): void

      • Parameters

        • time: string | Date

          时间 （移动端是 HH:mm:ss）

        Returns void

    readOnly?: boolean

    只读（不能拖动）， 默认 false

    scaleOffsetTop?: number

    刻度顶部偏移量, 默认 4px

    showYearMonthDay?: boolean

    是否显示年、月、日, 默认 true

    timeAxisBgColor?: string | CanvasGradient | CanvasPattern

    时间轴背景颜色， 默认 黑色 #000， 移动端不支持 CanvasGradient | CanvasPattern

    timePointColor?: string | CanvasGradient | CanvasPattern

    当前时间针颜色（中间）， 默认 蓝色 #1890ff, 移动端不支持 CanvasGradient | CanvasPattern

    timeScaleColor?: string | CanvasGradient | CanvasPattern

    刻度颜色， 默认 #fff， 移动端不支持 CanvasGradient | CanvasPattern

    timeSectionColor?: string | CanvasGradient | CanvasPattern

    时间片段背景颜色， 默认 蓝色 #1890ff80， 移动端不支持 CanvasGradient | CanvasPattern

    timeSections?: TimeLineTimeSection[]

    时间片段列表， 默认 []

    timeTextColor?: string | CanvasGradient | CanvasPattern

    时间文本颜色， 默认 #fff， 移动端不支持 CanvasGradient | CanvasPattern

    timeWidth?: number

    时间轴刻度， 默认 0， [0, 4]

    width?: string | number

    画布宽度

    Settings

    Member Visibility

    On This Page

    Properties