API (v2.0.0) - Giro3D
    Preparing search index...

    Interface ShapeOptions

    Constructor options for the Shape entity.

    interface ShapeOptions {
        afterInsertPoint?: PostHook<InsertPointHook>;
        afterRemovePoint?: PostHook<RemovePointHook>;
        afterUpdatePoint?: PostHook<UpdatePointHook>;
        beforeInsertPoint?: PreHook<InsertPointHook>;
        beforeRemovePoint?: PreHook<RemovePointHook>;
        beforeUpdatePoint?: PreHook<UpdatePointHook>;
        borderWidth?: number;
        color?: ColorRepresentation;
        floorElevation?: number;
        fontSize?: number;
        fontWeight?: ShapeFontWeight;
        labelOpacity?: number;
        lineLabelFormatter?: LineLabelFormatter;
        lineWidth?: number;
        name?: string;
        object3d?: Object3D<Object3DEventMap>;
        pickableLabels?: boolean;
        segmentLabelFormatter?: SegmentLabelFormatter;
        showFloorLine?: boolean;
        showFloorVertices?: boolean;
        showLine?: boolean;
        showLineLabel?: boolean;
        showSegmentLabels?: boolean;
        showSurface?: boolean;
        showSurfaceLabel?: boolean;
        showVertexLabels?: boolean;
        showVerticalLineLabels?: boolean;
        showVerticalLines?: boolean;
        showVertices?: boolean;
        surfaceLabelFormatter?: SurfaceLabelFormatter;
        surfaceLabelPlacement?: SurfaceLabelPlacement;
        surfaceOpacity?: number;
        vertexLabelFormatter?: VertexLabelFormatter;
        vertexRadius?: number;
        verticalLineLabelFormatter?: VerticalLineLabelFormatter;
    }

    Hierarchy (View Summary)

    Index

    Properties

    afterInsertPoint? afterRemovePoint? afterUpdatePoint? beforeInsertPoint? beforeRemovePoint? beforeUpdatePoint? borderWidth? color? floorElevation? fontSize? fontWeight? labelOpacity? lineLabelFormatter? lineWidth? name? object3d? pickableLabels? segmentLabelFormatter? showFloorLine? showFloorVertices? showLine? showLineLabel? showSegmentLabels? showSurface? showSurfaceLabel? showVertexLabels? showVerticalLineLabels? showVerticalLines? showVertices? surfaceLabelFormatter? surfaceLabelPlacement? surfaceOpacity? vertexLabelFormatter? vertexRadius? verticalLineLabelFormatter?

    Properties

    afterInsertPoint?: PostHook<InsertPointHook>

    An optional hook to be called just after a point is inserted.

    afterRemovePoint?: PostHook<RemovePointHook>

    An optional hook to be called just after a point is removed.

    afterUpdatePoint?: PostHook<UpdatePointHook>

    An optional hook to be called just after a point is updated.

    beforeInsertPoint?: PreHook<InsertPointHook>

    An optional hook to be called just before a point is inserted. If the hook returns false, the point is not inserted.

    beforeRemovePoint?: PreHook<RemovePointHook>

    An optional hook to be called just before a point is removed. If the hook returns false, the point is not removed.

    beforeUpdatePoint?: PreHook<UpdatePointHook>

    An optional hook to be called just before a point is updated. If the hook returns false, the point is not updated.

    borderWidth?: number

    The width, in pixels, of the border around vertices and lines.

    DEFAULT_BORDER_WIDTH

    color?: ColorRepresentation

    The main color of the shape. Affects lines, vertices, surfaces and labels.

    DEFAULT_COLOR

    floorElevation?: number

    The floor elevation, in meters.

    0
    fontSize?: number

    The label font size.

    DEFAULT_FONT_SIZE

    fontWeight?: ShapeFontWeight

    The label font weight.

    'bold'

    labelOpacity?: number

    The specific opacity of the labels.

    1
    lineLabelFormatter?: LineLabelFormatter

    A custom formatter for the line label.

    lineWidth?: number

    The width, in pixels, of lines.

    DEFAULT_LINE_WIDTH

    name?: string

    The optional display name of this entity. Mostly used for debugging.

    object3d?: Object3D<Object3DEventMap>

    The root object of this entity. If none is provided, a new Group is created.

    pickableLabels?: boolean

    Make labels pickable.

    false
    segmentLabelFormatter?: SegmentLabelFormatter

    A custom formatter for segment labels.

    showFloorLine?: boolean

    Shows the line that is the vertical projection of the line on the plane at the floorElevation.

    DEFAULT_SHOW_FLOOR_LINE

    showFloorVertices?: boolean

    Shows floor vertices.

    DEFAULT_SHOW_FLOOR_VERTICES

    showLine?: boolean

    Shows the line that connects each vertex.

    DEFAULT_SHOW_LINE

    showLineLabel?: boolean

    Display a label for the entire line.

    false
    showSegmentLabels?: boolean

    Display labels for each segment of the line.

    false
    showSurface?: boolean

    Show the surface polygon.

    DEFAULT_SHOW_SURFACE

    showSurfaceLabel?: boolean

    Display a label for the surface.

    false
    showVertexLabels?: boolean

    Display a label for each vertex.

    false
    showVerticalLineLabels?: boolean

    Display labels for vertical lines.

    false
    showVerticalLines?: boolean

    Show vertical lines that connect each vertex to each floor vertex.

    DEFAULT_SHOW_VERTICAL_LINES

    showVertices?: boolean

    Show vertices.

    DEFAULT_SHOW_VERTICES

    surfaceLabelFormatter?: SurfaceLabelFormatter

    A custom formatter for the surface label.

    surfaceLabelPlacement?: SurfaceLabelPlacement

    An optional function to compute the location of the surface label.

    surfaceOpacity?: number

    The opacity of the surface.

    DEFAULT_SURFACE_OPACITY

    vertexLabelFormatter?: VertexLabelFormatter

    A custom formatter for the vertex labels.

    vertexRadius?: number

    The radius, in pixels, of vertices.

    DEFAULT_VERTEX_RADIUS

    verticalLineLabelFormatter?: VerticalLineLabelFormatter

    A custom formatter for vertical line labels.

    Settings

    Member Visibility

    On This Page

    Properties