Interface TagConfig<C>

Type Parameters

Hierarchy

  • TagConfig

Properties

_isMerged? clickable? initialData? initialState? modelConfig? renderType? tag3DConfig? unfoldedConfig? visibleConfig?

Properties

Optional _isMerged

_isMerged?: boolean

Deprecated

private property

Optional clickable

clickable?: boolean

@description: 是否可以点击

Default

true

Optional initialData

initialData?: PartialObjectDeep<ContentTypeMap[C]> & {
    important?: boolean;
}

@description: 标签的默认数据，会将 tag.data 深度合并进来

Type declaration

  • Optional important?: boolean

    @description: 类似 css 的 !important，会覆盖掉 tag.data 中对应的数据

    Code

     if (initialData.important) {
        tag.data = ObjectAssignDeep(tag.data, initialData)
     } else {
        tag.data = ObjectAssignDeep(initialData, tag.data)
     }

Code

tag.data = ObjectAssignDeep(initialData, tag.data)

Optional initialState

initialState?: {
    unfolded?: boolean;
    visible?: boolean;
}

初始状态

Type declaration

  • Optional unfolded?: boolean

    展开/收起

  • Optional visible?: boolean

    显示/隐藏

Optional modelConfig

modelConfig?: {
    autoLookAtEnabled?: boolean;
}

Type declaration

  • Optional autoLookAtEnabled?: boolean

Optional renderType

renderType?: "Mesh" | "Dom"

@description: 当图片为一张时可以选择通过Mesh渲染

Default

'Dom'

Optional tag3DConfig

tag3DConfig?: Object

@description: 内部使用 css3DRenderer 渲染的标签可以使用此配置来设置 css3DRenderer 相关参数

Optional unfoldedConfig

unfoldedConfig?: ConfigFunction | {
    autoFoldWhenHide?: false;
    autoUnfold?: false | {
        autoUnfoldProjectX?: MinMax;
        enable?: boolean;
        strategy?: "ScreenPostion";
    } | {
        distance?: MinMax;
        enable?: boolean;
        maxNumber?: number;
        strategy?: "MinimumDistance";
    };
    disableFold?: true;
    disableUnfold?: true;
    keep?: "folded" | "unfolded";
    unfoldDistance?: MinMax;
}

@description: 展开/收起相关配置

Type declaration

  • Optional autoFoldWhenHide?: false

    Description

    划动到不可见状态时，自动收起，disableFold: true 的标签不受此参数影响

    Note

    部分标签是无法收起的

    Default

    true
  • Optional autoUnfold?: false | {
        autoUnfoldProjectX?: MinMax;
        enable?: boolean;
        strategy?: "ScreenPostion";
    } | {
        distance?: MinMax;
        enable?: boolean;
        maxNumber?: number;
        strategy?: "MinimumDistance";
    }

    自动展开策略, false 时不自动展开

  • Optional disableFold?: true

    Deprecated

    replace by { keep: 'unfolded' }

    Deprecated

    部分标签是无法收起的

    Default

    undefined
  • Optional disableUnfold?: true

    Deprecated

    replace by { keep: 'folded' }

    Deprecated

    部分标签是无法打开的

    Default

    undefined
  • Optional keep?: "folded" | "unfolded"

    @description: 保持展开/收起，设置后unfoldedConfig下所有其他配置都不生效

    Default

    null
  • Optional unfoldDistance?: MinMax

    min-max米内自动展开,否则收起

Optional visibleConfig

visibleConfig?: {
    alwaysShowWhenMovePano?: boolean;
    angleRange?: MinMax;
    followModelVisibility?: boolean;
    intersectRaycaster?: boolean | {
        checkPoints?: Vector3[] | "center" | "corner";
        distanceAccuracy?: number;
        enabled?: boolean;
        needPassed?: number;
    };
    keep?: "visible" | "hidden";
    visibleDistance?: MinMax | "unLimited";
    visibleFiveMode?: TagVisibleMode | ((tag) => TagVisibleMode);
    visiblePanoIndex?: number[] | "all" | "current";
} | ConfigFunction

@description: 显示/隐藏相关配置

Type declaration

  • Optional alwaysShowWhenMovePano?: boolean

    Description

    走点时不隐藏

    Fivemode

    只在全景模式下生效

    Default

    false
  • Optional angleRange?: MinMax

    Description

    3D标签中 「标签所在平面或垂直于标签法线的平面」 与 「摄像机到标签点或中心点的向量」 的夹角，范围内自动展开，范围外自动收起

    Fivemode

    只在全景模式下生效

    Default

    undefined
  • Optional followModelVisibility?: boolean

    Description

    当 visibleFiveMode 包含 'Floorplan' 或者 'MapView' 时，是否仅在当前楼层模型下可见

    Default

    false
  • Optional intersectRaycaster?: boolean | {
        checkPoints?: Vector3[] | "center" | "corner";
        distanceAccuracy?: number;
        enabled?: boolean;
        needPassed?: number;
    }

    Description

    碰撞检测配置

    Default

    true
  • Optional keep?: "visible" | "hidden"

    Description

    在 visibleFiveMode 指定的 mode 中，保持可见/不可见。设置后 visibleConfig 中除了 visibleFiveMode 外的所有其他配置都不生效

    Default

    null

    Example

    // 在 Panorama 和 Floorplan 模式下永远保持可见
    const config = {
     keep: 'visible',
     visibleFiveMode: ['Panorama', 'Floorplan'],
    }
    // 在 tag.fiveState.mode 中时，永远保持可见
    const config = {
     keep: 'visible',
    }
  • Optional visibleDistance?: MinMax | "unLimited"

    Description

    配置可见距离

    Fivemode

    只在全景模式下生效

    Default

    'unLimited'
  • Optional visibleFiveMode?: TagVisibleMode | ((tag) => TagVisibleMode)

    Description

    在哪些 five mode 下可见

    Tips

    默认值的设定是在 config 合并后，而不是合并前

    Default

     visibleFiveMode = tag.fiveState?.mode ?? 'Panorama'

    Example

    const tag = {
     ...
     fiveState: {
       mode: 'Floorplan',
     }
     ...
     config: {},
    }
    // 相当于
    const tag = {
     ...
     fiveState: {
       mode: 'Floorplan',
     }
     ...
     config: {
       visibleFiveMode: 'Floorplan',
     },
    }
  • Optional visiblePanoIndex?: number[] | "all" | "current"

    Description

    配置标签可见点位

    Fivemode

    只在全景模式下生效

    Param

    不限制

    Param

    仅当前点位可见

    Param

    仅指定点位可见

    Default

    'all'

Settings

Member Visibility

Theme

On This Page