Index

A

add_hole() (kipy.geometry.PolygonWithHoles method) add_item() (kipy.board_types.Footprint method) add_to_selection() (kipy.board.Board method) AlignedDimension (class in kipy.board_types) alignment (kipy.board_types.OrthogonalDimension property) alpha (kipy.common_types.Color property) Angle (class in kipy.geometry) angle (kipy.board_types.PadStack property) (kipy.common_types.TextAttributes property) angle() (kipy.geometry.Vector2 method) ApiError append() (kipy.common_types.CompoundShape method) (kipy.geometry.PolyLine method) Arc (class in kipy.common_types) arc (kipy.geometry.PolyLineNode property) arc_center() (in module kipy.geometry)

arc_end_angle() (in module kipy.geometry) arc_radius() (in module kipy.geometry) arc_start_angle() (in module kipy.geometry) ArcStartMidEnd (class in kipy.geometry) ArcTrack (class in kipy.board_types) arrow_direction (kipy.board_types.Dimension property) arrow_length (kipy.board_types.Dimension property) as_text() (kipy.board_types.BoardText method) as_textbox() (kipy.board_types.BoardTextBox method) attributes (kipy.board_types.BoardShape property) (kipy.board_types.BoardText property) (kipy.board_types.BoardTextBox property) (kipy.board_types.FootprintInstance property) (kipy.common_types.GraphicShape property) (kipy.common_types.Text property) (kipy.common_types.TextBox property)

B

back_outer_layers (kipy.board_types.PadStack property) begin_commit() (kipy.board.Board method) Bezier (class in kipy.common_types) blue (kipy.common_types.Color property) Board (class in kipy.board) board_flip (kipy.board_types.BoardEditorAppearanceSettings property) BoardArc (class in kipy.board_types) BoardBezier (class in kipy.board_types) BoardCircle (class in kipy.board_types) BoardEditorAppearanceSettings (class in kipy.board_types) BoardItem (class in kipy.board_types) BoardLayerGraphicsDefaults (class in kipy.board) BoardPolygon (class in kipy.board_types) BoardRectangle (class in kipy.board_types) BoardSegment (class in kipy.board_types) BoardShape (class in kipy.board_types) BoardStackup (class in kipy.board) BoardStackupDielectricLayer (class in kipy.board) BoardStackupDielectricProperties (class in kipy.board) BoardStackupLayer (class in kipy.board)

BoardText (class in kipy.board_types) BoardTextBox (class in kipy.board_types) bold (kipy.common_types.TextAttributes property) border_hatch_pitch (kipy.board_types.Zone property) border_style (kipy.board_types.LeaderDimension property) (kipy.board_types.Zone property) bottom_right (kipy.board_types.BoardTextBox property) (kipy.common_types.Rectangle property) (kipy.common_types.TextBox property) bounding_box() (kipy.board_types.ArcTrack method) (kipy.board_types.Zone method) (kipy.common_types.Arc method) (kipy.common_types.Bezier method) (kipy.common_types.Circle method) (kipy.common_types.GraphicShape method) (kipy.common_types.Polygon method) (kipy.common_types.Rectangle method) (kipy.common_types.Segment method) (kipy.geometry.ArcStartMidEnd method) (kipy.geometry.PolygonWithHoles method) Box2 (class in kipy.geometry)

C

canonical_name() (in module kipy.util.board_layer) center (kipy.board_types.CenterDimension property) (kipy.board_types.RadialDimension property) (kipy.common_types.Circle property) center() (kipy.board_types.ArcTrack method) (kipy.common_types.Arc method) (kipy.geometry.ArcStartMidEnd method) CenterDimension (class in kipy.board_types) chamfer_ratio (kipy.board_types.PadStackLayer property) chamfered_corners (kipy.board_types.PadStackLayer property) check_version() (kipy.KiCad method) Circle (class in kipy.common_types) clear() (kipy.geometry.PolyLine method) clear_selection() (kipy.board.Board method) clearance (kipy.board_types.Zone property) client (kipy.board.Board property) closed (kipy.geometry.PolyLine property) code (kipy.board_types.Net property) (kipy.errors.ApiError property)

