Type alias TAddFloatingLabelOptions

TAddFloatingLabelOptions: {
    appearance?: TFloatingLabelAppearance;
    groupRankingByCategory?: boolean;
    interactive?: boolean;
    layer?: string;
    rank?: COLLISION_RANKING_TIERS | number;
    scale?: number;
}

Options for creating a new FloatingLabel with FloatingLabels.add.

Type declaration

  • Optional appearance?: TFloatingLabelAppearance

    Customize the appearance of the FloatingLabel and its pin

  • Optional groupRankingByCategory?: boolean

    Group analytics based ranking by MappedinCategory.sortOrder value

    Default

    false
  • Optional interactive?: boolean

    Whether the FloatingLabel should be clickable and included in E_SDK_EVENT.CLICK events.

    Default

    false
  • Optional layer?: string

    Optional layer to attach the FloatingLabel to. If not provided, this will be empty or the layer of the MappedinPolygon that the label is attached to.

  • Optional rank?: COLLISION_RANKING_TIERS | number

    The rank of the FloatingLabel used when comparing colliders to determine which should be shown.

  • Optional scale?: number

Settings

Member Visibility

Theme