Color (class in kipy.common_types) color (kipy.board.BoardStackupLayer property) (kipy.common_types.GraphicFillAttributes property) (kipy.common_types.StrokeAttributes property) comments (kipy.common_types.TitleBlockInfo property) Commit (class in kipy.common_types) company (kipy.common_types.TitleBlockInfo property) CompoundShape (class in kipy.common_types) connection (kipy.board_types.Zone property) ConnectionError control1 (kipy.common_types.Bezier property) control2 (kipy.common_types.Bezier property) copper_layer() (kipy.board_types.PadStack method) copper_layers (kipy.board_types.PadStack property) corner_rounding_ratio (kipy.board_types.PadStackLayer property) create_items() (kipy.board.Board method) custom_anchor_shape (kipy.board_types.PadStackLayer property) custom_shapes (kipy.board_types.PadStackLayer property)

D

datasheet_field (kipy.board_types.FootprintInstance property) date (kipy.common_types.TitleBlockInfo property) definition (kipy.board_types.FootprintInstance property) degrees (kipy.geometry.Angle property) description_field (kipy.board_types.FootprintInstance property) diameter (kipy.board_types.DrillProperties property) dielectric (kipy.board.BoardStackupLayer property)

Dimension (class in kipy.board_types) document (kipy.board.Board property) (kipy.project.Project property) DocumentSpecifier (class in kipy.proto.common.types) drill (kipy.board_types.PadStack property) DrillProperties (class in kipy.board_types) drop_commit() (kipy.board.Board method)

E

enabled (kipy.board.BoardStackupLayer property) end (kipy.board_types.AlignedDimension property) (kipy.board_types.ArcTrack property) (kipy.board_types.CenterDimension property) (kipy.board_types.LeaderDimension property) (kipy.board_types.OrthogonalDimension property) (kipy.board_types.Track property) (kipy.common_types.Arc property) (kipy.common_types.Bezier property) (kipy.common_types.Segment property) (kipy.geometry.ArcStartMidEnd property)

end_angle() (kipy.board_types.ArcTrack method) (kipy.common_types.Arc method) (kipy.geometry.ArcStartMidEnd method) end_layer (kipy.board_types.DrillProperties property) epsilon_r (kipy.board.BoardStackupDielectricProperties property) exclude_from_bill_of_materials (kipy.board_types.FootprintAttributes property) exclude_from_position_files (kipy.board_types.FootprintAttributes property) expand_text_variables() (kipy.board.Board method) (kipy.project.Project method) extension_height (kipy.board_types.AlignedDimension property) (kipy.board_types.OrthogonalDimension property) extension_offset (kipy.board_types.Dimension property)

F

Field (class in kipy.board_types) field_id (kipy.board_types.Field property) filename (kipy.board_types.Footprint3DModel property) fill (kipy.common_types.GraphicAttributes property) fill_mode (kipy.board_types.Zone property) filled (kipy.board_types.Zone property) (kipy.common_types.GraphicFillAttributes property) filled_polygons (kipy.board_types.Zone property) font_name (kipy.common_types.TextAttributes property) Footprint (class in kipy.board_types) Footprint3DModel (class in kipy.board_types) FootprintAttributes (class in kipy.board_types)

FootprintInstance (class in kipy.board_types) from_client() (kipy.KiCad static method) from_degrees() (kipy.geometry.Angle class method) from_mm() (in module kipy.util.units) from_point() (kipy.geometry.PolyLineNode static method) from_pos_size() (kipy.geometry.Box2 class method) from_proto() (kipy.geometry.Box2 class method) from_xy() (kipy.geometry.PolyLineNode static method) (kipy.geometry.Vector2 class method) from_xywh() (kipy.geometry.Box2 class method) from_xyz() (kipy.geometry.Vector3D class method) front_outer_layers (kipy.board_types.PadStack property) FutureVersionError

G

get_active_layer() (kipy.board.Board method) get_api_version() (kipy.KiCad method) get_as_string() (kipy.board.Board method) get_board() (kipy.KiCad method) get_dimensions() (kipy.board.Board method) get_editor_appearance_settings() (kipy.board.Board method) get_footprints() (kipy.board.Board method) get_graphics_defaults() (kipy.board.Board method) get_item_bounding_box() (kipy.board.Board method) get_items() (kipy.board.Board method) get_kicad_binary_path() (kipy.KiCad method) get_net_classes() (kipy.project.Project method) get_netclass_for_nets() (kipy.board.Board method) get_nets() (kipy.board.Board method) get_open_documents() (kipy.KiCad method) get_pad_shapes_as_polygons() (kipy.board.Board method) get_pads() (kipy.board.Board method) get_plugin_settings_path() (kipy.KiCad method) get_project() (kipy.board.Board method) (kipy.KiCad method)

get_selection() (kipy.board.Board method) get_selection_as_string() (kipy.board.Board method) get_shapes() (kipy.board.Board method) get_stackup() (kipy.board.Board method) get_text() (kipy.board.Board method) get_text_as_shapes() (kipy.KiCad method) get_text_extents() (kipy.KiCad method) get_text_variables() (kipy.project.Project method) get_title_block_info() (kipy.board.Board method) get_tracks() (kipy.board.Board method) get_version() (kipy.KiCad method) get_vias() (kipy.board.Board method) get_visible_layers() (kipy.board.Board method) get_zones() (kipy.board.Board method) GraphicAttributes (class in kipy.common_types) GraphicFillAttributes (class in kipy.common_types) GraphicShape (class in kipy.common_types) green (kipy.common_types.Color property)

H

has_arc (kipy.geometry.PolyLineNode property) has_point (kipy.geometry.PolyLineNode property) height (kipy.board_types.AlignedDimension property) (kipy.board_types.OrthogonalDimension property)

hit_test() (kipy.board.Board method) holes (kipy.geometry.PolygonWithHoles property) horizontal_alignment (kipy.common_types.TextAttributes property)

I

id (kipy.board_types.BoardItem property) (kipy.board_types.BoardShape property) (kipy.board_types.BoardText property) (kipy.board_types.Dimension property) (kipy.board_types.Footprint property) (kipy.board_types.FootprintInstance property) (kipy.board_types.Pad property) (kipy.common_types.Commit property) inactive_layer_display (kipy.board_types.BoardEditorAppearanceSettings property)

inflate() (kipy.geometry.Box2 method) insert() (kipy.geometry.PolyLine method) interactive_move() (kipy.board.Board method) is_copper_layer() (in module kipy.util.board_layer) is_masked() (kipy.board_types.PadStack method) is_rule_area() (kipy.board_types.Zone method) island_mode (kipy.board_types.Zone property) italic (kipy.common_types.TextAttributes property) items (kipy.board_types.Footprint property)

K

keep_text_aligned (kipy.board_types.Dimension property) keep_upright (kipy.common_types.TextAttributes property) KiCad (class in kipy) kipy module kipy.board module kipy.board_types module kipy.common_types module

kipy.errors module kipy.geometry module kipy.project module kipy.util.board_layer module kipy.util.units module

L

layer (kipy.board.BoardLayerGraphicsDefaults property) (kipy.board.BoardStackupLayer property) (kipy.board_types.ArcTrack property) (kipy.board_types.BoardShape property) (kipy.board_types.BoardText property) (kipy.board_types.BoardTextBox property) (kipy.board_types.Dimension property) (kipy.board_types.Field property) (kipy.board_types.FootprintInstance property) (kipy.board_types.PadStackLayer property) (kipy.board_types.Track property) (kipy.board_types.ZoneFilledPolygons property) layer_from_canonical_name() (in module kipy.util.board_layer) layers (kipy.board.BoardStackup property) (kipy.board.BoardStackupDielectricLayer property) (kipy.board_types.PadStack property) (kipy.board_types.Zone property)

leader_length (kipy.board_types.RadialDimension property) LeaderDimension (class in kipy.board_types) length() (kipy.board_types.Track method) (kipy.geometry.Vector2 method) (kipy.geometry.Vector3D method) library (kipy.common_types.LibraryIdentifier property) LibraryIdentifier (class in kipy.common_types) line_spacing (kipy.common_types.TextAttributes property) line_thickness (kipy.board.BoardLayerGraphicsDefaults property) (kipy.board_types.Dimension property) locked (kipy.board_types.BoardShape property) (kipy.board_types.BoardText property) (kipy.board_types.BoardTextBox property) (kipy.board_types.Dimension property) (kipy.board_types.FootprintInstance property) (kipy.board_types.Via property) (kipy.board_types.Zone property) loss_tangent (kipy.board.BoardStackupDielectricProperties property)

M

material_name (kipy.board.BoardStackupDielectricProperties property) (kipy.board.BoardStackupLayer property) merge() (kipy.geometry.Box2 method) mid (kipy.board_types.ArcTrack property) (kipy.common_types.Arc property) (kipy.geometry.ArcStartMidEnd property) min_island_area (kipy.board_types.Zone property) min_thickness (kipy.board_types.Zone property) mirrored (kipy.common_types.TextAttributes property) module kipy kipy.board kipy.board_types kipy.common_types kipy.errors kipy.geometry kipy.project kipy.util.board_layer kipy.util.units

move() (kipy.geometry.Box2 method) (kipy.geometry.PolygonWithHoles method) multiline (kipy.common_types.TextAttributes property)

N

name (kipy.board.Board property) (kipy.board_types.Field property) (kipy.board_types.Net property) (kipy.board_types.Zone property) (kipy.common_types.LibraryIdentifier property) (kipy.project.Project property) Net (class in kipy.board_types) net (kipy.board_types.ArcTrack property) (kipy.board_types.BoardShape property) (kipy.board_types.Pad property) (kipy.board_types.Track property) (kipy.board_types.Via property) (kipy.board_types.Zone property)

net_color_display (kipy.board_types.BoardEditorAppearanceSettings property) nodes (kipy.geometry.PolyLine property) not_in_schematic (kipy.board_types.FootprintAttributes property) number (kipy.board_types.Pad property)

O

offset (kipy.board_types.Footprint3DModel property) (kipy.board_types.PadStackLayer property) opacity (kipy.board_types.Footprint3DModel property) orientation (kipy.board_types.FootprintInstance property)

OrthogonalDimension (class in kipy.board_types) outline (kipy.board_types.Zone property) (kipy.geometry.PolygonWithHoles property) override_text (kipy.board_types.Dimension property) override_text_enabled (kipy.board_types.Dimension property)

P

Pad (class in kipy.board_types) pad_type (kipy.board_types.Pad property) pads (kipy.board_types.Footprint property) PadStack (class in kipy.board_types) padstack (kipy.board_types.Pad property) (kipy.board_types.Via property) PadStackLayer (class in kipy.board_types) PadStackOuterLayer (class in kipy.board_types) path (kipy.project.Project property) ping() (kipy.KiCad method) point (kipy.geometry.PolyLineNode property) Polygon (class in kipy.common_types) polygons (kipy.common_types.Polygon property)

PolygonWithHoles (class in kipy.geometry) PolyLine (class in kipy.geometry) PolyLineNode (class in kipy.geometry) pos (kipy.geometry.Box2 property) position (kipy.board_types.BoardText property) (kipy.board_types.FootprintInstance property) (kipy.board_types.Pad property) (kipy.board_types.Via property) (kipy.common_types.Text property) precision (kipy.board_types.Dimension property) prefix (kipy.board_types.Dimension property) priority (kipy.board_types.Zone property) Project (class in kipy.project) push_commit() (kipy.board.Board method)

R

RadialDimension (class in kipy.board_types) radius() (kipy.board_types.ArcTrack method) (kipy.common_types.Arc method) (kipy.common_types.Circle method) (kipy.geometry.ArcStartMidEnd method) radius_point (kipy.board_types.RadialDimension property) (kipy.common_types.Circle property) ratsnest_display (kipy.board_types.BoardEditorAppearanceSettings property) raw_message (kipy.errors.ApiError property) Rectangle (class in kipy.common_types)

red (kipy.common_types.Color property) reference_field (kipy.board_types.FootprintInstance property) refill_zones() (kipy.board.Board method) remove() (kipy.geometry.PolyLine method) remove_from_selection() (kipy.board.Board method) remove_hole() (kipy.geometry.PolygonWithHoles method) remove_items() (kipy.board.Board method) revert() (kipy.board.Board method) revision (kipy.common_types.TitleBlockInfo property) rotation (kipy.board_types.Footprint3DModel property) run_action() (kipy.KiCad method)

S

save() (kipy.board.Board method) save_as() (kipy.board.Board method) scale (kipy.board_types.Footprint3DModel property) Segment (class in kipy.common_types) set_active_layer() (kipy.board.Board method) set_editor_appearance_settings() (kipy.board.Board method) set_text_variables() (kipy.project.Project method) set_visible_layers() (kipy.board.Board method) shape (kipy.board_types.DrillProperties property) (kipy.board_types.PadStackLayer property) shapes (kipy.board_types.Footprint property) (kipy.board_types.ZoneFilledPolygons property) (kipy.common_types.CompoundShape property) size (kipy.board_types.PadStackLayer property) (kipy.common_types.TextAttributes property) (kipy.common_types.TextBox property) (kipy.geometry.Box2 property) solder_mask_margin (kipy.board_types.SolderMaskOverrides property) solder_mask_mode (kipy.board_types.PadStackOuterLayer property) solder_mask_settings (kipy.board_types.PadStackOuterLayer property) solder_paste_margin (kipy.board_types.SolderPasteOverrides property) solder_paste_margin_ratio (kipy.board_types.SolderPasteOverrides property)

solder_paste_mode (kipy.board_types.PadStackOuterLayer property) solder_paste_settings (kipy.board_types.PadStackOuterLayer property) SolderMaskOverrides (class in kipy.board_types) SolderPasteOverrides (class in kipy.board_types) start (kipy.board_types.AlignedDimension property) (kipy.board_types.ArcTrack property) (kipy.board_types.LeaderDimension property) (kipy.board_types.OrthogonalDimension property) (kipy.board_types.Track property) (kipy.common_types.Arc property) (kipy.common_types.Bezier property) (kipy.common_types.Segment property) (kipy.geometry.ArcStartMidEnd property) start_angle() (kipy.board_types.ArcTrack method) (kipy.common_types.Arc method) (kipy.geometry.ArcStartMidEnd method) start_layer (kipy.board_types.DrillProperties property) stroke (kipy.common_types.GraphicAttributes property) stroke_width (kipy.common_types.TextAttributes property) StrokeAttributes (class in kipy.common_types) style (kipy.common_types.StrokeAttributes property) suffix (kipy.board_types.Dimension property) suppress_trailing_zeroes (kipy.board_types.Dimension property)

T

teardrop (kipy.board_types.Zone property) Text (class in kipy.common_types) text (kipy.board.BoardLayerGraphicsDefaults property) (kipy.board_types.Dimension property) (kipy.board_types.Field property) text_position (kipy.board_types.Dimension property) TextAttributes (class in kipy.common_types) TextBox (class in kipy.common_types) texts (kipy.board_types.Footprint property) texts_and_fields (kipy.board_types.FootprintInstance property) thermal_spokes (kipy.board_types.ZoneConnectionSettings property) thickness (kipy.board.BoardStackupDielectricProperties property) (kipy.board.BoardStackupLayer property) title (kipy.common_types.TitleBlockInfo property)

TitleBlockInfo (class in kipy.common_types) to_concrete_board_shape() (in module kipy.board_types) to_concrete_dimension() (in module kipy.board_types) to_concrete_shape() (in module kipy.common_types) to_mm() (in module kipy.util.units) to_radians() (kipy.geometry.Angle method) top_left (kipy.board_types.BoardTextBox property) (kipy.common_types.Rectangle property) (kipy.common_types.TextBox property) Track (class in kipy.board_types) trapezoid_delta (kipy.board_types.PadStackLayer property) type (kipy.board.BoardStackupLayer property) (kipy.board_types.PadStack property) (kipy.board_types.Via property) (kipy.board_types.Zone property)

U

unconnected_layer_removal (kipy.board_types.PadStack property) underlined (kipy.common_types.TextAttributes property) unit (kipy.board_types.Dimension property)

unit_format (kipy.board_types.Dimension property) unwrap() (in module kipy.board_types) update_items() (kipy.board.Board method) user_name (kipy.board.BoardStackupLayer property)

V

value (kipy.board_types.BoardText property) (kipy.board_types.BoardTextBox property) (kipy.common_types.Text property) (kipy.common_types.TextBox property) value_field (kipy.board_types.FootprintInstance property)

Vector2 (class in kipy.geometry) Vector3D (class in kipy.geometry) vertical_alignment (kipy.common_types.TextAttributes property) Via (class in kipy.board_types) visible (kipy.board_types.Footprint3DModel property) (kipy.common_types.TextAttributes property)

W

width (kipy.board_types.ArcTrack property) (kipy.board_types.Track property) (kipy.common_types.StrokeAttributes property)

X

x (kipy.geometry.Vector2 property) (kipy.geometry.Vector3D property)

Y

y (kipy.geometry.Vector2 property) (kipy.geometry.Vector3D property)

Z

z (kipy.geometry.Vector3D property) Zone (class in kipy.board_types) zone_connection (kipy.board_types.ZoneConnectionSettings property)

zone_settings (kipy.board_types.PadStack property) (kipy.board_types.PadStackLayer property) ZoneConnectionSettings (class in kipy.board_types) ZoneFilledPolygons (class in kipy.board_types)